package async

  1. Overview
  2. Docs
package async
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Transport.WriterSource

include module type of struct include Async_rpc_kernel.Rpc.Transport.Writer end
include S
Sourceval sexp_of_t : t -> Sexplib0.Sexp.t
Sourceval close : t -> unit Async_kernel.Deferred.t
Sourceval is_closed : t -> bool
Sourceval bytes_to_write : t -> int
Sourceval bytes_written : t -> Core.Int63.t
Sourceval stopped : t -> unit Async_kernel.Deferred.t

Becomes determined when it is no longer possible to send message using this writer, for instance when the writer is closed or the consumer leaves.

The result of this function is cached by Rpc.Transport

Sourceval flushed : t -> unit Async_kernel.Deferred.t

flushed t returns a deferred that must become determined when all prior sent messages are delivered.

It must be OK to call flushed t after t has been closed.

Sourceval ready_to_write : t -> unit Async_kernel.Deferred.t

ready_to_write t becomes determined when it is a good time to send messages again. Async RPC calls this function after sending a batch of messages, to avoid flooding the transport.

Using let ready_to_write = flushed is an acceptable implementation.

All the following functions send exactly one message.

Sourceval send_bin_prot : t -> 'a Core.Bin_prot.Type_class.writer -> 'a -> unit Async_rpc_kernel__.Transport_intf.Send_result.t
Sourceval send_bin_prot_and_bigstring : t -> 'a Core.Bin_prot.Type_class.writer -> 'a -> buf:Core.Bigstring.t -> pos:int -> len:int -> unit Async_rpc_kernel__.Transport_intf.Send_result.t
Sourceval send_bin_prot_and_bigstring_non_copying : t -> 'a Core.Bin_prot.Type_class.writer -> 'a -> buf:Core.Bigstring.t -> pos:int -> len:int -> unit Async_kernel.Deferred.t Async_rpc_kernel__.Transport_intf.Send_result.t

Same as send_bin_prot_and_bigstring but the bigstring can't be modified until the returned deferred becomes determined. This can be used to avoid copying the bigstring.

Sourceval pack : (module S with type t = 'a) -> 'a -> t
Sourceval can_send : t -> bool

can_send t = not (is_closed t || Deferred.is_determined (stopped t))

Sourceval transfer : t -> ?max_num_values_per_read:int -> 'a Async_kernel.Pipe.Reader.t -> ('a -> unit) -> unit Async_kernel.Deferred.t

This function is similar to Async_unix.Writer.transfer, except that it doesn't wait on Pipe.upstream_flushed when the writer is closed.

Sourceval of_writer : ?max_message_size:int -> Async_writer.t -> t
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct