package vchan

You can search for identifiers within the package.

in-package search v0.2.0

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module `Vchan.Location`Source

Sourcetype offset =

Valid offsets within the shared page

Sourceval sexp_of_offset : offset -> Sexplib0.Sexp.t

Sourceval offset_of_sexp : Sexplib0.Sexp.t -> offset

Sourceval to_offset : offset -> int

to_offset x converts x to bytes

Sourcetype t =

Location of a data ring

include Sexplib0.Sexpable.S with type t := t

Sourceval t_of_sexp : Sexplib0.Sexp.t -> t

Sourceval sexp_of_t : t -> Sexplib0.Sexp.t

Sourceval to_length : t -> int

to_length t gives the maximum number of available bytes at t

Sourceval to_order : t -> int

to_order t gives the 'order' which is shared via the metadata page and used to uniquely identify the location

Sourceval of_order : int -> (t, [> `Msg of string ]) result

of_order x parses the order

Sourceval 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