Add Service.serve_when_ready #371
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The core library gives only abstractions needed further. It lets the end-user to choose: - the type `input` - the type `output` - the type `+'a s` (the scheduler) Definition of them will create an internal hashtbl which prospects available protocols. The core library provides without application of functors a local map `resolvers` which is needed to start a connection (eg. `Conduit.flow`). `resolvers` represents the global process to resolve a domain-name to a `flow` used by `conduit`. More technically: - E1 is the local map `resolvers` - E0 is the hidden global hashtbl of `conduit` - Sigs contains signatures needed by `conduit` This commit adds a README.md which explains how to use `conduit`.
…ism of the TLS layer with another protocol `ocaml-tls` is a new package which provides internally a _functor_ to compose a Conduit.Sigs.PROTOCOL with TLS. It gives an example of composition of protocols in `conduit`. It requires an implementation of `conduit` which, at least, uses `Cstruct.t` as `input` and `output`. A realistic example is the composition of tcp/ip protocols provided by: - `conduit-lwt-unix` - `conduit-async` - `conduit-mirage` Each of them are differents (about type and implementation) but they use this package to provide a TLS layer on top of them. At the end, composition should be less than 10 lines of code. Due to the non ability to use the scheduler, provided implementation is not protected against data-race condition. The documentation tells you more about that.
… helper to start a server `conduit-lwt` is roughly an application of `conduit` with: - type input = Cstruct.t - type output = Cstruct.t - type +'a s = 'a Lwt.t Due to the ability to play with the scheduler, `conduit-lwt` provides: - an implementation of the interface `mirage-flow.2.0.1` (deprecated) - an helper to start a server - conduit-tls with lwt The first is deprecated due to the difference between `Conduit.recv` and `Mirage_flow.recv`. The documentation tells you more about that. The second is what `conduit` provided before, a common loop to start the server with an _handler_. It is used by `ocaml-cohttp`. This helper is not restricted to a specific protocol. The third is an application of `conduit-tls` with `conduit-lwt`.
…l layers
This is the first real implementation of `conduit` with some protocols:
- tcp/ip with `Lwt_unix`
- tls with `conduit-tls`
- ssl with `Lwt_ssl`
Due to the ability to use `Lwt_io`, this package provides an helper to
give `Lwt_io.channel` from an abstracted `Conduit_lwt{_unix}.flow`.
It provides TLS + provided tcp/ip protocol, a possible composition
with SSL layer (with `Lwt_ssl`) and SSL + provided tcp/ip protocol.
It provides a `resolv_conf` function as the main DNS resolver. It's a
call of `gethostbyname` and finally trusts on your `resolv.conf`.
`conduit-lwt` with the tcp/ip stack provided by `mirage` and a composition of it with the TLS layer provided by `conduit-tls`. It exposes a `mirage-flow` implementation as `conduit-lwt` (deprecated).
…p, tls and ssl layers `conduit` with `async` and: - tcp/ip layer provided by `Async.Tcp` - ssl layer with `Async_ssl` and its implementation with the given tcp/ip stack - tls layer with `conduit-tls` and its implementation with the given tcp/ip stack - An helper to get `Reader.t`/`Writer.t` from an abstracted `Conduit_async.flow` - a `resolv_conf` resolver which trusts on your `resolv.conf`
- We split `conduit` into 2 parts:
+ A client part to connect/recv/send/close
+ A server part to make/accept/close
- Deletion of the type witness value `'a key`
The old design has 2 sets, a set of `'a key` and a set of `'a
Witness.protocol`. The first represents the type of the required value
to _initialize_ the connection. The second represents the type of the
created `flow`. With such design, the end-user had to do the link by
himself between `'a key` and `'a protocol` when he calls
`register_protocol`.
However, the user must keep the link by himself when he wants to
extract the implementation (eg. `impl_of_protocol`).
It appears that, from an usability point-of-view, a `'a protocol` has
only one and uniq key. So this commit merges `'a key` and `'a
protocol` into one and uniq type witness value `('edn, 'flow)
protocol`.
The commit does the same about service (with `'cfg`).
- Expose extensible variant
This commit de-abstracts `type flow` to `type flow = private ..`
So we still must use `register` to extend `flow`, but we have the
ability to _pattern-match_ on the type `flow` as long as the protocol
implementer exposes `type Conduit.flow += T of t`. The protocol
implementer can do that with the new function `Conduit.repr` - an
example exists on `conduit-lwt-unix.tcp` and `conduit-lwt-unix.tls`.
However, `Conduit.is` still exists to allow the deconstruction of the
type `flow` with a given `('edn, 'flow) protocol`.
- Rename `Conduit.flow` to `Conduit.connect`
- `protocol` given by `Conduit.Service.serve` is wrapped into a GADT to
hidden the _endpoint_ type. We still continue to be able to abstract
the `'flow` given by `accept` but a step is added to abstract it to
the type `Conduit.flow`.
- And we remove the required protocol to register an new service
This ensures that the OCaml toplevel is able to introspect these signatures directly and prevents references to module types in `Conduit_intf` from escaping to the user. Fixes mirage#356.
so users can write: ``` let send = Conduit.send flow ... send buf ``` and `send` will be compiled optimally.
specialise partial applications when possible
core: expand aliases exposed in _intf file
Remove unused Conduit_lwt_flow module
Better lwt tcp protocol
…entation of the TLS layer
Re-export Conduit.Refl constructor
Tls thread safe
This is a regression test for the issue introduced by mirage#357 and fixed by mirage#361.
The `opam/` pattern doesn't apply to local switches created with `opam link` (which are not directories).
Add a test that Service.equal is reflexive
Gitignore opam/ when it is a symlink
Remove unused Conduit.S.resolvers type
Fix mirage#352. The `lwt` and `async` service loops previously took condition variables that were used as a shutdown signal. This resulted in a race condition: the shutdown signal can be broadcast before the server is waiting on it. Fixed by having the service loops take switches as configuration instead.
which is like `serve` but returns ``[ `Initialized of unit io ] io``, rather than a plain `unit io` in order to allow the user to perform actions after initialisation but before the service loop begins. In particular, this is helpful for testing a client/server pair; as is done in the tests for Conduit itself.
|
I've just switched the |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
... which is like
servebut returns[ `Initialized of unit io ] io, rather than a plainunit ioin order to allow the user to perform actions after initialisation but before the service loop begins.In particular, this is helpful for testing a client/server pair; as is done in the tests for Conduit itself.
Depends on #369 to avoid conflicts.