You can search for identifiers within the package.
in-package search v0.2.0
vchan
Vchan.Location
type offset =
| First
| Second
Valid offsets within the shared page
val to_offset : offset -> int
to_offset x converts x to bytes
to_offset x
type t =
| Within_shared_page of offset
within the shared page
| External of int
in separately granted pages
Location of a data ring
val to_length : t -> int
to_length t gives the maximum number of available bytes at t
to_length t
t
val to_order : t -> int
to_order t gives the 'order' which is shared via the metadata page and used to uniquely identify the location
to_order t
val of_order : int -> (t, [> `Msg of string ]) result
of_order x parses the order
of_order x
val of_lengths : int -> int -> t * t
of_lengths read_size write_size chooses distinct t1,t2 to accommodate buffers of size read_size and write_size
of_lengths read_size write_size
t1,t2
read_size
write_size