BSD-3-Clause licensed by Alcides Viamontes Esquivel
Maintained by [email protected]

Module documentation for 0.6.1.0

This version can be pinned in stack with:[email protected]:423b0e92220a2ade3f9abe83d4191105fa1c52f775829d2ac8eb1d00aedd7e4e,8193

Developer README

Introduction

This is an early-stage and very experimental library to create HTTP/2 servers using Haskell.

To see the package docs, please check the Hackage page or the file hs-src/SecondTransfer.hs.

Building and installing

You need Haskell GHC compiler installed (version 7.8.3 at least). You also need OpenSSL 1.0.2, since the ALPN feature and some very recent cypher-suites are needed by HTTP/2. this source distribution will try to find them at directory /opt/openssl-1.0.2, but you should be able to alter the options using cabal configure. This package uses Haskell’s FFI to interface with OpenSSL.

Provided that you have all the dependencies, you should be able to just do:

$ cabal install second-transfer

Running the tests

$ cabal test

Debugging complicated scenarios

To access full debugging capabilities, for example from the test suite, use the following command from the project’s directory:

$ cabal exec -- ghci -ihs-src -itests/tests-hs-src -itests/support -XCPP -Imacros/ dist/build/cbits/tlsinc.o

Example

There is a very basic example at tests/tests-hs-src/compiling_ok.hs.

Roadmap

Done:

  • Version 0.1: Having something that can run. No unit-testing, nothing fancy.

  • Version 0.2: Absolutely minimal amount of unit tests.

  • Version 0.3: More sensible logging.

Pending:

  • Benchmarking.

Internal

Uploading documentation (provided you have access to the package):

$ ./hackage-upload-docs.sh second-transfer 0.5.4.0 <hackage-user> <hackage-password>

Changes

  • 0.6.1.0 :

    • Improved documentation.
    • Improved ALPN negotiation handling.
    • Messages with a body are now handled by the HTTP/1.1 speaking part of this library.
  • 0.6.0.0 :

    • Changed the interface to provide more information to and from workers
    • Implemented HTTP/2 push
    • Upgraded dependencies to 1.0. for http2 package
    • Extended channel interface in such a way that latency is reduced, as a result, the test suite is completely broken. Please wait for 0.6.0.1 release.
  • 0.5.5.1 :

    • Restricted HTTP2 package version.
    • Fixes #2
  • 0.5.5.0 :

    • Made HeaderEditor a Monoid instance
    • Trying to WINDOW_UPDATE an unexistent stream aborts the session, as it should
  • 0.5.4.0 :

    • Added the type HTTP500PrecursorException and corresponding test
    • Improved test suite so that requests can be simulated a little bit more easily
    • Re-export type Headers from module HTTPHeaders
  • 0.5.3.2 :

    • Added this changelog.
    • Fixed the lower limit for the time package.
    • Enforce first frame being a settings frame when receiving.
    • Added a couple of tests.