Module `Capnp_rpc_unix`Source

Helpers for using Capnp_rpc on traditional operating systems.

include Capnp_rpc_net.VAT_NETWORK with module Network = Network

Sourcemodule Network : sig ... end

A network using TCP and Unix-domain sockets.

Sourcemodule CapTP : sig ... end

Sharing capabilities over a network link.

Sourcemodule Vat : sig ... end

A Vat is an actor in the CapTP network, composed of objects that can call each other directly.

Sourcemodule Vat_config : sig ... end

Configuration for a Vat.

Sourcemodule File_store : sig ... end

An on-disk store for saved services.

Sourcemodule Cap_file : sig ... end

Utilities for capability files.

Sourceval sturdy_uri : Uri.t Cmdliner.Arg.conv

A cmdliner argument converter for a "capnp://" URI (or the path of a file containing such a URI).

Source

val connect_with_progress : 
  ?mode:[ `Auto | `Log | `Batch | `Console | `Silent ] ->
  'a Capnp_rpc.Std.Sturdy_ref.t ->
  ('a Capnp_rpc.Std.Capability.t, Capnp_rpc.Exception.t) result

connect_with_progress sr is like Sturdy_ref.connect, but shows that a connection is in progress. Note: On failure, it does not display the error, which should instead be handled by the caller.

parameter mode
Controls how progress is displayed:
- `Log writes info-level log messages about starting and completing the connection.
- `Batch prints a message to stderr when starting, then prints OK when done.
- `Console displays a message while connecting if it takes too long, then erases it when done.
- `Silent does nothing.
- `Auto (the default) tries to log (as for `Log), but if the log message isn't used then it behaves as `Console (if stderr is a tty) or as `Batch (if not).

Source

val with_cap_exn : 
  ?progress:[ `Auto | `Log | `Batch | `Console | `Silent ] ->
  'a Capnp_rpc.Std.Sturdy_ref.t ->
  ('a Capnp_rpc.Std.Capability.t -> 'b) ->
  'b

Like Sturdy_ref.with_cap_exn, but using connect_with_progress to show progress.

Source

val serve : 
  ?tags:Logs.Tag.set ->
  ?restore:Capnp_rpc_net.Restorer.t ->
  sw:Eio.Switch.t ->
  Vat_config.t ->
  Vat.t

serve ~restore ~sw vat_config is a new vat that is listening for new connections as specified by vat_config. After connecting to it, clients can get access to services using restore.

Source

val client_only_vat : 
  ?tags:Logs.Tag.set ->
  ?restore:Capnp_rpc_net.Restorer.t ->
  sw:Eio.Switch.t ->
  _ Eio.Net.t ->
  Vat.t

client_only_vat net is a new vat that does not listen for incoming connections.

Sourceval manpage_capnp_options : string

manpage_capnp_options is the title of the section of the man-page containing the Cap'n Proto options. This can be used to control where these options appear in the page (e.g. to put them below the other options).

Install

Dune Dependency

Authors

Maintainers

Sources

doc/capnp-rpc-unix/Capnp_rpc_unix/index.html

Module `Capnp_rpc_unix`Source

package capnp-rpc-unix

Install

Dune Dependency

Authors

Maintainers

Sources

doc/capnp-rpc-unix/Capnp_rpc_unix/index.html

Module Capnp_rpc_unixSource

Module `Capnp_rpc_unix`Source