A Elixir implementation of the HPack protocol for HTTP/2 header compression
Elixir
Latest commit dab696f Sep 3, 2016 @nesQuick committed on GitHub Cache dialyzer plt file (#5)
* show travis env

* test different plt directory

* fix syntax error

* only generate plt files if not existent

* fix travis yml

* irun travis

README.md

HPack (RFC 7541) Build Status

Implementation of the HPack protocol, a compression format for efficiently representing HTTP header fields, to be used in HTTP/2.

Installation

  1. Add hpack to your list of dependencies in mix.exs:

    def deps do
      [{:hpack, "~> 1.0.0"}]
    end

Usage

The HPack library has a simple interface. You will need two functions:

Decoding

{:ok, ctx} = HPack.Table.start_link(1000)
HPack.decode(<< 0x82 >>, ctx)
# => [{":method", "GET"}]

Encoding

{:ok, ctx} = HPack.Table.start_link(1000)
HPack.encode([{":method", "GET"}], ctx)
# => << 0b10000010 >>

Acknowledgements

The cowboy hpack implementation by Loïc Hoguin (@essen) was a great help while writing this library.

feature wishes / ideas / contribute

Nice to have:

  • transcoding for intermediaries (never indexed)
  • handle small tables in a performant way (keep track of headers)

please write test <3

License

The MIT License (MIT)

Copyright (c) 2016 Ole Michaelis

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.