shuttle

Reasonably performant non-blocking channels for async
README

Reasonably performant buffered channels1 for async.

Overview

There are multiple options for performing I/O using async.
The Reader and Writer modules provide a high level API for buffered I/O, and are typically the go-to option for
applications that use async for I/O. These modules maintain their own internal buffer, and offer
users a simple interface that lets them interact with the underlying file descriptor without having
to write custom (and often error prone) buffer management logic.

The Reader/Writer modules provide convinence, but they might not be suitable in scenarios where one wants
slightly more control over when write operations are scheduled, or when the overhead of the reader/writer is not desirable2.
In such scenarios, it is possible to drop down to async's Fd
module and schedule reads and writes manually. This approach will give full control over how I/O operations are scheduled, but will come at a cost of more complexity
as the user is now responsible for buffer management, and proper handling of syscall responses.

Shuttle aims to provide a middle ground for a subset of use-cases handled by Reader/Writer. It doesn't aim to support the full
feature set of the reader/writes modules. In return, it allows for a high level api that pairs the ease of use of reader/writer modules with
performance and latency curves that are closer to implementations with manual buffer management.

Supported Platforms

Currently only linux, macOS and bsd based systems.

How to Install

opam install shuttle for the current published release, and opam pin add shuttle --dev-repo for the development version.

Notes:

  • 1: Channel is a high-level construct for performing I/O.

  • 2: As always, make your own measurements. Also weigh in the fact that reader/writer modules in async are mature, battle tested and cover more use-cases.

  • 3: The implementation started as a fork async_rpc's low latency transport.

  • 4: A shuttle based http server benchmark can be found at https://github.com/ocaml-multicore/retro-httpaf-bench/pull/16

Install
Published
10 Oct 2022
Sources
shuttle-0.6.0.tbz
sha256=1f239dd21dfe5ed0f46c047856618429cc351bcb11e85e8191169431e5e89391
sha512=07d575f812910f6d34d751eb6e4ab1165df3e2c58df8edd879963e72617430e278b32a5c4493262abfc5bccfb1928e49b5fb957db730ae5d30bdd9335a9cdcdb
Dependencies
odoc
with-doc
ppx_jane
>= "v0.15.0"
core_unix
>= "v0.15.0"
core
>= "v0.15.0"
async
>= "v0.15.0"
ocaml
>= "4.11.0"
dune
>= "2.8"
Reverse Dependencies
http_async
>= "0.0.4"
shuttle_ssl
>= "0.6.0"