package capnp

You can search for identifiers within the package.

in-package search v0.2.0

OCaml code generation plugin for the Cap'n Proto serialization framework

Install

Dune Dependency

github.com Changelog Edit opam file Versions (7)

Authors

P

Paul Pelzl <pelzlpj@gmail.com>

Maintainers

P

Paul Pelzl <pelzlpj@gmail.com>

Sources

capnp-v3.3.0.tbz

sha256=7b67b28a097559cad5fba538afb108eefbb4ee24b30e3cfb9dcd387619652049

sha512=d2c7133e0269e1162fa3ba320699759978e92f2c1ee606ce25353c1651e8311a382ec4b9dc2b4a9f51666821ed2ebb55619053b11c8bcdff8b0daa0fd004a9cb

doc/capnp.unix/Capnp_unix/IO/WriteContext/index.html

Module `IO.WriteContext`Source

Sourcetype 'a t

Source

val create : 
  write:('a -> buf:string -> pos:int -> len:int -> int) ->
  compression:Capnp.Codecs.compression_t ->
  'a ->
  'a t

create ~write ~compression descr creates a new context for writing data to the specified descriptor. compression specifies the compression format, if any.

The semantics of the write function shall mimic that of Unix.single_write, attempting to write a substring from the buf and returning the number of bytes actually written.

Sourceval enqueue_message : 'a t -> 'cap Capnp.Message.BytesMessage.Message.t -> unit

enqueue_message context message places the message in the outgoing queue of the write context. No data will be written to the underlying descriptor.

Sourceval bytes_remaining : 'a t -> int

bytes_remaining context obtains the number of unwritten bytes currently stored in the write context.

Sourceval write : 'a t -> int

write context attempts to write some of the queued data to the underlying descriptor associated with the write context.

returns
the number of bytes actually written

Sourceval write_message : 'a t -> 'cap Capnp.Message.BytesMessage.Message.t -> unit

write_message context message places the message in the outgoing queue of the write context, then invokes write in a loop until all queued data has been written.