package capnp-rpc

  1. Overview
  2. Docs
Cap'n Proto is a capability-based RPC system with bindings for many languages

Install

dune-project
 Dependency

Authors

Maintainers

Sources

capnp-rpc-2.1.1.tbz
sha256=6e9675034c8eac5873ed511f9b968db5223278145bb02ac4a970053a53970a48
sha512=2e2eb8389071bdad3ceef1d15200bf28987f13319f754f4d1603828d0d79202b4de90a6eb294f12ee088c7e3b73755286fbe7076b8fd3d0b29644221e0e7e080

doc/capnp-rpc.proto/Capnp_rpc_proto/Cap_proxy/Make/argument-1-C/Response_payload/index.html

Module C.Response_payload

The payload of a response message.

Wraps WIRE_PAYLOAD to deal with caps rather than attachments.

val snapshot_caps : t -> cap RO_array.t
val field : t -> Wire.Path.t -> cap option

field t path looks up path in the message and returns the capability at that index. Returns None if the field wasn't set. Returns a broken capability if an index was given but does not exist (i.e. the message is corrupted). Increases the ref-count on the result.

val with_caps : cap RO_array.t -> t -> t

with_caps caps t is a copy of t with a new set of capabilities. This is useful to implement TakeFromOtherQuestion, where the message is the same but embargoes may be needed, and to break cycles.

val release : t -> unit

release t frees all the capabilities attached to this message. It is safe to call this multiple times; only the first call has any effect.

val pp : t Fmt.t