Add Service.serve_when_ready

.github/workflows/test.yml

@@ -6,23 +6,28 @@ jobs:
     runs-on: ${{ matrix.operating-system }}
     strategy:
       matrix:
-        ocaml-version: [ '4.08.1', '4.09.0', '4.10.0' ]
-        operating-system: [macos-latest, ubuntu-latest, windows-latest]
+        ocaml-version: [ '4.08.1', '4.09.0', '4.10.0', '4.11.1' ]
+        operating-system: [ ubuntu-latest ]
     steps:
-    - uses: actions/checkout@master
-    - uses: avsm/setup-ocaml@master
+    - uses: actions/checkout@v2
+    - uses: avsm/setup-ocaml@v1
       with:
         ocaml-version: ${{ matrix.ocaml-version }}
     - name: Deps
       run: |
         opam pin add -n conduit.dev .
         opam pin add -n conduit-lwt.dev .
-        opam pin add -n conduit-lwt-unix.dev .
         opam pin add -n conduit-async.dev .
         opam pin add -n conduit-mirage.dev .
-        opam depext -y conduit conduit-lwt conduit-lwt-unix conduit-async conduit-mirage
-        opam install --deps-only .
+        opam pin add -n conduit-tls.dev .
+        opam pin add -n conduit-async-tls.dev .
+        opam pin add -n conduit-async-ssl.dev .
+        opam pin add -n conduit-lwt-tls.dev .
+        opam pin add -n conduit-lwt-ssl.dev .
+        opam pin add -n conduit-bench.dev .
+        opam depext  -y conduit conduit-tls conduit-lwt conduit-async conduit-mirage
+        opam install --deps-only -t conduit conduit-tls conduit-lwt conduit-lwt-tls conduit-lwt-ssl conduit-async conduit-async-tls conduit-async-ssl conduit-mirage conduit-bench
     - name: Build
       run: opam exec -- dune build
     - name: Test
-      run: opam exec -- dune runtest
+      run: opam exec -- dune runtest --no-buffer --verbose -j 1

.gitignore

@@ -1,5 +1,7 @@
 _build/
-_opam/
+_opam
+sandbox/
 .*.swp
 *.install
 .merlin
+*~

.ocamlformat

@@ -0,0 +1,8 @@
+version = 0.15.0
+break-infix = fit-or-vertical
+parse-docstrings = true
+indicate-multiline-delimiters=no
+nested-match=align
+sequence-style=separator
+break-before-in=auto
+if-then-else=keyword-first

CHANGES.md

@@ -1,3 +1,12 @@
+## v3.0.0 (2020-10-06)
+
+* **breaking change** - New version of `conduit`. Most of the new API has a
+  description on the pull-request
+  [#311](https://github.com/mirage/ocaml-conduit/pull/311). Documentation is
+  updated as well with a small HOW-TO (available
+  [here](https://mirage.github.io/ocaml-conduit/conduit/howto.html)) which
+  describes the new API.
+
 ## v2.2.2 (2020-06-14)
 
 * conduit-lwt-unix no longer calls Mirage_crypto_rng_unix.initialize, and is

Makefile

@@ -1,4 +1,4 @@
-.PHONY: build clean test doc
+.PHONY: build clean test doc bench
 
 build:
 	dune build
@@ -11,3 +11,6 @@ clean:
 
 doc:
 	dune build @doc
+
+bench:
+	@dune exec  -- ./bench/cost.exe --json

README.md

@@ -1,37 +1,47 @@
-## conduit -- an OCaml network connection establishment library
+## Conduit - a framework to abstract the protocol
 
-[![Build Status](https://travis-ci.org/mirage/ocaml-conduit.svg?branch=master)](https://travis-ci.org/mirage/ocaml-conduit)
+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.
 
-The `conduit` library takes care of establishing and listening for 
-TCP and SSL/TLS connections for the Lwt and Async libraries.
+### Documentation & Tutorials
 
-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).
+The documentation is available [here][doc].
 
-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.
+A simple HOW-TO to describe how to implement a ping-pong server/client and how
+to upgrade them with TLS is available [here][howto]
 
-The opam packages available are:
+A more complete (but less easier to understand) document to describe Conduit is
+available [here][readme].
 
-- `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
+### Distribution
 
-### 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.
+Conduit comes with several packages:
+- `conduit`: the core library which has only 3 dependencies
+- `conduit-tls`: a Conduit-compatible [ocaml-tls][ocaml-tls] implementation
+- `conduit-lwt`: the library with [lwt][lwt], it provides a Conduit-compatible
+  Host's TCP/IP protocol
+- `conduit-async`: the library with [async][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][mirage-tcpip] protocol
 
 ### Further Informartion
 
-* **API Docs:** http://docs.mirage.io/
+* **API Docs:** http://mirage.github.io/ocaml-conduit/
 * **WWW:** https://github.com/mirage/ocaml-conduit
 * **E-mail:** <[email protected]>
 * **Bugs:** https://github.com/mirage/ocaml-conduit/issues
+
+[doc]: https://mirage.github.io/ocaml-conduit/conduit/index.html
+[howto]: https://mirage.github.io/ocaml-conduit/conduit/howto.html
+[readme]: https://mirage.github.io/ocaml-conduit/conduit/readme.html
+[ocaml-tls]: https://github.com/mirleft/ocaml-tls
+[lwt]: https://github.com/ocsigen/lwt
+[async]: https://github.com/janestreet/async
+[mirage-tcpip]: https://github.com/mirage/mirage-tcpip