package capnp-rpc-net

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 `Capnp_rpc_net.Endpoint`Source

Send and receive capnp messages over a byte-stream.

Sourceval src : Logs.src

Control the log level.

Sourcetype t

A wrapper for a byte-stream (flow).

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

send t msg enqueues msg.

Sourceval run_writer : tags:Logs.Tag.set -> t -> unit

run_writer ~tags t runs a loop that transmits batches of messages from t. It returns when the flow is closed.

val recv : 
  tags:Logs.Tag.set ->
  t ->
  (Capnp.Message.ro Capnp.BytesMessage.Message.t, [> `Closed ]) result

recv ~tags t reads the next message from the remote peer. It returns Error `Closed if the connection to the peer is lost.

Sourceval of_flow : peer_id:Auth.Digest.t -> _ Eio.Flow.two_way -> t

of_flow ~peer_id flow sends and receives on flow.

Sourceval peer_id : t -> Auth.Digest.t

peer_id t is the fingerprint of the peer's public key, or Auth.Digest.insecure if TLS isn't being used.

Sourceval shutdown_send : t -> unit

shutdown_send t closes the writer, causing run_writer to return once all buffered data has been written.

Sourceval disconnect : t -> unit

disconnect t shuts down the underlying flow.