package capnp-rpc-unix

You can search for identifiers within the package.

in-package search v0.2.0

capnp-rpc-unix
- Capnp_rpc_unix
  - CapTP
  - Cap_file
  - File_store
  - Network
    
    Address
    
    Location
    
    Types
  - Unix_flow
  - Vat
  - Vat_config

Legend:
Library
Module
Module type
Parameter
Class
Class type

A network using TCP and Unix-domain sockets.

module Location : sig ... end

include Capnp_rpc_lwt.S.NETWORK
  with type t = unit
   and type Address.t = Location.t * Capnp_rpc_lwt.Auth.Digest.t

module Types : Capnp_rpc.S.NETWORK_TYPES

module Address : 
  Capnp_rpc_lwt.S.ADDRESS
    with type t = Location.t * Capnp_rpc_lwt.Auth.Digest.t

type t = unit

val connect : 
  t ->
  switch:Lwt_switch.t ->
  secret_key:Capnp_rpc_lwt.Auth.Secret_key.t Lazy.t ->
  Address.t ->
  (Capnp_rpc_lwt.Endpoint.t, [> `Msg of string ]) result Lwt.t

connect t ~switch ~secret_key address connects to address, proves ownership of secret_key (if TLS is being used), and returns the resulting endpoint. Returns an error if no connection can be established or the target fails to authenticate itself. If switch is turned off, the connection should be terminated.

val parse_third_party_cap_id : 
  Capnp.Message.ro Capnp.RPC.None(Capnp.BytesMessage).Slice.t option ->
  Types.third_party_cap_id

val accept_connection : 
  switch:Lwt_switch.t ->
  secret_key:Capnp_rpc_lwt.Auth.Secret_key.t option ->
  Unix_flow.flow ->
  (Capnp_rpc_lwt.Endpoint.t, [> `Msg of string ]) result Lwt.t

accept_connection ~switch ~secret_key flow is a new endpoint for flow. If secret_key is not None, it is used to perform a TLS server-side handshake. Otherwise, the connection is not encrypted.