package capnp-rpc-net

You can search for identifiers within the package.

in-package search v0.2.0

Cap'n Proto is a capability-based RPC system with bindings for many languages

Install

dune-project

Dependency

sha256=6e9675034c8eac5873ed511f9b968db5223278145bb02ac4a970053a53970a48

sha512=2e2eb8389071bdad3ceef1d15200bf28987f13319f754f4d1603828d0d79202b4de90a6eb294f12ee088c7e3b73755286fbe7076b8fd3d0b29644221e0e7e080

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.