package httpaf
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=9156a22b758b17f5fad3147d852d69568628324c55f09089bd7fff47d6306001
md5=b878ea9b23b3c863ed2a532148bb430e
Description
http/af implements the HTTP 1.1 specification with respect to parsing, serialization, and connection pipelining as a state machine that is agnostic to the underlying IO mechanism, and is therefore portable across many platform. It uses the Angstrom and Faraday libraries to implement the parsing and serialization layers of the HTTP standard, hence the name.
Published: 13 Jan 2018
README
http/af
http/af is a high-performance, memory-efficient, and scalable web server for OCaml. It implements the HTTP 1.1 specification with respect to parsing, serialization, and connection pipelining as a state machine that is agnostic to the underlying IO mechanism, and is therefore portable across many platform. It uses the Angstrom and Faraday libraries to implement the parsing and serialization layers of the HTTP standard, hence the name.
Installation
Install the library and its dependencies via OPAM:
opam install httpaf
Performance
The reason for http/af's existence is mirage/ocaml-cohttp#328, which highlights the poor scalability of cohttp. This is due to a number of factors, including poor scheduling, excessive allocation, and starvation of the server's accept loop. Here is a comparison chart of the data from that issue, along with data from an async-based http/af server. This server was run on a VM with 3 virtual cores, the host being circa 2015 MacBook Pro:
The http/af latency histogram, relative to the cohttp histograms, is pretty much flat along the x-axis. Here are some additional statistics from that run (with latencies in milliseconds):
#[Mean = 27.719, StdDeviation = 31.570]
#[Max = 263.424, Total count = 1312140]
#[Buckets = 27, SubBuckets = 2048]
----------------------------------------------------------
1709909 requests in 1.00m, 3.33GB read
Usage
WIP
Development
To install development dependencies, pin the package from the root of the repository:
opam pin add -n httpaf .
opam install --deps-only httpaf
After this, you may install a development version of the library using the install command as usual.
Tests can be run via jbuilder:
jbuilder runtest
License
BSD3, see LICENSE files for its text.
Dependencies (5)
Dev Dependencies (1)
-
alcotest
with-test
Used by (7)
-
git-paf
>= "3.5.0"
-
h2
< "0.12.0"
- http-mirage-client
-
httpaf-async
>= "0.2.0" & < "0.5.0"
- paf-cohttp
- paf-le
- websocketaf
Conflicts
None