package capnp-rpc-lwt

You can search for identifiers within the package.

in-package search v0.2.0

capnp-rpc-lwt
- Capnp_rpc_lwt
  - Auth
    
    Digest
    
    Map
    
    Secret_key
  - Capability
    
    Request
  - Capnp_address
    
    Location
  - Endpoint
  - Networking
    
    CapTP
    
    Flow
    
    N
    
    Address
    
    Types
    
    Vat
  - Persistence
    
    persistent
  - Restorer
    
    Id
    
    LOADER
    
    Table
  - S
    
    ADDRESS
    
    NETWORK
    
    Address
    
    Types
    
    VAT_NETWORK
    
    CapTP
    
    Network
    
    Address
    
    Types
    
    Vat
  - Service
    
    Response
  - StructRef
  - Sturdy_ref
  - Tls_wrapper
    
    Make
    
    Underlying
  - Two_party_network
    
    Address
    
    Types
  - VAT_NETWORK
    
    CapTP
    
    Network
    
    Address
    
    Types
    
    Vat

Legend:
Library
Module
Module type
Parameter
Class
Class type

type +'a t

An off-line (persistent) capability reference.

A sturdy ref contains all the information necessary to get a live reference to a service:

The network address of the hosting vat (e.g. TCP host and port)
A way to authenticate the hosting vat (e.g. a fingerprint of the vat's public key)
A way to identify the target service within the vat and prove permission to access it (e.g. a "Swiss number")

val connect : 
  'a t ->
  ('a Capability.t, Capnp_rpc.Exception.t) Pervasives.result Lwt.t

connect t returns a live reference to t's service.

val connect_exn : 'a t -> 'a Capability.t Lwt.t

connect_exn is a wrapper for connect that returns a failed Lwt thread on error.

val reader : 
  ('a StructStorage.reader_t -> Capnp.MessageSig.ro Slice.t option) ->
  'a StructStorage.reader_t ->
  Uri.t

reader accessor is a field accessor for reading a sturdy ref. e.g. if sr_get is a generated field accessor for an AnyPointer field, then reader Reader.Struct.sr_get is an accessor that treats it as a SturdyRef field. todo: This should really return a sturdy ref, not a URI, but that requires a change to the spec to add a sturdy ref cap-descriptor table entry type.

val builder : 
  ('a StructStorage.builder_t -> Capnp.MessageSig.rw Slice.t) ->
  'a StructStorage.builder_t ->
  _ t ->
  unit

builder setter converts a generated AnyPointer field setter setter to a SturdyRef setter. Use it to add a SturdyRef to a message with builder Params.sr_get params sr.

val cast : 'a t -> 'b t