package conduit

  1. Overview
  2. Docs
A network connection establishment library

Install

Dune Dependency

Authors

Maintainers

Sources

conduit-6.0.0.tbz
sha256=5ea8d2d9a5fe69d909083b40b8ebbee2e2b39e8bb5428dc43c5e7a11081f69de
sha512=5d58479873a06107ea7eeaba7444018e7a09135cc1a6f1fd813aa8279823ceb5f6cf613b5d2573f72e40eeaec9ab651c3e6d4e1f5dcacd95c46a91232c9b5873

Description

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 useful opam packages available that extend this library 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

Tags

org:mirage

Published: 11 Oct 2022

README

conduit -- an OCaml network connection establishment library

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

Dependencies (9)

  1. ipaddr-sexp
  2. ipaddr >= "4.0.0"
  3. logs >= "0.5.0"
  4. uri
  5. astring
  6. sexplib
  7. ppx_sexp_conv >= "v0.13.0"
  8. dune >= "2.0"
  9. ocaml >= "4.03.0"

Dev Dependencies

None

Used by (18)

  1. cohttp-lwt < "1.0.0"
  2. cohttp-mirage = "2.3.0" | >= "2.5.5"
  3. conduit-async = "6.0.0"
  4. conduit-lwt = "6.0.0"
  5. current_web < "0.4"
  6. datakit < "0.9.0"
  7. datakit-bridge-github < "0.12.0"
  8. datakit-ci < "0.12.0"
  9. datakit-github < "0.9.0"
  10. git = "1.4.10" | >= "1.5.0" & < "1.10.0"
  11. git-unix < "1.11.1"
  12. irmin-cli
  13. irmin-unix >= "2.3.0"
  14. ketrew
  15. mirage-http >= "2.5.3"
  16. prof_spacetime
  17. websocket >= "2.0.0" & < "2.7" | >= "2.13"
  18. yurt < "0.3"

Conflicts

None

OCaml

Innovation. Community. Security.