package capnp
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=d141d6ea5889fb9cc9ceef70408dd410ca0d84edae1d1208d4f90ca74ce77b18
sha512=7d70da54317c8ec13b5129343fc9558e7fe387fc41ac0524cd9363153d47cf293ea36c5d598ab04d9817292cb84d5e764c9446ae29eebcb01976b937a82192b0
doc/capnp.unix/Capnp_unix/IO/WriteContext/index.html
Module IO.WriteContext
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.
enqueue_message context message
places the message
in the outgoing queue of the write context
. No data will be written to the underlying descriptor.
bytes_remaining context
obtains the number of unwritten bytes currently stored in the write context
.
write context
attempts to write some of the queued data to the underlying descriptor associated with the write context
.
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.