conduit-mirage

A network connection establishment library for MirageOS
README

The conduit library takes care of establishing and listening for
TCP and SSL/TLS connections for the Lwt and Async libraries.

The reason this library exists is to provide a degree of abstraction
from the precise SSL library used, since there are a variety of ways
to bind to a library (e.g. the C FFI, or the Ctypes library), as well
as well as which library is used (just OpenSSL for now).

By default, OpenSSL is used as the preferred connection library, but
you can force the use of the pure OCaml TLS stack by setting the
environment variable CONDUIT_TLS=native when starting your program.

The opam packages available are:

  • conduit: the main Conduit module

  • conduit-lwt: the portable Lwt implementation

  • conduit-lwt-unix: the Lwt/Unix implementation

  • conduit-async the Jane Street Async implementation

  • conduit-mirage: the MirageOS compatible implementation

Debugging

Some of the Lwt_unix-based modules use a non-empty CONDUIT_DEBUG
environment variable to output debugging information to standard error.
Just set this variable when running the program to see what URIs
are being resolved to.

Further Informartion

  • API Docs: https://mirage.github.io/ocaml-conduit/

  • WWW: https://github.com/mirage/ocaml-conduit

  • E-mail: mirageos-devel@lists.xenproject.org

  • Bugs: https://github.com/mirage/ocaml-conduit/issues

Install
Published
25 Oct 2022
Maintainers
Sources
conduit-6.0.1.tbz
sha256=9d192b0b3033f1321e91847442de556bcd94c925b74d3c939da260cd08709922
sha512=bf87223c00662d7ab0804744ae5943b3e419b720f57f074222785590b82954bfaaa54ec11c537fd3c7b2a2ecfe60cf00bc827a86dc674711e875e7a8078386f8
Dependencies
fmt
>= "0.8.7"
tcpip
>= "7.0.0"
ipaddr
>= "3.0.0"
tls-mirage
>= "0.11.0"
tls
>= "0.11.0"
vchan
>= "5.0.0"
conduit-lwt
= version
dns-client
>= "6.4.0"
mirage-time
>= "2.0.0"
mirage-random
>= "2.0.0"
mirage-flow
>= "2.0.0"
mirage-clock
>= "3.0.0"
cstruct
>= "3.0.0"
uri
>= "4.0.0"
ppx_sexp_conv
>= "v0.13.0"
dune
>= "2.0"
ocaml
>= "4.07.0"
Reverse Dependencies
cohttp-mirage
= "2.3.0" | >= "3.0.0"
gluten-mirage
>= "0.3.0"
h2-mirage
= "0.5.0" | >= "0.8.0"
irmin-mirage-git
= "2.3.0" | >= "2.5.0" & < "2.8.0"
resp-mirage
>= "0.10.0"