Skip to content

Latest commit

 

History

History
47 lines (37 loc) · 1.98 KB

README.md

File metadata and controls

47 lines (37 loc) · 1.98 KB

Conduit - a framework to abstract the protocol

The conduit library is a simple framework to abstract a protocol. It permits, for a protocol implementer, to get rid the responsibility of the protocols choice (such as the TLS implementation). So, it provides a degree of abstraction from precise protocol (like TLS or TCP/IP) libraries used - since there are a variety of them.

Documentation & Tutorials

The documentation is available here.

A simple HOW-TO to describe how to implement a ping-pong server/client and how to upgrade them with TLS is available here

A more complete (but less easier to understand) document to describe Conduit is available here.

Distribution

Conduit comes with several packages:

  • conduit: the core library which has only 3 dependencies
  • conduit-tls: a Conduit-compatible ocaml-tls implementation
  • conduit-lwt: the library with lwt, it provides a Conduit-compatible Host's TCP/IP protocol
  • conduit-async: the library with async, it provides a Conduit-compatible Host's TCP/IP protocol
  • conduit-lwt-{ssl,tls} provides the Host's TCP/IP protocol with SSL (OpenSSL) and TLS (ocaml-tls)
  • conduit-async-{ssl,tls} provides the Host's TCP/IP protocol with SSL (OpenSSL) and TLS (ocaml-tls)
  • conduit-mirage a Conduit-compatible mirage-tcpip protocol

Further Informartion