Interface for establishing reliable stream-oriented connections.
This library abstracts the concerns of establishing connections to peers that may be running within the same host (e.g. in another virtual machine) or on a remote host via TCP. It consists of one library that is responsible for establishing individual connections, and a name resolver that maps URIs to endpoints.
Connections are created by identifying remote nodes using an endp value. To ensure portability, the endp values are translated into concrete connections by separate modules that target Lwt_unix, Async and Mirage. This lets those backends use the appropriate local technique for creating the connection (such as using OpenSSL on Unix, or a pure OCaml TLS+TCP implementation on Mirage, or some other combination).
The modules dealing with connection establishment are:
Conduit_lwt_unix Connection establishment using the Lwt_unix libraryConduit_async Connection establishment using the Async libraryConduit_mirage This deals with resolving URIs into a list of endp addresses that can then be connected to by the connection establishment modules.
All of the name resolvers conform to the RESOLVER module type. The OS-specific implementations of this interface are:
Resolver_lwt Resolve URIs to endpoints using the Lwt libraryResolver_lwt_unix Resolve URIs to endpoints using Unix system callsResolver_mirage type endp = [ | `TCP of Ipaddr.t * intIP address and destination port
*)| `Unix_domain_socket of stringUnix domain file path
*)| `Vchan_direct of int * stringdomain id, port
*)| `Vchan_domain_socket of string * stringVchan Xen domain socket
*)| `TLS of string * endpWrap in a TLS channel, hostname,endp
| `Unknown of stringFailed resolution
*) ]End points that can potentially be connected to. These are typically returned by a call to a resolver.
module type IO = sig ... endModule type for cooperative threading that can be satisfied by Lwt or Async