package conduit-async

  1. Overview
  2. Docs
A network connection establishment library for Async

Install

Dune Dependency

Authors

Maintainers

Sources

conduit-6.2.0.tbz
sha256=3ed440b0edda1b212dd762bdb24831f394dca05985dd1b4ac4f94581d1452394
sha512=017a28bd9873ea7f49ce69e9f4b680df7fa17440b1ff68c2af880df5527fae205249667fa7d35e4a8fe8d101081b6f7d6a384bee1eb0f6f38a2c57beae56aaac

Description

Tags

org:mirage

Published: 22 Feb 2023

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 (11)

  1. ipaddr-sexp >= "4.0.0"
  2. ipaddr >= "3.0.0"
  3. async >= "v0.15.0"
  4. conduit = version
  5. sexplib
  6. ppx_sexp_conv >= "v0.13.0"
  7. ppx_here >= "v0.9.0"
  8. uri >= "4.0.0"
  9. core >= "v0.15.0"
  10. dune >= "2.0"
  11. ocaml >= "4.08.0"

Dev Dependencies

None

Used by (4)

  1. aws-s3-async >= "4.0.0"
  2. caqti-async = "2.0.1"
  3. cohttp-async < "2.5.6" | >= "3.0.0"
  4. pgx_async >= "2.0"

Conflicts (1)

  1. async_ssl < "v0.9.0"