2013-07-28 14:26:41 +02:00
2013-12-06 17:29:39 +01:00
<!DOCTYPE html>
<!-- [if IE 8]><html class="no - js lt - ie9" lang="en" > <![endif] -->
<!-- [if gt IE 8]><! --> < html class = "no-js" lang = "en" > <!-- <![endif] -->
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
2014-08-01 13:56:52 +02:00
< title > nghttp2 - HTTP/2 C Library — nghttp2 0.5.2-DEV documentation< / title >
2013-12-06 17:29:39 +01:00
< link href = 'https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel = 'stylesheet' type = 'text/css' >
< link rel = "stylesheet" href = "_static/css/theme.css" type = "text/css" / >
2014-08-01 13:56:52 +02:00
< link rel = "top" title = "nghttp2 0.5.2-DEV documentation" href = "index.html" / >
2014-04-05 12:26:23 +02:00
< link rel = "next" title = "Tutorial: HTTP/2 client" href = "tutorial-client.html" / >
< link rel = "prev" title = "nghttp2 - HTTP/2 C Library" href = "index.html" / >
2013-12-06 17:29:39 +01:00
2014-05-16 17:06:42 +02:00
2014-02-02 10:36:57 +01:00
< script src = "https://cdnjs.cloudflare.com/ajax/libs/modernizr/2.6.2/modernizr.min.js" > < / script >
2013-12-06 17:29:39 +01:00
< / head >
2014-02-02 10:36:57 +01:00
< body class = "wy-body-for-nav" role = "document" >
2013-12-06 17:29:39 +01:00
< div class = "wy-grid-for-nav" >
< nav data-toggle = "wy-nav-shift" class = "wy-nav-side" >
< div class = "wy-side-nav-search" >
2014-02-02 10:36:57 +01:00
< a href = "index.html" class = "fa fa-home" > nghttp2< / a >
< div role = "search" >
< form id = "rtd-search-form" class = "wy-form" action = "search.html" method = "get" >
< input type = "text" name = "q" placeholder = "Search docs" / >
< input type = "hidden" name = "check_keywords" value = "yes" / >
< input type = "hidden" name = "area" value = "default" / >
< / form >
< / div >
2013-12-06 17:29:39 +01:00
< / div >
2014-02-02 10:36:57 +01:00
< div class = "wy-menu wy-menu-vertical" data-spy = "affix" role = "navigation" aria-label = "main navigation" >
2013-12-06 17:29:39 +01:00
< ul class = "current" >
2014-04-05 12:26:23 +02:00
< li class = "toctree-l1 current" > < a class = "current reference internal" href = "" > nghttp2 - HTTP/2 C Library< / a > < ul >
2013-12-06 17:29:39 +01:00
< li class = "toctree-l2" > < a class = "reference internal" href = "#development-status" > Development Status< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "#public-test-server" > Public Test Server< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "#requirements" > Requirements< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "#build-from-git" > Build from git< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "#building-documentation" > Building documentation< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "#client-server-and-proxy-programs" > Client, Server and Proxy programs< / a > < / li >
2014-03-02 15:54:42 +01:00
< li class = "toctree-l2" > < a class = "reference internal" href = "#benchmarking-tool" > Benchmarking tool< / a > < / li >
2014-01-10 17:07:30 +01:00
< li class = "toctree-l2" > < a class = "reference internal" href = "#hpack-tools" > HPACK tools< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "#python-bindings" > Python bindings< / a > < / li >
2013-12-06 17:29:39 +01:00
< / ul >
< / li >
2014-04-05 12:26:23 +02:00
< li class = "toctree-l1" > < a class = "reference internal" href = "tutorial-client.html" > Tutorial: HTTP/2 client< / a > < ul >
2013-12-26 15:39:18 +01:00
< li class = "toctree-l2" > < a class = "reference internal" href = "tutorial-client.html#libevent-client-c" > libevent-client.c< / a > < / li >
< / ul >
< / li >
2014-04-05 12:26:23 +02:00
< li class = "toctree-l1" > < a class = "reference internal" href = "tutorial-server.html" > Tutorial: HTTP/2 server< / a > < ul >
2013-12-26 15:39:18 +01:00
< li class = "toctree-l2" > < a class = "reference internal" href = "tutorial-server.html#libevent-server-c" > libevent-server.c< / a > < / li >
< / ul >
< / li >
2014-06-29 16:58:04 +02:00
< li class = "toctree-l1" > < a class = "reference internal" href = "tutorial-hpack.html" > Tutorial: HPACK API< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "tutorial-hpack.html#deflating-encoding-headers" > Deflating (encoding) headers< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "tutorial-hpack.html#inflating-decoding-headers" > Inflating (decoding) headers< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "tutorial-hpack.html#deflate-c" > deflate.c< / a > < / li >
< / ul >
< / li >
2014-07-18 14:34:21 +02:00
< li class = "toctree-l1" > < a class = "reference internal" href = "nghttp.1.html" > nghttp(1)< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "nghttp.1.html#name" > NAME< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "nghttp.1.html#synopsis" > SYNOPSIS< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "nghttp.1.html#description" > DESCRIPTION< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "nghttp.1.html#options" > OPTIONS< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "nghttp.1.html#see-also" > SEE ALSO< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "nghttpd.1.html" > nghttpd(1)< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "nghttpd.1.html#name" > NAME< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "nghttpd.1.html#synopsis" > SYNOPSIS< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "nghttpd.1.html#description" > DESCRIPTION< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "nghttpd.1.html#options" > OPTIONS< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "nghttpd.1.html#see-also" > SEE ALSO< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "nghttpx.1.html" > nghttpx(1)< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "nghttpx.1.html#name" > NAME< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "nghttpx.1.html#synopsis" > SYNOPSIS< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "nghttpx.1.html#description" > DESCRIPTION< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "nghttpx.1.html#options" > OPTIONS< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "nghttpx.1.html#see-also" > SEE ALSO< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "h2load.1.html" > h2load(1)< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "h2load.1.html#name" > NAME< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "h2load.1.html#synopsis" > SYNOPSIS< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "h2load.1.html#description" > DESCRIPTION< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "h2load.1.html#options" > OPTIONS< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "h2load.1.html#see-also" > SEE ALSO< / a > < / li >
< / ul >
< / li >
2014-06-26 17:06:44 +02:00
< li class = "toctree-l1" > < a class = "reference internal" href = "nghttpx-howto.html" > nghttpx - HTTP/2 proxy - HOW-TO< / a > < ul >
2014-04-20 16:36:21 +02:00
< li class = "toctree-l2" > < a class = "reference internal" href = "nghttpx-howto.html#default-mode" > Default mode< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "nghttpx-howto.html#http-2-proxy-mode" > HTTP/2 proxy mode< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "nghttpx-howto.html#client-mode" > Client mode< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "nghttpx-howto.html#client-proxy-mode" > Client proxy mode< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "nghttpx-howto.html#http-2-bridge-mode" > HTTP/2 bridge mode< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "nghttpx-howto.html#disable-ssl-tls" > Disable SSL/TLS< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "nghttpx-howto.html#specifying-additional-ca-certificate" > Specifying additional CA certificate< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "nghttpx-howto.html#read-write-rate-limit" > Read/write rate limit< / a > < / li >
2014-06-29 16:58:04 +02:00
< li class = "toctree-l2" > < a class = "reference internal" href = "nghttpx-howto.html#rewriting-location-header-field" > Rewriting location header field< / a > < / li >
2014-04-20 16:36:21 +02:00
< / ul >
< / li >
2014-06-26 17:06:44 +02:00
< li class = "toctree-l1" > < a class = "reference internal" href = "h2load-howto.html" > h2load - HTTP/2 benchmarking tool - HOW-TO< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "h2load-howto.html#basic-usage" > Basic Usage< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "h2load-howto.html#flow-control" > Flow Control< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "h2load-howto.html#multi-threading" > Multi-Threading< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "h2load-howto.html#selecting-protocol-for-clear-text" > Selecting protocol for clear text< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "h2load-howto.html#multiple-uris" > Multiple URIs< / a > < / li >
< / ul >
< / li >
2013-12-06 17:29:39 +01:00
< li class = "toctree-l1" > < a class = "reference internal" href = "apiref.html" > API Reference< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "apiref.html#includes" > Includes< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "apiref.html#remarks" > Remarks< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "apiref.html#macros" > Macros< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "apiref.html#enums" > Enums< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "apiref.html#types-structs-unions-and-typedefs" > Types (structs, unions and typedefs)< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "apiref.html#functions" > Functions< / a > < / li >
< / ul >
< / li >
2014-05-13 16:45:44 +02:00
< li class = "toctree-l1" > < a class = "reference internal" href = "python-apiref.html" > Python API Reference< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "python-apiref.html#hpack-api" > HPACK API< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "python-apiref.html#http-2-servers" > HTTP/2 servers< / a > < / li >
< / ul >
< / li >
2013-12-06 17:29:39 +01:00
< li class = "toctree-l1" > < a class = "reference internal" href = "nghttp2.h.html" > nghttp2.h< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "nghttp2ver.h.html" > nghttp2ver.h< / a > < / li >
2013-12-07 06:58:21 +01:00
< li class = "toctree-l1" > < a class = "reference external" href = "https://github.com/tatsuhiro-t/nghttp2" > Source< / a > < / li >
< li class = "toctree-l1" > < a class = "reference external" href = "https://github.com/tatsuhiro-t/nghttp2/issues" > Issues< / a > < / li >
2013-12-06 17:29:39 +01:00
< / ul >
< / div >
< / nav >
< section data-toggle = "wy-nav-shift" class = "wy-nav-content-wrap" >
2014-02-02 10:36:57 +01:00
< nav class = "wy-nav-top" role = "navigation" aria-label = "top navigation" >
< i data-toggle = "wy-nav-top" class = "fa fa-bars" > < / i >
2013-12-06 17:29:39 +01:00
< a href = "index.html" > nghttp2< / a >
< / nav >
< div class = "wy-nav-content" >
< div class = "rst-content" >
2014-02-02 10:36:57 +01:00
< div role = "navigation" aria-label = "breadcrumbs navigation" >
< ul class = "wy-breadcrumbs" >
< li > < a href = "index.html" > Docs< / a > » < / li >
2013-12-06 17:29:39 +01:00
2014-04-05 12:26:23 +02:00
< li > nghttp2 - HTTP/2 C Library< / li >
2014-02-02 10:36:57 +01:00
< li class = "wy-breadcrumbs-aside" >
< / li >
< / ul >
< hr / >
< / div >
< div role = "main" >
2014-04-05 12:26:23 +02:00
< div class = "section" id = "nghttp2-http-2-c-library" >
< h1 > nghttp2 - HTTP/2 C Library< a class = "headerlink" href = "#nghttp2-http-2-c-library" title = "Permalink to this headline" > ¶< / a > < / h1 >
2014-06-18 06:40:33 +02:00
< p > This is an implementation of Hypertext Transfer Protocol version 2
in C.< / p >
< p > The framing layer of HTTP/2 is implemented as form of reusable C
library. On top of that, we have implemented HTTP/2 client, server
and proxy. Also we have developed load test/benchmarking tool for
HTTP/2 and SPDY.< / p >
< p > HPACK encoding and decoding are available as public API.< / p >
2014-07-18 14:34:21 +02:00
< p > We have Python binding of this libary, but we have not covered
everything yet.< / p >
2013-07-28 14:26:41 +02:00
< div class = "section" id = "development-status" >
< h2 > Development Status< a class = "headerlink" href = "#development-status" title = "Permalink to this headline" > ¶< / a > < / h2 >
2014-08-01 13:56:52 +02:00
< p > We started to implement h2-14
(< a class = "reference external" href = "http://tools.ietf.org/html/draft-ietf-httpbis-http2-14" > http://tools.ietf.org/html/draft-ietf-httpbis-http2-14< / a > ), the header
compression
(< a class = "reference external" href = "http://tools.ietf.org/html/draft-ietf-httpbis-header-compression-09" > http://tools.ietf.org/html/draft-ietf-httpbis-header-compression-09< / a > )
and HTTP Alternative Services
(< a class = "reference external" href = "http://tools.ietf.org/html/draft-ietf-httpbis-alt-svc-02" > http://tools.ietf.org/html/draft-ietf-httpbis-alt-svc-02< / a > ).< / p >
2013-08-25 15:59:06 +02:00
< p > The nghttp2 code base was forked from spdylay project.< / p >
< table border = "1" class = "docutils" >
< colgroup >
2014-06-18 06:40:33 +02:00
< col width = "79%" / >
< col width = "21%" / >
2013-08-25 15:59:06 +02:00
< / colgroup >
< thead valign = "bottom" >
2014-06-18 06:40:33 +02:00
< tr class = "row-odd" > < th class = "head" > HTTP/2 Features< / th >
< th class = "head" > Support< / th >
2013-08-25 15:59:06 +02:00
< / tr >
< / thead >
< tbody valign = "top" >
2014-06-18 06:40:33 +02:00
< tr class = "row-even" > < td > Core frames handling< / td >
< td > Yes< / td >
2013-08-25 15:59:06 +02:00
< / tr >
2014-06-18 06:40:33 +02:00
< tr class = "row-odd" > < td > Dependency Tree< / td >
< td > Yes< / td >
2013-08-25 15:59:06 +02:00
< / tr >
2014-06-18 06:40:33 +02:00
< tr class = "row-even" > < td > Large header (CONTINUATION)< / td >
< td > Yes< / td >
< / tr >
2014-06-28 09:14:29 +02:00
< tr class = "row-odd" > < td > ALTSVC extension< / td >
2014-08-01 13:56:52 +02:00
< td > Yes< / td >
2014-06-18 06:40:33 +02:00
< / tr >
2013-08-25 15:59:06 +02:00
< / tbody >
< / table >
< / div >
< div class = "section" id = "public-test-server" >
< h2 > Public Test Server< a class = "headerlink" href = "#public-test-server" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > The following endpoints are available to try out nghttp2
2014-02-16 07:51:22 +01:00
implementation.< / p >
2013-08-25 15:59:06 +02:00
< ul >
2014-08-02 17:53:18 +02:00
< li > < p class = "first" > < a class = "reference external" href = "https://nghttp2.org/" > https://nghttp2.org/< / a > (TLS + ALPN/NPN)< / p >
< p > NPN offer < tt class = "docutils literal" > < span class = "pre" > h2-14< / span > < / tt > , < tt class = "docutils literal" > < span class = "pre" > spdy/3.1< / span > < / tt > and < tt class = "docutils literal" > < span class = "pre" > http/1.1< / span > < / tt > .< / p >
2014-06-18 06:40:33 +02:00
< p > This endpoint requires TLSv1.2 and DHE or EDCHE with GCM cipher
suite for HTTP/2 connection.< / p >
2013-08-25 15:59:06 +02:00
< / li >
2014-04-18 15:56:16 +02:00
< li > < p class = "first" > < a class = "reference external" href = "http://nghttp2.org/" > http://nghttp2.org/< / a > (Upgrade / Direct)< / p >
2014-06-18 06:40:33 +02:00
< p > < tt class = "docutils literal" > < span class = "pre" > h2c-13< / span > < / tt > and < tt class = "docutils literal" > < span class = "pre" > http/1.1< / span > < / tt > . We configured this server to send
2014-04-06 10:25:18 +02:00
ALTSVC frame or Alt-Svc header field to announce that alternative
service is available at port 443.< / p >
2013-08-25 15:59:06 +02:00
< / li >
2013-07-28 14:26:41 +02:00
< / ul >
< / div >
< div class = "section" id = "requirements" >
< h2 > Requirements< a class = "headerlink" href = "#requirements" title = "Permalink to this headline" > ¶< / a > < / h2 >
2014-05-06 16:23:33 +02:00
< p > The following package is required to build the libnghttp2 library:< / p >
2013-07-28 14:26:41 +02:00
< ul class = "simple" >
< li > pkg-config > = 0.20< / li >
< / ul >
2014-05-06 16:23:33 +02:00
< p > To build and run the unit test programs, the following package is
2013-07-28 14:26:41 +02:00
required:< / p >
< ul class = "simple" >
< li > cunit > = 2.1< / li >
< / ul >
2013-09-02 16:02:05 +02:00
< p > To build the documentation, you need to install:< / p >
< ul class = "simple" >
< li > sphinx (< a class = "reference external" href = "http://sphinx-doc.org/" > http://sphinx-doc.org/< / a > )< / li >
< / ul >
2013-07-28 14:26:41 +02:00
< p > To build and run the application programs (< tt class = "docutils literal" > < span class = "pre" > nghttp< / span > < / tt > , < tt class = "docutils literal" > < span class = "pre" > nghttpd< / span > < / tt > and
< tt class = "docutils literal" > < span class = "pre" > nghttpx< / span > < / tt > ) in < tt class = "docutils literal" > < span class = "pre" > src< / span > < / tt > directory, the following packages are
required:< / p >
< ul class = "simple" >
< li > OpenSSL > = 1.0.1< / li >
< li > libevent-openssl > = 2.0.8< / li >
2014-05-06 16:23:33 +02:00
< li > zlib > = 1.2.3< / li >
2013-07-28 14:26:41 +02:00
< / ul >
2014-01-02 05:33:27 +01:00
< p > ALPN support requires unreleased version OpenSSL > = 1.0.2.< / p >
2014-03-02 15:54:42 +01:00
< p > To enable SPDY protocol in the application program < tt class = "docutils literal" > < span class = "pre" > nghttpx< / span > < / tt > and
2014-05-06 16:23:33 +02:00
< tt class = "docutils literal" > < span class = "pre" > h2load< / span > < / tt > , the following package is required:< / p >
2013-07-28 14:26:41 +02:00
< ul class = "simple" >
2014-01-04 03:25:17 +01:00
< li > spdylay > = 1.2.3< / li >
2013-07-28 14:26:41 +02:00
< / ul >
< p > To enable < tt class = "docutils literal" > < span class = "pre" > -a< / span > < / tt > option (getting linked assets from the downloaded
2014-05-06 16:23:33 +02:00
resource) in < tt class = "docutils literal" > < span class = "pre" > nghttp< / span > < / tt > , the following package is required:< / p >
2013-07-28 14:26:41 +02:00
< ul class = "simple" >
< li > libxml2 > = 2.7.7< / li >
< / ul >
2014-01-10 17:07:30 +01:00
< p > The HPACK tools require the following package:< / p >
2013-10-28 15:32:57 +01:00
< ul class = "simple" >
2014-01-08 17:49:23 +01:00
< li > jansson > = 2.5< / li >
2013-10-28 15:32:57 +01:00
< / ul >
2014-03-05 16:20:32 +01:00
< p > To mitigate heap fragmentation in long running server programs
(< tt class = "docutils literal" > < span class = "pre" > nghttpd< / span > < / tt > and < tt class = "docutils literal" > < span class = "pre" > nghttpx< / span > < / tt > ), jemalloc is recommended:< / p >
< ul class = "simple" >
< li > jemalloc< / li >
< / ul >
2014-01-10 17:07:30 +01:00
< p > The Python bindings require the following packages:< / p >
< ul class = "simple" >
< li > cython > = 0.19< / li >
< li > python > = 2.7< / li >
< / ul >
2014-05-14 17:22:42 +02:00
< p > If you are using Ubuntu 14.04 LTS, you need the following packages
2013-07-28 14:26:41 +02:00
installed:< / p >
< ul class = "simple" >
< li > autoconf< / li >
< li > automake< / li >
< li > autotools-dev< / li >
< li > libtool< / li >
< li > pkg-config< / li >
< li > zlib1g-dev< / li >
< li > libcunit1-dev< / li >
< li > libssl-dev< / li >
< li > libxml2-dev< / li >
< li > libevent-dev< / li >
2013-10-28 15:32:57 +01:00
< li > libjansson-dev< / li >
2014-03-05 16:20:32 +01:00
< li > libjemalloc-dev< / li >
2014-05-14 17:22:42 +02:00
< li > cython< / li >
< li > python3.4-dev< / li >
2013-07-28 14:26:41 +02:00
< / ul >
< p > spdylay is not packaged in Ubuntu, so you need to build it yourself:
2013-11-21 14:06:29 +01:00
< a class = "reference external" href = "http://tatsuhiro-t.github.io/spdylay/" > http://tatsuhiro-t.github.io/spdylay/< / a > < / p >
2013-07-28 14:26:41 +02:00
< / div >
< div class = "section" id = "build-from-git" >
< h2 > Build from git< a class = "headerlink" href = "#build-from-git" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > Building from git is easy, but please be sure that at least autoconf 2.68 is
used:< / p >
2014-02-24 17:49:22 +01:00
< div class = "highlight-c" > < div class = "highlight" > < pre > $ autoreconf -i
2013-07-28 14:26:41 +02:00
$ automake
$ autoconf
$ ./configure
2014-02-24 17:49:22 +01:00
$ make
< / pre > < / div >
2013-07-28 14:26:41 +02:00
< / div >
2014-07-18 14:34:21 +02:00
< p > To compile source code, gcc > = 4.8.3 or clang > = 3.4 is required.< / p >
2014-05-31 15:02:44 +02:00
< div class = "admonition note" >
< p class = "first admonition-title" > Note< / p >
< p class = "last" > Mac OS X users may need < tt class = "docutils literal" > < span class = "pre" > --disable-threads< / span > < / tt > configure option to
disable multi threading in nghttpd, nghttpx and h2load to prevent
them from crashing. Patch is welcome to make multi threading work
on Mac OS X platform.< / p >
< / div >
2013-07-28 14:26:41 +02:00
< / div >
< div class = "section" id = "building-documentation" >
< h2 > Building documentation< a class = "headerlink" href = "#building-documentation" title = "Permalink to this headline" > ¶< / a > < / h2 >
< div class = "admonition note" >
< p class = "first admonition-title" > Note< / p >
< p class = "last" > Documentation is still incomplete.< / p >
< / div >
< p > To build documentation, run:< / p >
2014-02-24 17:49:22 +01:00
< div class = "highlight-c" > < div class = "highlight" > < pre > $ make html
< / pre > < / div >
2013-07-28 14:26:41 +02:00
< / div >
< p > The documents will be generated under < tt class = "docutils literal" > < span class = "pre" > doc/manual/html/< / span > < / tt > .< / p >
< p > The generated documents will not be installed with < tt class = "docutils literal" > < span class = "pre" > make< / span > < span class = "pre" > install< / span > < / tt > .< / p >
2013-08-03 13:03:39 +02:00
< p > The online documentation is available at
2014-05-14 17:22:42 +02:00
< a class = "reference external" href = "https://nghttp2.org/documentation/" > https://nghttp2.org/documentation/< / a > < / p >
2013-07-28 14:26:41 +02:00
< / div >
< div class = "section" id = "client-server-and-proxy-programs" >
< h2 > Client, Server and Proxy programs< a class = "headerlink" href = "#client-server-and-proxy-programs" title = "Permalink to this headline" > ¶< / a > < / h2 >
2014-04-05 12:26:23 +02:00
< p > The src directory contains HTTP/2 client, server and proxy programs.< / p >
2013-07-28 14:26:41 +02:00
< div class = "section" id = "nghttp-client" >
< h3 > nghttp - client< a class = "headerlink" href = "#nghttp-client" title = "Permalink to this headline" > ¶< / a > < / h3 >
2014-04-08 17:17:05 +02:00
< p > < tt class = "docutils literal" > < span class = "pre" > nghttp< / span > < / tt > is a HTTP/2 client. It can connect to the HTTP/2 server
2014-01-01 17:03:29 +01:00
with prior knowledge, HTTP Upgrade and NPN/ALPN TLS extension.< / p >
2014-04-08 17:17:05 +02:00
< p > It has verbose output mode for framing information. Here is sample
2013-07-28 14:26:41 +02:00
output from < tt class = "docutils literal" > < span class = "pre" > nghttp< / span > < / tt > client:< / p >
2014-05-14 17:22:42 +02:00
< div class = "highlight-c" > < div class = "highlight" > < pre > $ src/nghttp -nv https://nghttp2.org
[ 0.033][NPN] server offers:
2014-08-01 13:56:52 +02:00
* h2-14
2014-02-16 07:51:22 +01:00
* spdy/3.1
2013-07-28 14:26:41 +02:00
* http/1.1
2014-08-01 13:56:52 +02:00
The negotiated protocol: h2-14
2014-05-14 17:22:42 +02:00
[ 0.068] send SETTINGS frame < length=15, flags=0x00, stream_id=0>
(niv=3)
2014-02-16 07:51:22 +01:00
[SETTINGS_MAX_CONCURRENT_STREAMS(3):100]
[SETTINGS_INITIAL_WINDOW_SIZE(4):65535]
2014-05-14 17:22:42 +02:00
[SETTINGS_COMPRESS_DATA(5):1]
[ 0.068] send HEADERS frame < length=46, flags=0x05, stream_id=1>
2013-07-28 14:26:41 +02:00
; END_STREAM | END_HEADERS
2014-02-16 07:51:22 +01:00
(padlen=0)
2013-07-28 14:26:41 +02:00
; Open new stream
2014-05-14 17:22:42 +02:00
:authority: nghttp2.org
2013-07-28 14:26:41 +02:00
:method: GET
:path: /
:scheme: https
accept: */*
accept-encoding: gzip, deflate
2014-02-16 07:51:22 +01:00
user-agent: nghttp2/0.4.0-DEV
2014-05-14 17:22:42 +02:00
[ 0.068] recv SETTINGS frame < length=10, flags=0x00, stream_id=0>
(niv=2)
2014-02-16 07:51:22 +01:00
[SETTINGS_MAX_CONCURRENT_STREAMS(3):100]
[SETTINGS_INITIAL_WINDOW_SIZE(4):65535]
2014-05-14 17:22:42 +02:00
[ 0.068] send SETTINGS frame < length=0, flags=0x01, stream_id=0>
2013-10-28 15:32:57 +01:00
; ACK
(niv=0)
2014-05-14 17:22:42 +02:00
[ 0.079] recv SETTINGS frame < length=0, flags=0x01, stream_id=0>
2013-10-28 15:32:57 +01:00
; ACK
(niv=0)
2014-05-14 17:22:42 +02:00
[ 0.080] (stream_id=1, noind=0) :status: 200
[ 0.080] (stream_id=1, noind=0) accept-ranges: bytes
[ 0.080] (stream_id=1, noind=0) age: 15
[ 0.080] (stream_id=1, noind=0) content-length: 40243
[ 0.080] (stream_id=1, noind=0) content-type: text/html
[ 0.080] (stream_id=1, noind=0) date: Wed, 14 May 2014 15:14:30 GMT
[ 0.080] (stream_id=1, noind=0) etag: " 535d0eea-9d33"
[ 0.080] (stream_id=1, noind=0) last-modified: Sun, 27 Apr 2014 14:06:34 GMT
[ 0.080] (stream_id=1, noind=0) server: nginx/1.4.6 (Ubuntu)
[ 0.080] (stream_id=1, noind=0) x-varnish: 2114900538 2114900537
[ 0.080] (stream_id=1, noind=0) via: 1.1 varnish, 1.1 nghttpx
[ 0.080] (stream_id=1, noind=0) strict-transport-security: max-age=31536000
[ 0.080] recv HEADERS frame < length=162, flags=0x04, stream_id=1>
2013-07-28 14:26:41 +02:00
; END_HEADERS
2014-02-16 07:51:22 +01:00
(padlen=0)
2013-07-28 14:26:41 +02:00
; First response header
2014-05-14 17:22:42 +02:00
[ 0.080] recv DATA frame < length=3786, flags=0x00, stream_id=1>
[ 0.080] recv DATA frame < length=4096, flags=0x00, stream_id=1>
[ 0.081] recv DATA frame < length=4096, flags=0x00, stream_id=1>
[ 0.093] recv DATA frame < length=4096, flags=0x00, stream_id=1>
[ 0.093] recv DATA frame < length=4096, flags=0x00, stream_id=1>
[ 0.094] recv DATA frame < length=4096, flags=0x00, stream_id=1>
[ 0.094] recv DATA frame < length=4096, flags=0x00, stream_id=1>
[ 0.094] recv DATA frame < length=4096, flags=0x00, stream_id=1>
[ 0.096] recv DATA frame < length=4096, flags=0x00, stream_id=1>
[ 0.096] send WINDOW_UPDATE frame < length=4, flags=0x00, stream_id=0>
(window_size_increment=36554)
[ 0.096] send WINDOW_UPDATE frame < length=4, flags=0x00, stream_id=1>
(window_size_increment=36554)
[ 0.108] recv DATA frame < length=3689, flags=0x00, stream_id=1>
[ 0.108] recv DATA frame < length=0, flags=0x01, stream_id=1>
2013-08-25 15:59:06 +02:00
; END_STREAM
2014-05-14 17:22:42 +02:00
[ 0.108] send GOAWAY frame < length=8, flags=0x00, stream_id=0>
2014-02-24 17:49:22 +01:00
(last_stream_id=0, error_code=NO_ERROR(0), opaque_data(0)=[])
< / pre > < / div >
2013-07-28 14:26:41 +02:00
< / div >
2013-08-03 13:03:39 +02:00
< p > The HTTP Upgrade is performed like this:< / p >
2014-05-14 17:22:42 +02:00
< div class = "highlight-c" > < div class = "highlight" > < pre > $ src/nghttp -nvu http://nghttp2.org
[ 0.013] HTTP Upgrade request
2013-08-03 13:03:39 +02:00
GET / HTTP/1.1
2014-05-14 17:22:42 +02:00
Host: nghttp2.org
2013-08-03 13:03:39 +02:00
Connection: Upgrade, HTTP2-Settings
2014-06-18 06:40:33 +02:00
Upgrade: h2c-13
2014-05-14 17:22:42 +02:00
HTTP2-Settings: AwAAAGQEAAD__wUAAAAB
2013-08-03 13:03:39 +02:00
Accept: */*
2014-02-16 07:51:22 +01:00
User-Agent: nghttp2/0.4.0-DEV
2013-08-03 13:03:39 +02:00
2014-05-14 17:22:42 +02:00
[ 0.024] HTTP Upgrade response
2013-08-03 13:03:39 +02:00
HTTP/1.1 101 Switching Protocols
Connection: Upgrade
2014-06-18 06:40:33 +02:00
Upgrade: h2c-13
2013-08-03 13:03:39 +02:00
2014-05-14 17:22:42 +02:00
[ 0.024] HTTP Upgrade success
[ 0.024] send SETTINGS frame < length=15, flags=0x00, stream_id=0>
(niv=3)
2014-02-16 07:51:22 +01:00
[SETTINGS_MAX_CONCURRENT_STREAMS(3):100]
[SETTINGS_INITIAL_WINDOW_SIZE(4):65535]
2014-05-14 17:22:42 +02:00
[SETTINGS_COMPRESS_DATA(5):1]
[ 0.024] recv SETTINGS frame < length=10, flags=0x00, stream_id=0>
(niv=2)
2014-02-16 07:51:22 +01:00
[SETTINGS_MAX_CONCURRENT_STREAMS(3):100]
[SETTINGS_INITIAL_WINDOW_SIZE(4):65535]
2014-05-14 17:22:42 +02:00
[ 0.024] recv ALTSVC frame < length=43, flags=0x00, stream_id=0>
2014-08-01 13:56:52 +02:00
(max-age=86400, port=443, protocol_id=h2-14, host=nghttp2.org, origin=http://nghttp2.org)
2014-05-14 17:22:42 +02:00
[ 0.024] send SETTINGS frame < length=0, flags=0x01, stream_id=0>
; ACK
(niv=0)
[ 0.024] (stream_id=1, noind=0) :status: 200
[ 0.024] (stream_id=1, noind=0) accept-ranges: bytes
[ 0.024] (stream_id=1, noind=0) age: 10
[ 0.024] (stream_id=1, noind=0) content-length: 40243
[ 0.024] (stream_id=1, noind=0) content-type: text/html
[ 0.024] (stream_id=1, noind=0) date: Wed, 14 May 2014 15:16:34 GMT
[ 0.024] (stream_id=1, noind=0) etag: " 535d0eea-9d33"
[ 0.024] (stream_id=1, noind=0) last-modified: Sun, 27 Apr 2014 14:06:34 GMT
[ 0.024] (stream_id=1, noind=0) server: nginx/1.4.6 (Ubuntu)
[ 0.024] (stream_id=1, noind=0) x-varnish: 2114900541 2114900540
[ 0.024] (stream_id=1, noind=0) via: 1.1 varnish, 1.1 nghttpx
[ 0.024] recv HEADERS frame < length=148, flags=0x04, stream_id=1>
2013-08-03 13:03:39 +02:00
; END_HEADERS
2014-02-16 07:51:22 +01:00
(padlen=0)
2013-08-03 13:03:39 +02:00
; First response header
2014-05-14 17:22:42 +02:00
[ 0.024] recv DATA frame < length=3786, flags=0x00, stream_id=1>
[ 0.025] recv DATA frame < length=4096, flags=0x00, stream_id=1>
[ 0.031] recv DATA frame < length=4096, flags=0x00, stream_id=1>
[ 0.031] recv DATA frame < length=4096, flags=0x00, stream_id=1>
[ 0.032] recv DATA frame < length=4096, flags=0x00, stream_id=1>
[ 0.032] recv DATA frame < length=4096, flags=0x00, stream_id=1>
[ 0.033] recv DATA frame < length=4096, flags=0x00, stream_id=1>
[ 0.033] recv DATA frame < length=4096, flags=0x00, stream_id=1>
[ 0.033] send WINDOW_UPDATE frame < length=4, flags=0x00, stream_id=0>
(window_size_increment=33164)
[ 0.033] send WINDOW_UPDATE frame < length=4, flags=0x00, stream_id=1>
(window_size_increment=33164)
[ 0.038] recv DATA frame < length=4096, flags=0x00, stream_id=1>
[ 0.038] recv DATA frame < length=3689, flags=0x00, stream_id=1>
[ 0.038] recv DATA frame < length=0, flags=0x01, stream_id=1>
2013-08-25 15:59:06 +02:00
; END_STREAM
2014-05-14 17:22:42 +02:00
[ 0.038] recv SETTINGS frame < length=0, flags=0x01, stream_id=0>
2013-10-28 15:32:57 +01:00
; ACK
(niv=0)
2014-05-14 17:22:42 +02:00
[ 0.038] send GOAWAY frame < length=8, flags=0x00, stream_id=0>
2013-10-28 15:32:57 +01:00
(last_stream_id=0, error_code=NO_ERROR(0), opaque_data(0)=[])
2014-02-24 17:49:22 +01:00
< / pre > < / div >
2013-08-03 13:03:39 +02:00
< / div >
2013-07-28 14:26:41 +02:00
< / div >
< div class = "section" id = "nghttpd-server" >
< h3 > nghttpd - server< a class = "headerlink" href = "#nghttpd-server" title = "Permalink to this headline" > ¶< / a > < / h3 >
2014-03-04 15:36:05 +01:00
< p > < tt class = "docutils literal" > < span class = "pre" > nghttpd< / span > < / tt > is a multi-threaded static web server.< / p >
2014-04-08 17:17:05 +02:00
< p > By default, it uses SSL/TLS connection. Use < tt class = "docutils literal" > < span class = "pre" > --no-tls< / span > < / tt > option to
2013-07-28 14:26:41 +02:00
disable it.< / p >
2014-04-05 12:26:23 +02:00
< p > < tt class = "docutils literal" > < span class = "pre" > nghttpd< / span > < / tt > only accepts the HTTP/2 connection via NPN/ALPN or direct
2014-04-08 17:17:05 +02:00
HTTP/2 connection. No HTTP Upgrade is supported.< / p >
2013-12-08 16:07:37 +01:00
< p > < tt class = "docutils literal" > < span class = "pre" > -p< / span > < / tt > option allows users to configure server push.< / p >
2013-07-28 14:26:41 +02:00
< p > Just like < tt class = "docutils literal" > < span class = "pre" > nghttp< / span > < / tt > , it has verbose output mode for framing
2014-04-08 17:17:05 +02:00
information. Here is sample output from < tt class = "docutils literal" > < span class = "pre" > nghttpd< / span > < / tt > server:< / p >
2014-02-24 17:49:22 +01:00
< div class = "highlight-c" > < div class = "highlight" > < pre > $ src/nghttpd --no-tls -v 8080
2013-08-25 15:59:06 +02:00
IPv4: listen on port 8080
IPv6: listen on port 8080
2014-05-14 17:22:42 +02:00
[id=1] [ 15.921] send SETTINGS frame < length=10, flags=0x00, stream_id=0>
2014-02-16 07:51:22 +01:00
(niv=2)
[SETTINGS_MAX_CONCURRENT_STREAMS(3):100]
2014-05-14 17:22:42 +02:00
[SETTINGS_COMPRESS_DATA(5):1]
[id=1] [ 15.921] recv SETTINGS frame < length=15, flags=0x00, stream_id=0>
(niv=3)
2014-02-16 07:51:22 +01:00
[SETTINGS_MAX_CONCURRENT_STREAMS(3):100]
[SETTINGS_INITIAL_WINDOW_SIZE(4):65535]
2014-05-14 17:22:42 +02:00
[SETTINGS_COMPRESS_DATA(5):1]
[id=1] [ 15.921] (stream_id=1, noind=0) :authority: localhost:8080
[id=1] [ 15.921] (stream_id=1, noind=0) :method: GET
[id=1] [ 15.921] (stream_id=1, noind=0) :path: /
[id=1] [ 15.921] (stream_id=1, noind=0) :scheme: http
[id=1] [ 15.921] (stream_id=1, noind=0) accept: */*
[id=1] [ 15.921] (stream_id=1, noind=0) accept-encoding: gzip, deflate
[id=1] [ 15.921] (stream_id=1, noind=0) user-agent: nghttp2/0.4.0-DEV
[id=1] [ 15.921] recv HEADERS frame < length=48, flags=0x05, stream_id=1>
2013-07-28 14:26:41 +02:00
; END_STREAM | END_HEADERS
2014-02-16 07:51:22 +01:00
(padlen=0)
2013-07-28 14:26:41 +02:00
; Open new stream
2014-05-14 17:22:42 +02:00
[id=1] [ 15.921] recv SETTINGS frame < length=0, flags=0x01, stream_id=0>
2013-10-28 15:32:57 +01:00
; ACK
(niv=0)
2014-05-14 17:22:42 +02:00
[id=1] [ 15.921] send SETTINGS frame < length=0, flags=0x01, stream_id=0>
; ACK
(niv=0)
[id=1] [ 15.921] send HEADERS frame < length=82, flags=0x04, stream_id=1>
2013-07-28 14:26:41 +02:00
; END_HEADERS
2014-02-16 07:51:22 +01:00
(padlen=0)
2013-07-28 14:26:41 +02:00
; First response header
2014-05-14 17:22:42 +02:00
:status: 200
cache-control: max-age=3600
content-length: 612
date: Wed, 14 May 2014 15:19:03 GMT
last-modified: Sat, 08 Mar 2014 16:04:06 GMT
2014-02-16 07:51:22 +01:00
server: nghttpd nghttp2/0.4.0-DEV
2014-05-14 17:22:42 +02:00
[id=1] [ 15.922] send DATA frame < length=381, flags=0x20, stream_id=1>
; COMPRESSED
[id=1] [ 15.922] send DATA frame < length=0, flags=0x01, stream_id=1>
2013-08-25 15:59:06 +02:00
; END_STREAM
2014-05-14 17:22:42 +02:00
[id=1] [ 15.922] stream_id=1 closed
[id=1] [ 15.922] recv GOAWAY frame < length=8, flags=0x00, stream_id=0>
2013-08-25 15:59:06 +02:00
(last_stream_id=0, error_code=NO_ERROR(0), opaque_data(0)=[])
2014-05-14 17:22:42 +02:00
[id=1] [ 15.922] closed
2014-02-24 17:49:22 +01:00
< / pre > < / div >
2013-07-28 14:26:41 +02:00
< / div >
< / div >
< div class = "section" id = "nghttpx-proxy" >
< h3 > nghttpx - proxy< a class = "headerlink" href = "#nghttpx-proxy" title = "Permalink to this headline" > ¶< / a > < / h3 >
2014-08-01 13:56:52 +02:00
< p > < tt class = "docutils literal" > < span class = "pre" > nghttpx< / span > < / tt > is a multi-threaded reverse proxy for < tt class = "docutils literal" > < span class = "pre" > h2-14< / span > < / tt > , SPDY and
2014-06-18 06:40:33 +02:00
HTTP/1.1 and powers nghttp2.org site. It has several operation modes:< / p >
2013-07-28 14:26:41 +02:00
< table border = "1" class = "docutils" >
< colgroup >
2014-04-05 12:26:23 +02:00
< col width = "25%" / >
< col width = "38%" / >
2013-08-03 13:03:39 +02:00
< col width = "19%" / >
2014-04-05 12:26:23 +02:00
< col width = "18%" / >
2013-07-28 14:26:41 +02:00
< / colgroup >
< thead valign = "bottom" >
< tr class = "row-odd" > < th class = "head" > Mode option< / th >
< th class = "head" > Frontend< / th >
< th class = "head" > Backend< / th >
< th class = "head" > Note< / th >
< / tr >
< / thead >
< tbody valign = "top" >
2013-08-03 13:03:39 +02:00
< tr class = "row-even" > < td > default mode< / td >
2014-04-05 12:26:23 +02:00
< td > HTTP/2, SPDY, HTTP/1.1 (TLS)< / td >
2013-07-28 14:26:41 +02:00
< td > HTTP/1.1< / td >
< td > Reverse proxy< / td >
< / tr >
2013-11-04 10:27:48 +01:00
< tr class = "row-odd" > < td > < tt class = "docutils literal" > < span class = "pre" > --http2-proxy< / span > < / tt > < / td >
2014-04-05 12:26:23 +02:00
< td > HTTP/2, SPDY, HTTP/1.1 (TLS)< / td >
2013-07-28 14:26:41 +02:00
< td > HTTP/1.1< / td >
< td > SPDY proxy< / td >
< / tr >
2013-11-04 10:27:48 +01:00
< tr class = "row-even" > < td > < tt class = "docutils literal" > < span class = "pre" > --http2-bridge< / span > < / tt > < / td >
2014-04-05 12:26:23 +02:00
< td > HTTP/2, SPDY, HTTP/1.1 (TLS)< / td >
< td > HTTP/2 (TLS)< / td >
2013-08-03 13:03:39 +02:00
< td > < / td >
2013-07-28 14:26:41 +02:00
< / tr >
< tr class = "row-odd" > < td > < tt class = "docutils literal" > < span class = "pre" > --client< / span > < / tt > < / td >
2014-04-05 12:26:23 +02:00
< td > HTTP/2, HTTP/1.1< / td >
< td > HTTP/2 (TLS)< / td >
2013-08-03 13:03:39 +02:00
< td > < / td >
2013-07-28 14:26:41 +02:00
< / tr >
< tr class = "row-even" > < td > < tt class = "docutils literal" > < span class = "pre" > --client-proxy< / span > < / tt > < / td >
2014-04-05 12:26:23 +02:00
< td > HTTP/2, HTTP/1.1< / td >
< td > HTTP/2 (TLS)< / td >
2013-07-28 14:26:41 +02:00
< td > Forward proxy< / td >
< / tr >
< / tbody >
< / table >
2014-04-08 17:17:05 +02:00
< p > The interesting mode at the moment is the default mode. It works like
2014-08-01 13:56:52 +02:00
a reverse proxy and listens for < tt class = "docutils literal" > < span class = "pre" > h2-14< / span > < / tt > , SPDY and HTTP/1.1 and can
2014-04-05 12:26:23 +02:00
be deployed SSL/TLS terminator for existing web server.< / p >
2013-11-04 10:27:48 +01:00
< p > The default mode, < tt class = "docutils literal" > < span class = "pre" > --http2-proxy< / span > < / tt > and < tt class = "docutils literal" > < span class = "pre" > --http2-bridge< / span > < / tt > modes use
2014-04-08 17:17:05 +02:00
SSL/TLS in the frontend connection by default. To disable SSL/TLS,
use < tt class = "docutils literal" > < span class = "pre" > --frontend-no-tls< / span > < / tt > option. If that option is used, SPDY is
disabled in the frontend and incoming HTTP/1.1 connection can be
upgraded to HTTP/2 through HTTP Upgrade.< / p >
2013-11-04 10:27:48 +01:00
< p > The < tt class = "docutils literal" > < span class = "pre" > --http2-bridge< / span > < / tt > , < tt class = "docutils literal" > < span class = "pre" > --client< / span > < / tt > and < tt class = "docutils literal" > < span class = "pre" > --client-proxy< / span > < / tt > modes use
2014-04-08 17:17:05 +02:00
SSL/TLS in the backend connection by deafult. To disable SSL/TLS, use
2013-08-03 13:03:39 +02:00
< tt class = "docutils literal" > < span class = "pre" > --backend-no-tls< / span > < / tt > option.< / p >
2014-04-08 17:17:05 +02:00
< p > < tt class = "docutils literal" > < span class = "pre" > nghttpx< / span > < / tt > supports configuration file. See < tt class = "docutils literal" > < span class = "pre" > --conf< / span > < / tt > option and
2013-07-28 14:26:41 +02:00
sample configuration file < tt class = "docutils literal" > < span class = "pre" > nghttpx.conf.sample< / span > < / tt > .< / p >
2014-03-03 17:17:25 +01:00
< p > < tt class = "docutils literal" > < span class = "pre" > nghttpx< / span > < / tt > does not support server push.< / p >
2013-11-04 10:27:48 +01:00
< p > In the default mode, (without any of < tt class = "docutils literal" > < span class = "pre" > --http2-proxy< / span > < / tt > ,
< tt class = "docutils literal" > < span class = "pre" > --http2-bridge< / span > < / tt > , < tt class = "docutils literal" > < span class = "pre" > --client-proxy< / span > < / tt > and < tt class = "docutils literal" > < span class = "pre" > --client< / span > < / tt > options),
< tt class = "docutils literal" > < span class = "pre" > nghttpx< / span > < / tt > works as reverse proxy to the backend server:< / p >
2014-04-05 12:26:23 +02:00
< div class = "highlight-c" > < div class = "highlight" > < pre > < span class = "n" > Client< / span > < span class = "o" > < --< / span > < span class = "p" > (< / span > < span class = "n" > HTTP< / span > < span class = "o" > /< / span > < span class = "mi" > 2< / span > < span class = "p" > ,< / span > < span class = "n" > SPDY< / span > < span class = "p" > ,< / span > < span class = "n" > HTTP< / span > < span class = "o" > /< / span > < span class = "mf" > 1.1< / span > < span class = "p" > )< / span > < span class = "o" > --> < / span > < span class = "n" > nghttpx< / span > < span class = "o" > < --< / span > < span class = "p" > (< / span > < span class = "n" > HTTP< / span > < span class = "o" > /< / span > < span class = "mf" > 1.1< / span > < span class = "p" > )< / span > < span class = "o" > --> < / span > < span class = "n" > Web< / span > < span class = "n" > Server< / span >
2013-08-03 13:03:39 +02:00
< span class = "p" > [< / span > < span class = "n" > reverse< / span > < span class = "n" > proxy< / span > < span class = "p" > ]< / span >
2013-07-28 14:26:41 +02:00
< / pre > < / div >
< / div >
2013-11-04 10:27:48 +01:00
< p > With < tt class = "docutils literal" > < span class = "pre" > --http2-proxy< / span > < / tt > option, it works as so called secure proxy (aka
SPDY proxy):< / p >
2014-04-05 12:26:23 +02:00
< div class = "highlight-c" > < div class = "highlight" > < pre > < span class = "n" > Client< / span > < span class = "o" > < --< / span > < span class = "p" > (< / span > < span class = "n" > HTTP< / span > < span class = "o" > /< / span > < span class = "mi" > 2< / span > < span class = "p" > ,< / span > < span class = "n" > SPDY< / span > < span class = "p" > ,< / span > < span class = "n" > HTTP< / span > < span class = "o" > /< / span > < span class = "mf" > 1.1< / span > < span class = "p" > )< / span > < span class = "o" > --> < / span > < span class = "n" > nghttpx< / span > < span class = "o" > < --< / span > < span class = "p" > (< / span > < span class = "n" > HTTP< / span > < span class = "o" > /< / span > < span class = "mf" > 1.1< / span > < span class = "p" > )< / span > < span class = "o" > --> < / span > < span class = "n" > Proxy< / span >
2014-06-28 09:14:29 +02:00
< span class = "p" > [< / span > < span class = "n" > secure< / span > < span class = "n" > proxy< / span > < span class = "p" > ]< / span > < span class = "p" > (< / span > < span class = "n" > e< / span > < span class = "p" > .< / span > < span class = "n" > g< / span > < span class = "p" > .,< / span > < span class = "n" > Squid< / span > < span class = "p" > ,< / span > < span class = "n" > ATS< / span > < span class = "p" > )< / span >
2013-07-28 14:26:41 +02:00
< / pre > < / div >
< / div >
2013-08-03 13:03:39 +02:00
< p > The < tt class = "docutils literal" > < span class = "pre" > Client< / span > < / tt > in the above is needs to be configured to use
< tt class = "docutils literal" > < span class = "pre" > nghttpx< / span > < / tt > as secure proxy.< / p >
2013-07-28 14:26:41 +02:00
< p > At the time of this writing, Chrome is the only browser which supports
2014-04-08 17:17:05 +02:00
secure proxy. The one way to configure Chrome to use secure proxy is
2013-08-03 13:03:39 +02:00
create proxy.pac script like this:< / p >
2014-01-11 09:13:44 +01:00
< div class = "highlight-javascript" > < div class = "highlight" > < pre > < span class = "kd" > function< / span > < span class = "nx" > FindProxyForURL< / span > < span class = "p" > (< / span > < span class = "nx" > url< / span > < span class = "p" > ,< / span > < span class = "nx" > host< / span > < span class = "p" > )< / span > < span class = "p" > {< / span >
< span class = "k" > return< / span > < span class = "s2" > " HTTPS SERVERADDR:PORT" < / span > < span class = "p" > ;< / span >
2013-07-28 14:26:41 +02:00
< span class = "p" > }< / span >
< / pre > < / div >
< / div >
< p > < tt class = "docutils literal" > < span class = "pre" > SERVERADDR< / span > < / tt > and < tt class = "docutils literal" > < span class = "pre" > PORT< / span > < / tt > is the hostname/address and port of the
machine nghttpx is running. Please note that Chrome requires valid
2013-08-03 13:03:39 +02:00
certificate for secure proxy.< / p >
2014-03-03 17:17:25 +01:00
< p > Then run Chrome with the following arguments:< / p >
2014-02-24 17:49:22 +01:00
< div class = "highlight-c" > < div class = "highlight" > < pre > $ google-chrome --proxy-pac-url=file:///path/to/proxy.pac --use-npn
< / pre > < / div >
2013-07-28 14:26:41 +02:00
< / div >
2014-04-05 12:26:23 +02:00
< p > With < tt class = "docutils literal" > < span class = "pre" > --http2-bridge< / span > < / tt > , it accepts HTTP/2, SPDY and HTTP/1.1
connections and communicates with backend in HTTP/2:< / p >
< div class = "highlight-c" > < div class = "highlight" > < pre > < span class = "n" > Client< / span > < span class = "o" > < --< / span > < span class = "p" > (< / span > < span class = "n" > HTTP< / span > < span class = "o" > /< / span > < span class = "mi" > 2< / span > < span class = "p" > ,< / span > < span class = "n" > SPDY< / span > < span class = "p" > ,< / span > < span class = "n" > HTTP< / span > < span class = "o" > /< / span > < span class = "mf" > 1.1< / span > < span class = "p" > )< / span > < span class = "o" > --> < / span > < span class = "n" > nghttpx< / span > < span class = "o" > < --< / span > < span class = "p" > (< / span > < span class = "n" > HTTP< / span > < span class = "o" > /< / span > < span class = "mi" > 2< / span > < span class = "p" > )< / span > < span class = "o" > --> < / span > < span class = "n" > Web< / span > < span class = "n" > or< / span > < span class = "n" > HTTP< / span > < span class = "o" > /< / span > < span class = "mi" > 2< / span > < span class = "n" > Proxy< / span > < span class = "n" > etc< / span >
2013-08-03 13:03:39 +02:00
< span class = "p" > (< / span > < span class = "n" > e< / span > < span class = "p" > .< / span > < span class = "n" > g< / span > < span class = "p" > .,< / span > < span class = "n" > nghttpx< / span > < span class = "o" > -< / span > < span class = "n" > s< / span > < span class = "p" > )< / span >
2013-07-28 14:26:41 +02:00
< / pre > < / div >
< / div >
2013-08-03 13:03:39 +02:00
< p > With < tt class = "docutils literal" > < span class = "pre" > --client-proxy< / span > < / tt > option, it works as forward proxy and expects
2014-04-05 12:26:23 +02:00
that the backend is HTTP/2 proxy:< / p >
< div class = "highlight-c" > < div class = "highlight" > < pre > < span class = "n" > Client< / span > < span class = "o" > < --< / span > < span class = "p" > (< / span > < span class = "n" > HTTP< / span > < span class = "o" > /< / span > < span class = "mi" > 2< / span > < span class = "p" > ,< / span > < span class = "n" > HTTP< / span > < span class = "o" > /< / span > < span class = "mf" > 1.1< / span > < span class = "p" > )< / span > < span class = "o" > --> < / span > < span class = "n" > nghttpx< / span > < span class = "o" > < --< / span > < span class = "p" > (< / span > < span class = "n" > HTTP< / span > < span class = "o" > /< / span > < span class = "mi" > 2< / span > < span class = "p" > )< / span > < span class = "o" > --> < / span > < span class = "n" > HTTP< / span > < span class = "o" > /< / span > < span class = "mi" > 2< / span > < span class = "n" > Proxy< / span >
2013-08-03 13:03:39 +02:00
< span class = "p" > [< / span > < span class = "n" > forward< / span > < span class = "n" > proxy< / span > < span class = "p" > ]< / span > < span class = "p" > (< / span > < span class = "n" > e< / span > < span class = "p" > .< / span > < span class = "n" > g< / span > < span class = "p" > .,< / span > < span class = "n" > nghttpx< / span > < span class = "o" > -< / span > < span class = "n" > s< / span > < span class = "p" > )< / span >
2013-07-28 14:26:41 +02:00
< / pre > < / div >
< / div >
2014-03-03 17:17:25 +01:00
< p > The < tt class = "docutils literal" > < span class = "pre" > Client< / span > < / tt > needs to be configured to use nghttpx as forward
2014-04-05 12:26:23 +02:00
proxy. The frontend HTTP/1.1 connection can be upgraded to HTTP/2
2013-08-03 13:03:39 +02:00
through HTTP Upgrade. With the above configuration, one can use
2014-04-05 12:26:23 +02:00
HTTP/1.1 client to access and test their HTTP/2 servers.< / p >
2013-07-28 14:26:41 +02:00
< p > With < tt class = "docutils literal" > < span class = "pre" > --client< / span > < / tt > option, it works as reverse proxy and expects that
2014-04-05 12:26:23 +02:00
the backend is HTTP/2 Web server:< / p >
< div class = "highlight-c" > < div class = "highlight" > < pre > < span class = "n" > Client< / span > < span class = "o" > < --< / span > < span class = "p" > (< / span > < span class = "n" > HTTP< / span > < span class = "o" > /< / span > < span class = "mi" > 2< / span > < span class = "p" > ,< / span > < span class = "n" > HTTP< / span > < span class = "o" > /< / span > < span class = "mf" > 1.1< / span > < span class = "p" > )< / span > < span class = "o" > --> < / span > < span class = "n" > nghttpx< / span > < span class = "o" > < --< / span > < span class = "p" > (< / span > < span class = "n" > HTTP< / span > < span class = "o" > /< / span > < span class = "mi" > 2< / span > < span class = "p" > )< / span > < span class = "o" > --> < / span > < span class = "n" > Web< / span > < span class = "n" > Server< / span >
2013-08-03 13:03:39 +02:00
< span class = "p" > [< / span > < span class = "n" > reverse< / span > < span class = "n" > proxy< / span > < span class = "p" > ]< / span >
2013-07-28 14:26:41 +02:00
< / pre > < / div >
< / div >
2014-04-05 12:26:23 +02:00
< p > The frontend HTTP/1.1 connection can be upgraded to HTTP/2
2013-08-03 13:03:39 +02:00
through HTTP Upgrade.< / p >
2014-04-05 12:26:23 +02:00
< p > For the operation modes which talk to the backend in HTTP/2 over
2014-04-08 17:17:05 +02:00
SSL/TLS, the backend connections can be tunneled through HTTP proxy.
The proxy is specified using < tt class = "docutils literal" > < span class = "pre" > --backend-http-proxy-uri< / span > < / tt > option. The
following figure illustrates the example of < tt class = "docutils literal" > < span class = "pre" > --http2-bridge< / span > < / tt > and
< tt class = "docutils literal" > < span class = "pre" > --backend-http-proxy-uri< / span > < / tt > options to talk to the outside HTTP/2
proxy through HTTP proxy:< / p >
2014-04-05 12:26:23 +02:00
< div class = "highlight-c" > < div class = "highlight" > < pre > < span class = "n" > Client< / span > < span class = "o" > < --< / span > < span class = "p" > (< / span > < span class = "n" > HTTP< / span > < span class = "o" > /< / span > < span class = "mi" > 2< / span > < span class = "p" > ,< / span > < span class = "n" > SPDY< / span > < span class = "p" > ,< / span > < span class = "n" > HTTP< / span > < span class = "o" > /< / span > < span class = "mf" > 1.1< / span > < span class = "p" > )< / span > < span class = "o" > --> < / span > < span class = "n" > nghttpx< / span > < span class = "o" > < --< / span > < span class = "p" > (< / span > < span class = "n" > HTTP< / span > < span class = "o" > /< / span > < span class = "mi" > 2< / span > < span class = "p" > )< / span > < span class = "o" > --< / span >
2013-07-28 14:26:41 +02:00
2014-04-05 12:26:23 +02:00
< span class = "o" > --===================---> < / span > < span class = "n" > HTTP< / span > < span class = "o" > /< / span > < span class = "mi" > 2< / span > < span class = "n" > Proxy< / span >
2013-07-28 14:26:41 +02:00
< span class = "p" > (< / span > < span class = "n" > HTTP< / span > < span class = "n" > proxy< / span > < span class = "n" > tunnel< / span > < span class = "p" > )< / span > < span class = "p" > (< / span > < span class = "n" > e< / span > < span class = "p" > .< / span > < span class = "n" > g< / span > < span class = "p" > .,< / span > < span class = "n" > nghttpx< / span > < span class = "o" > -< / span > < span class = "n" > s< / span > < span class = "p" > )< / span >
< / pre > < / div >
< / div >
< / div >
< / div >
2014-03-02 15:54:42 +01:00
< div class = "section" id = "benchmarking-tool" >
< h2 > Benchmarking tool< a class = "headerlink" href = "#benchmarking-tool" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > The < tt class = "docutils literal" > < span class = "pre" > h2load< / span > < / tt > program is a benchmarking tool for HTTP/2 and SPDY.
The SPDY support is enabled if the program was built with spdylay
2014-04-08 17:17:05 +02:00
library. The UI of < tt class = "docutils literal" > < span class = "pre" > h2load< / span > < / tt > is heavily inspired by < tt class = "docutils literal" > < span class = "pre" > weighttp< / span > < / tt >
(< a class = "reference external" href = "https://github.com/lighttpd/weighttp" > https://github.com/lighttpd/weighttp< / a > ). The typical usage is as
follows:< / p >
2014-03-02 15:54:42 +01:00
< div class = "highlight-c" > < div class = "highlight" > < pre > $ src/h2load -n1000 -c10 -m10 https://127.0.0.1:8443/
starting benchmark...
progress: 10% done
progress: 20% done
progress: 30% done
progress: 40% done
progress: 50% done
progress: 60% done
progress: 70% done
progress: 80% done
progress: 90% done
progress: 100% done
finished in 0 sec, 152 millisec and 152 microsec, 6572 req/s, 749 kbytes/s
requests: 1000 total, 1000 started, 1000 done, 0 succeeded, 1000 failed, 0 errored
status codes: 0 2xx, 0 3xx, 1000 4xx, 0 5xx
traffic: 141100 bytes total, 840 bytes headers, 116000 bytes data
< / pre > < / div >
< / div >
< p > The above example issued total 1000 requests, using 10 concurrent
2014-03-03 17:17:25 +01:00
clients (thus 10 HTTP/2 sessions), and maximum 10 streams per client.
With < tt class = "docutils literal" > < span class = "pre" > -t< / span > < / tt > option, < tt class = "docutils literal" > < span class = "pre" > h2load< / span > < / tt > will use multiple native threads to
avoid saturating single core on client side.< / p >
2014-03-02 15:54:42 +01:00
< div class = "admonition warning" >
< p class = "first admonition-title" > Warning< / p >
2014-04-08 17:17:05 +02:00
< p class = "last" > < strong > Don’ t use this tool against publicly available servers.< / strong > That is
considered a DOS attack. Please only use against your private
2014-03-03 17:17:25 +01:00
servers.< / p >
2014-03-02 15:54:42 +01:00
< / div >
< / div >
2014-01-10 17:07:30 +01:00
< div class = "section" id = "hpack-tools" >
< h2 > HPACK tools< a class = "headerlink" href = "#hpack-tools" title = "Permalink to this headline" > ¶< / a > < / h2 >
2014-04-08 17:17:05 +02:00
< p > The < tt class = "docutils literal" > < span class = "pre" > src< / span > < / tt > directory contains HPACK tools. The < tt class = "docutils literal" > < span class = "pre" > deflatehd< / span > < / tt > is a
command-line header compression tool. The < tt class = "docutils literal" > < span class = "pre" > inflatehd< / span > < / tt > is
2014-01-10 17:07:30 +01:00
command-line header decompression tool. Both tools read input from
2014-04-08 17:17:05 +02:00
stdin and write output to stdout. The errors are written to stderr.
They take JSON as input and output. We use (mostly) same JSON data
format described at < a class = "reference external" href = "https://github.com/http2jp/hpack-test-case" > https://github.com/http2jp/hpack-test-case< / a > < / p >
2013-10-28 16:24:56 +01:00
< div class = "section" id = "deflatehd-header-compressor" >
< h3 > deflatehd - header compressor< a class = "headerlink" href = "#deflatehd-header-compressor" title = "Permalink to this headline" > ¶< / a > < / h3 >
2014-01-11 09:08:37 +01:00
< p > The < tt class = "docutils literal" > < span class = "pre" > deflatehd< / span > < / tt > reads JSON data or HTTP/1-style header fields from
stdin and outputs compressed header block in JSON.< / p >
2014-04-08 17:17:05 +02:00
< p > For the JSON input, the root JSON object must include < tt class = "docutils literal" > < span class = "pre" > cases< / span > < / tt > key.
Its value has to include the sequence of input header set. They share
the same compression context and are processed in the order they
2014-02-16 07:51:22 +01:00
appear. Each item in the sequence is a JSON object and it must
2014-04-08 17:17:05 +02:00
include < tt class = "docutils literal" > < span class = "pre" > headers< / span > < / tt > key. Its value is an array of a JSON object,
2014-02-16 07:51:22 +01:00
which includes exactly one name/value pair.< / p >
2013-10-28 16:24:56 +01:00
< p > Example:< / p >
2014-01-11 09:13:44 +01:00
< div class = "highlight-json" > < div class = "highlight" > < pre > < span class = "p" > {< / span >
< span class = "nt" > " cases" < / span > < span class = "p" > :< / span >
2014-01-11 09:08:37 +01:00
< span class = "p" > [< / span >
< span class = "p" > {< / span >
2014-01-11 09:13:44 +01:00
< span class = "nt" > " headers" < / span > < span class = "p" > :< / span > < span class = "p" > [< / span >
< span class = "p" > {< / span > < span class = "nt" > " :method" < / span > < span class = "p" > :< / span > < span class = "s2" > " GET" < / span > < span class = "p" > },< / span >
< span class = "p" > {< / span > < span class = "nt" > " :path" < / span > < span class = "p" > :< / span > < span class = "s2" > " /" < / span > < span class = "p" > }< / span >
2014-01-11 09:08:37 +01:00
< span class = "p" > ]< / span >
< span class = "p" > },< / span >
< span class = "p" > {< / span >
2014-01-11 09:13:44 +01:00
< span class = "nt" > " headers" < / span > < span class = "p" > :< / span > < span class = "p" > [< / span >
< span class = "p" > {< / span > < span class = "nt" > " :method" < / span > < span class = "p" > :< / span > < span class = "s2" > " POST" < / span > < span class = "p" > },< / span >
< span class = "p" > {< / span > < span class = "nt" > " :path" < / span > < span class = "p" > :< / span > < span class = "s2" > " /" < / span > < span class = "p" > }< / span >
2014-01-11 09:08:37 +01:00
< span class = "p" > ]< / span >
< span class = "p" > }< / span >
< span class = "p" > ]< / span >
< span class = "p" > }< / span >
2013-10-28 16:24:56 +01:00
< / pre > < / div >
< / div >
< p > With < tt class = "docutils literal" > < span class = "pre" > -t< / span > < / tt > option, the program can accept more familiar HTTP/1 style
2014-04-08 17:17:05 +02:00
header field block. Each header set is delimited by empty line:< / p >
2013-10-28 16:24:56 +01:00
< p > Example:< / p >
< div class = "highlight-c" > < div class = "highlight" > < pre > < span class = "o" > :< / span > < span class = "n" > method< / span > < span class = "o" > :< / span > < span class = "n" > GET< / span >
< span class = "o" > :< / span > < span class = "n" > scheme< / span > < span class = "o" > :< / span > < span class = "n" > https< / span >
< span class = "o" > :< / span > < span class = "n" > path< / span > < span class = "o" > :< / span > < span class = "o" > /< / span >
< span class = "o" > :< / span > < span class = "n" > method< / span > < span class = "o" > :< / span > < span class = "n" > POST< / span >
< span class = "n" > user< / span > < span class = "o" > -< / span > < span class = "n" > agent< / span > < span class = "o" > :< / span > < span class = "n" > nghttp2< / span >
< / pre > < / div >
< / div >
2014-04-08 17:17:05 +02:00
< p > The output is JSON object. It should include < tt class = "docutils literal" > < span class = "pre" > cases< / span > < / tt > key and its
2014-01-11 09:08:37 +01:00
value is an array of JSON object, which has at least following keys:< / p >
2013-10-28 16:24:56 +01:00
< dl class = "docutils" >
< dt > seq< / dt >
< dd > The index of header set in the input.< / dd >
2014-01-11 09:08:37 +01:00
< dt > input_length< / dt >
2013-10-28 16:24:56 +01:00
< dd > The sum of length of name/value pair in the input.< / dd >
2014-01-11 09:08:37 +01:00
< dt > output_length< / dt >
2013-10-28 16:24:56 +01:00
< dd > The length of compressed header block.< / dd >
2014-01-11 09:08:37 +01:00
< dt > percentage_of_original_size< / dt >
< dd > < tt class = "docutils literal" > < span class = "pre" > input_length< / span > < / tt > / < tt class = "docutils literal" > < span class = "pre" > output_length< / span > < / tt > * 100< / dd >
< dt > wire< / dt >
2013-10-28 16:24:56 +01:00
< dd > The compressed header block in hex string.< / dd >
2014-01-11 09:08:37 +01:00
< dt > headers< / dt >
< dd > The input header set.< / dd >
< dt > header_table_size< / dt >
2014-03-03 17:17:25 +01:00
< dd > The header table size adjusted before deflating header set.< / dd >
2013-10-28 16:24:56 +01:00
< / dl >
< p > Examples:< / p >
2014-01-11 09:13:44 +01:00
< div class = "highlight-json" > < div class = "highlight" > < pre > < span class = "p" > {< / span >
< span class = "nt" > " cases" < / span > < span class = "p" > :< / span >
2014-01-11 09:08:37 +01:00
< span class = "p" > [< / span >
< span class = "p" > {< / span >
2014-01-11 09:13:44 +01:00
< span class = "nt" > " seq" < / span > < span class = "p" > :< / span > < span class = "mi" > 0< / span > < span class = "p" > ,< / span >
< span class = "nt" > " input_length" < / span > < span class = "p" > :< / span > < span class = "mi" > 66< / span > < span class = "p" > ,< / span >
< span class = "nt" > " output_length" < / span > < span class = "p" > :< / span > < span class = "mi" > 20< / span > < span class = "p" > ,< / span >
< span class = "nt" > " percentage_of_original_size" < / span > < span class = "p" > :< / span > < span class = "mf" > 30.303030303030305< / span > < span class = "p" > ,< / span >
< span class = "nt" > " wire" < / span > < span class = "p" > :< / span > < span class = "s2" > " 01881f3468e5891afcbf83868a3d856659c62e3f" < / span > < span class = "p" > ,< / span >
< span class = "nt" > " headers" < / span > < span class = "p" > :< / span > < span class = "p" > [< / span >
2014-01-11 09:08:37 +01:00
< span class = "p" > {< / span >
2014-01-11 09:13:44 +01:00
< span class = "nt" > " :authority" < / span > < span class = "p" > :< / span > < span class = "s2" > " example.org" < / span >
2014-01-11 09:08:37 +01:00
< span class = "p" > },< / span >
< span class = "p" > {< / span >
2014-01-11 09:13:44 +01:00
< span class = "nt" > " :method" < / span > < span class = "p" > :< / span > < span class = "s2" > " GET" < / span >
2014-01-11 09:08:37 +01:00
< span class = "p" > },< / span >
< span class = "p" > {< / span >
2014-01-11 09:13:44 +01:00
< span class = "nt" > " :path" < / span > < span class = "p" > :< / span > < span class = "s2" > " /" < / span >
2014-01-11 09:08:37 +01:00
< span class = "p" > },< / span >
< span class = "p" > {< / span >
2014-01-11 09:13:44 +01:00
< span class = "nt" > " :scheme" < / span > < span class = "p" > :< / span > < span class = "s2" > " https" < / span >
2014-01-11 09:08:37 +01:00
< span class = "p" > },< / span >
< span class = "p" > {< / span >
2014-01-11 09:13:44 +01:00
< span class = "nt" > " user-agent" < / span > < span class = "p" > :< / span > < span class = "s2" > " nghttp2" < / span >
2014-01-11 09:08:37 +01:00
< span class = "p" > }< / span >
< span class = "p" > ],< / span >
2014-01-11 09:13:44 +01:00
< span class = "nt" > " header_table_size" < / span > < span class = "p" > :< / span > < span class = "mi" > 4096< / span >
2014-01-11 09:08:37 +01:00
< span class = "p" > }< / span >
< span class = "p" > ,< / span >
< span class = "p" > {< / span >
2014-01-11 09:13:44 +01:00
< span class = "nt" > " seq" < / span > < span class = "p" > :< / span > < span class = "mi" > 1< / span > < span class = "p" > ,< / span >
< span class = "nt" > " input_length" < / span > < span class = "p" > :< / span > < span class = "mi" > 74< / span > < span class = "p" > ,< / span >
< span class = "nt" > " output_length" < / span > < span class = "p" > :< / span > < span class = "mi" > 10< / span > < span class = "p" > ,< / span >
< span class = "nt" > " percentage_of_original_size" < / span > < span class = "p" > :< / span > < span class = "mf" > 13.513513513513514< / span > < span class = "p" > ,< / span >
< span class = "nt" > " wire" < / span > < span class = "p" > :< / span > < span class = "s2" > " 88448504252dd5918485" < / span > < span class = "p" > ,< / span >
< span class = "nt" > " headers" < / span > < span class = "p" > :< / span > < span class = "p" > [< / span >
2014-01-11 09:08:37 +01:00
< span class = "p" > {< / span >
2014-01-11 09:13:44 +01:00
< span class = "nt" > " :authority" < / span > < span class = "p" > :< / span > < span class = "s2" > " example.org" < / span >
2014-01-11 09:08:37 +01:00
< span class = "p" > },< / span >
< span class = "p" > {< / span >
2014-01-11 09:13:44 +01:00
< span class = "nt" > " :method" < / span > < span class = "p" > :< / span > < span class = "s2" > " POST" < / span >
2014-01-11 09:08:37 +01:00
< span class = "p" > },< / span >
< span class = "p" > {< / span >
2014-01-11 09:13:44 +01:00
< span class = "nt" > " :path" < / span > < span class = "p" > :< / span > < span class = "s2" > " /account" < / span >
2014-01-11 09:08:37 +01:00
< span class = "p" > },< / span >
< span class = "p" > {< / span >
2014-01-11 09:13:44 +01:00
< span class = "nt" > " :scheme" < / span > < span class = "p" > :< / span > < span class = "s2" > " https" < / span >
2014-01-11 09:08:37 +01:00
< span class = "p" > },< / span >
< span class = "p" > {< / span >
2014-01-11 09:13:44 +01:00
< span class = "nt" > " user-agent" < / span > < span class = "p" > :< / span > < span class = "s2" > " nghttp2" < / span >
2014-01-11 09:08:37 +01:00
< span class = "p" > }< / span >
< span class = "p" > ],< / span >
2014-01-11 09:13:44 +01:00
< span class = "nt" > " header_table_size" < / span > < span class = "p" > :< / span > < span class = "mi" > 4096< / span >
2014-01-11 09:08:37 +01:00
< span class = "p" > }< / span >
< span class = "p" > ]< / span >
< span class = "p" > }< / span >
2013-10-28 16:24:56 +01:00
< / pre > < / div >
< / div >
2014-01-11 09:08:37 +01:00
< p > The output can be used as the input for < tt class = "docutils literal" > < span class = "pre" > inflatehd< / span > < / tt > and
< tt class = "docutils literal" > < span class = "pre" > deflatehd< / span > < / tt > .< / p >
< p > With < tt class = "docutils literal" > < span class = "pre" > -d< / span > < / tt > option, the extra < tt class = "docutils literal" > < span class = "pre" > header_table< / span > < / tt > key is added and its
2014-03-03 17:17:25 +01:00
associated value includes the state of dynamic header table after the
2014-04-08 17:17:05 +02:00
corresponding header set was processed. The value includes at least
the following keys:< / p >
2013-10-28 16:24:56 +01:00
< dl class = "docutils" >
< dt > entries< / dt >
2014-04-08 17:17:05 +02:00
< dd > The entry in the header table. If < tt class = "docutils literal" > < span class = "pre" > referenced< / span > < / tt > is < tt class = "docutils literal" > < span class = "pre" > true< / span > < / tt > , it
is in the reference set. The < tt class = "docutils literal" > < span class = "pre" > size< / span > < / tt > includes the overhead (32
bytes). The < tt class = "docutils literal" > < span class = "pre" > index< / span > < / tt > corresponds to the index of header table.
2013-10-28 16:24:56 +01:00
The < tt class = "docutils literal" > < span class = "pre" > name< / span > < / tt > is the header field name and the < tt class = "docutils literal" > < span class = "pre" > value< / span > < / tt > is the
2014-04-08 17:17:05 +02:00
header field value.< / dd >
2013-10-28 16:24:56 +01:00
< dt > size< / dt >
< dd > The sum of the spaces entries occupied, this includes the
entry overhead.< / dd >
2014-01-11 09:08:37 +01:00
< dt > max_size< / dt >
2013-10-28 16:24:56 +01:00
< dd > The maximum header table size.< / dd >
2014-01-11 09:08:37 +01:00
< dt > deflate_size< / dt >
< dd > The sum of the spaces entries occupied within
< tt class = "docutils literal" > < span class = "pre" > max_deflate_size< / span > < / tt > .< / dd >
< dt > max_deflate_size< / dt >
2014-04-08 17:17:05 +02:00
< dd > The maximum header table size encoder uses. This can be smaller
than < tt class = "docutils literal" > < span class = "pre" > max_size< / span > < / tt > . In this case, encoder only uses up to first
< tt class = "docutils literal" > < span class = "pre" > max_deflate_size< / span > < / tt > buffer. Since the header table size is still
2014-01-11 09:08:37 +01:00
< tt class = "docutils literal" > < span class = "pre" > max_size< / span > < / tt > , the encoder has to keep track of entries ouside the
< tt class = "docutils literal" > < span class = "pre" > max_deflate_size< / span > < / tt > but inside the < tt class = "docutils literal" > < span class = "pre" > max_size< / span > < / tt > and make sure
that they are no longer referenced.< / dd >
2013-10-28 16:24:56 +01:00
< / dl >
< p > Example:< / p >
2014-01-11 09:13:44 +01:00
< div class = "highlight-json" > < div class = "highlight" > < pre > < span class = "p" > {< / span >
< span class = "nt" > " cases" < / span > < span class = "p" > :< / span >
2014-01-11 09:08:37 +01:00
< span class = "p" > [< / span >
< span class = "p" > {< / span >
2014-01-11 09:13:44 +01:00
< span class = "nt" > " seq" < / span > < span class = "p" > :< / span > < span class = "mi" > 0< / span > < span class = "p" > ,< / span >
< span class = "nt" > " input_length" < / span > < span class = "p" > :< / span > < span class = "mi" > 66< / span > < span class = "p" > ,< / span >
< span class = "nt" > " output_length" < / span > < span class = "p" > :< / span > < span class = "mi" > 20< / span > < span class = "p" > ,< / span >
< span class = "nt" > " percentage_of_original_size" < / span > < span class = "p" > :< / span > < span class = "mf" > 30.303030303030305< / span > < span class = "p" > ,< / span >
< span class = "nt" > " wire" < / span > < span class = "p" > :< / span > < span class = "s2" > " 01881f3468e5891afcbf83868a3d856659c62e3f" < / span > < span class = "p" > ,< / span >
< span class = "nt" > " headers" < / span > < span class = "p" > :< / span > < span class = "p" > [< / span >
2013-10-28 16:24:56 +01:00
< span class = "p" > {< / span >
2014-01-11 09:13:44 +01:00
< span class = "nt" > " :authority" < / span > < span class = "p" > :< / span > < span class = "s2" > " example.org" < / span >
2013-10-28 16:24:56 +01:00
< span class = "p" > },< / span >
< span class = "p" > {< / span >
2014-01-11 09:13:44 +01:00
< span class = "nt" > " :method" < / span > < span class = "p" > :< / span > < span class = "s2" > " GET" < / span >
2013-10-28 16:24:56 +01:00
< span class = "p" > },< / span >
< span class = "p" > {< / span >
2014-01-11 09:13:44 +01:00
< span class = "nt" > " :path" < / span > < span class = "p" > :< / span > < span class = "s2" > " /" < / span >
2013-10-28 16:24:56 +01:00
< span class = "p" > },< / span >
< span class = "p" > {< / span >
2014-01-11 09:13:44 +01:00
< span class = "nt" > " :scheme" < / span > < span class = "p" > :< / span > < span class = "s2" > " https" < / span >
2013-10-28 16:24:56 +01:00
< span class = "p" > },< / span >
< span class = "p" > {< / span >
2014-01-11 09:13:44 +01:00
< span class = "nt" > " user-agent" < / span > < span class = "p" > :< / span > < span class = "s2" > " nghttp2" < / span >
2013-10-28 16:24:56 +01:00
< span class = "p" > }< / span >
< span class = "p" > ],< / span >
2014-01-11 09:13:44 +01:00
< span class = "nt" > " header_table_size" < / span > < span class = "p" > :< / span > < span class = "mi" > 4096< / span > < span class = "p" > ,< / span >
< span class = "nt" > " header_table" < / span > < span class = "p" > :< / span > < span class = "p" > {< / span >
< span class = "nt" > " entries" < / span > < span class = "p" > :< / span > < span class = "p" > [< / span >
2014-01-11 09:08:37 +01:00
< span class = "p" > {< / span >
2014-01-11 09:13:44 +01:00
< span class = "nt" > " index" < / span > < span class = "p" > :< / span > < span class = "mi" > 1< / span > < span class = "p" > ,< / span >
< span class = "nt" > " name" < / span > < span class = "p" > :< / span > < span class = "s2" > " user-agent" < / span > < span class = "p" > ,< / span >
< span class = "nt" > " value" < / span > < span class = "p" > :< / span > < span class = "s2" > " nghttp2" < / span > < span class = "p" > ,< / span >
< span class = "nt" > " referenced" < / span > < span class = "p" > :< / span > < span class = "kc" > true< / span > < span class = "p" > ,< / span >
< span class = "nt" > " size" < / span > < span class = "p" > :< / span > < span class = "mi" > 49< / span >
2014-01-11 09:08:37 +01:00
< span class = "p" > },< / span >
< span class = "p" > {< / span >
2014-01-11 09:13:44 +01:00
< span class = "nt" > " index" < / span > < span class = "p" > :< / span > < span class = "mi" > 2< / span > < span class = "p" > ,< / span >
< span class = "nt" > " name" < / span > < span class = "p" > :< / span > < span class = "s2" > " :scheme" < / span > < span class = "p" > ,< / span >
< span class = "nt" > " value" < / span > < span class = "p" > :< / span > < span class = "s2" > " https" < / span > < span class = "p" > ,< / span >
< span class = "nt" > " referenced" < / span > < span class = "p" > :< / span > < span class = "kc" > true< / span > < span class = "p" > ,< / span >
< span class = "nt" > " size" < / span > < span class = "p" > :< / span > < span class = "mi" > 44< / span >
2014-01-11 09:08:37 +01:00
< span class = "p" > },< / span >
< span class = "p" > {< / span >
2014-01-11 09:13:44 +01:00
< span class = "nt" > " index" < / span > < span class = "p" > :< / span > < span class = "mi" > 3< / span > < span class = "p" > ,< / span >
< span class = "nt" > " name" < / span > < span class = "p" > :< / span > < span class = "s2" > " :path" < / span > < span class = "p" > ,< / span >
< span class = "nt" > " value" < / span > < span class = "p" > :< / span > < span class = "s2" > " /" < / span > < span class = "p" > ,< / span >
< span class = "nt" > " referenced" < / span > < span class = "p" > :< / span > < span class = "kc" > true< / span > < span class = "p" > ,< / span >
< span class = "nt" > " size" < / span > < span class = "p" > :< / span > < span class = "mi" > 38< / span >
2014-01-11 09:08:37 +01:00
< span class = "p" > },< / span >
< span class = "p" > {< / span >
2014-01-11 09:13:44 +01:00
< span class = "nt" > " index" < / span > < span class = "p" > :< / span > < span class = "mi" > 4< / span > < span class = "p" > ,< / span >
< span class = "nt" > " name" < / span > < span class = "p" > :< / span > < span class = "s2" > " :method" < / span > < span class = "p" > ,< / span >
< span class = "nt" > " value" < / span > < span class = "p" > :< / span > < span class = "s2" > " GET" < / span > < span class = "p" > ,< / span >
< span class = "nt" > " referenced" < / span > < span class = "p" > :< / span > < span class = "kc" > true< / span > < span class = "p" > ,< / span >
< span class = "nt" > " size" < / span > < span class = "p" > :< / span > < span class = "mi" > 42< / span >
2014-01-11 09:08:37 +01:00
< span class = "p" > },< / span >
< span class = "p" > {< / span >
2014-01-11 09:13:44 +01:00
< span class = "nt" > " index" < / span > < span class = "p" > :< / span > < span class = "mi" > 5< / span > < span class = "p" > ,< / span >
< span class = "nt" > " name" < / span > < span class = "p" > :< / span > < span class = "s2" > " :authority" < / span > < span class = "p" > ,< / span >
< span class = "nt" > " value" < / span > < span class = "p" > :< / span > < span class = "s2" > " example.org" < / span > < span class = "p" > ,< / span >
< span class = "nt" > " referenced" < / span > < span class = "p" > :< / span > < span class = "kc" > true< / span > < span class = "p" > ,< / span >
< span class = "nt" > " size" < / span > < span class = "p" > :< / span > < span class = "mi" > 53< / span >
2014-01-11 09:08:37 +01:00
< span class = "p" > }< / span >
< span class = "p" > ],< / span >
2014-01-11 09:13:44 +01:00
< span class = "nt" > " size" < / span > < span class = "p" > :< / span > < span class = "mi" > 226< / span > < span class = "p" > ,< / span >
< span class = "nt" > " max_size" < / span > < span class = "p" > :< / span > < span class = "mi" > 4096< / span > < span class = "p" > ,< / span >
< span class = "nt" > " deflate_size" < / span > < span class = "p" > :< / span > < span class = "mi" > 226< / span > < span class = "p" > ,< / span >
< span class = "nt" > " max_deflate_size" < / span > < span class = "p" > :< / span > < span class = "mi" > 4096< / span >
2014-01-11 09:08:37 +01:00
< span class = "p" > }< / span >
2013-10-28 16:24:56 +01:00
< span class = "p" > }< / span >
2014-01-11 09:08:37 +01:00
< span class = "p" > ,< / span >
< span class = "p" > {< / span >
2014-01-11 09:13:44 +01:00
< span class = "nt" > " seq" < / span > < span class = "p" > :< / span > < span class = "mi" > 1< / span > < span class = "p" > ,< / span >
< span class = "nt" > " input_length" < / span > < span class = "p" > :< / span > < span class = "mi" > 74< / span > < span class = "p" > ,< / span >
< span class = "nt" > " output_length" < / span > < span class = "p" > :< / span > < span class = "mi" > 10< / span > < span class = "p" > ,< / span >
< span class = "nt" > " percentage_of_original_size" < / span > < span class = "p" > :< / span > < span class = "mf" > 13.513513513513514< / span > < span class = "p" > ,< / span >
< span class = "nt" > " wire" < / span > < span class = "p" > :< / span > < span class = "s2" > " 88448504252dd5918485" < / span > < span class = "p" > ,< / span >
< span class = "nt" > " headers" < / span > < span class = "p" > :< / span > < span class = "p" > [< / span >
2013-10-28 16:24:56 +01:00
< span class = "p" > {< / span >
2014-01-11 09:13:44 +01:00
< span class = "nt" > " :authority" < / span > < span class = "p" > :< / span > < span class = "s2" > " example.org" < / span >
2013-10-28 16:24:56 +01:00
< span class = "p" > },< / span >
< span class = "p" > {< / span >
2014-01-11 09:13:44 +01:00
< span class = "nt" > " :method" < / span > < span class = "p" > :< / span > < span class = "s2" > " POST" < / span >
2013-10-28 16:24:56 +01:00
< span class = "p" > },< / span >
< span class = "p" > {< / span >
2014-01-11 09:13:44 +01:00
< span class = "nt" > " :path" < / span > < span class = "p" > :< / span > < span class = "s2" > " /account" < / span >
2013-10-28 16:24:56 +01:00
< span class = "p" > },< / span >
< span class = "p" > {< / span >
2014-01-11 09:13:44 +01:00
< span class = "nt" > " :scheme" < / span > < span class = "p" > :< / span > < span class = "s2" > " https" < / span >
2013-10-28 16:24:56 +01:00
< span class = "p" > },< / span >
< span class = "p" > {< / span >
2014-01-11 09:13:44 +01:00
< span class = "nt" > " user-agent" < / span > < span class = "p" > :< / span > < span class = "s2" > " nghttp2" < / span >
2013-10-28 16:24:56 +01:00
< span class = "p" > }< / span >
< span class = "p" > ],< / span >
2014-01-11 09:13:44 +01:00
< span class = "nt" > " header_table_size" < / span > < span class = "p" > :< / span > < span class = "mi" > 4096< / span > < span class = "p" > ,< / span >
< span class = "nt" > " header_table" < / span > < span class = "p" > :< / span > < span class = "p" > {< / span >
< span class = "nt" > " entries" < / span > < span class = "p" > :< / span > < span class = "p" > [< / span >
2014-01-11 09:08:37 +01:00
< span class = "p" > {< / span >
2014-01-11 09:13:44 +01:00
< span class = "nt" > " index" < / span > < span class = "p" > :< / span > < span class = "mi" > 1< / span > < span class = "p" > ,< / span >
< span class = "nt" > " name" < / span > < span class = "p" > :< / span > < span class = "s2" > " :method" < / span > < span class = "p" > ,< / span >
< span class = "nt" > " value" < / span > < span class = "p" > :< / span > < span class = "s2" > " POST" < / span > < span class = "p" > ,< / span >
< span class = "nt" > " referenced" < / span > < span class = "p" > :< / span > < span class = "kc" > true< / span > < span class = "p" > ,< / span >
< span class = "nt" > " size" < / span > < span class = "p" > :< / span > < span class = "mi" > 43< / span >
2014-01-11 09:08:37 +01:00
< span class = "p" > },< / span >
< span class = "p" > {< / span >
2014-01-11 09:13:44 +01:00
< span class = "nt" > " index" < / span > < span class = "p" > :< / span > < span class = "mi" > 2< / span > < span class = "p" > ,< / span >
< span class = "nt" > " name" < / span > < span class = "p" > :< / span > < span class = "s2" > " user-agent" < / span > < span class = "p" > ,< / span >
< span class = "nt" > " value" < / span > < span class = "p" > :< / span > < span class = "s2" > " nghttp2" < / span > < span class = "p" > ,< / span >
< span class = "nt" > " referenced" < / span > < span class = "p" > :< / span > < span class = "kc" > true< / span > < span class = "p" > ,< / span >
< span class = "nt" > " size" < / span > < span class = "p" > :< / span > < span class = "mi" > 49< / span >
2014-01-11 09:08:37 +01:00
< span class = "p" > },< / span >
< span class = "p" > {< / span >
2014-01-11 09:13:44 +01:00
< span class = "nt" > " index" < / span > < span class = "p" > :< / span > < span class = "mi" > 3< / span > < span class = "p" > ,< / span >
< span class = "nt" > " name" < / span > < span class = "p" > :< / span > < span class = "s2" > " :scheme" < / span > < span class = "p" > ,< / span >
< span class = "nt" > " value" < / span > < span class = "p" > :< / span > < span class = "s2" > " https" < / span > < span class = "p" > ,< / span >
< span class = "nt" > " referenced" < / span > < span class = "p" > :< / span > < span class = "kc" > true< / span > < span class = "p" > ,< / span >
< span class = "nt" > " size" < / span > < span class = "p" > :< / span > < span class = "mi" > 44< / span >
2014-01-11 09:08:37 +01:00
< span class = "p" > },< / span >
< span class = "p" > {< / span >
2014-01-11 09:13:44 +01:00
< span class = "nt" > " index" < / span > < span class = "p" > :< / span > < span class = "mi" > 4< / span > < span class = "p" > ,< / span >
< span class = "nt" > " name" < / span > < span class = "p" > :< / span > < span class = "s2" > " :path" < / span > < span class = "p" > ,< / span >
< span class = "nt" > " value" < / span > < span class = "p" > :< / span > < span class = "s2" > " /" < / span > < span class = "p" > ,< / span >
< span class = "nt" > " referenced" < / span > < span class = "p" > :< / span > < span class = "kc" > false< / span > < span class = "p" > ,< / span >
< span class = "nt" > " size" < / span > < span class = "p" > :< / span > < span class = "mi" > 38< / span >
2014-01-11 09:08:37 +01:00
< span class = "p" > },< / span >
< span class = "p" > {< / span >
2014-01-11 09:13:44 +01:00
< span class = "nt" > " index" < / span > < span class = "p" > :< / span > < span class = "mi" > 5< / span > < span class = "p" > ,< / span >
< span class = "nt" > " name" < / span > < span class = "p" > :< / span > < span class = "s2" > " :method" < / span > < span class = "p" > ,< / span >
< span class = "nt" > " value" < / span > < span class = "p" > :< / span > < span class = "s2" > " GET" < / span > < span class = "p" > ,< / span >
< span class = "nt" > " referenced" < / span > < span class = "p" > :< / span > < span class = "kc" > false< / span > < span class = "p" > ,< / span >
< span class = "nt" > " size" < / span > < span class = "p" > :< / span > < span class = "mi" > 42< / span >
2014-01-11 09:08:37 +01:00
< span class = "p" > },< / span >
< span class = "p" > {< / span >
2014-01-11 09:13:44 +01:00
< span class = "nt" > " index" < / span > < span class = "p" > :< / span > < span class = "mi" > 6< / span > < span class = "p" > ,< / span >
< span class = "nt" > " name" < / span > < span class = "p" > :< / span > < span class = "s2" > " :authority" < / span > < span class = "p" > ,< / span >
< span class = "nt" > " value" < / span > < span class = "p" > :< / span > < span class = "s2" > " example.org" < / span > < span class = "p" > ,< / span >
< span class = "nt" > " referenced" < / span > < span class = "p" > :< / span > < span class = "kc" > true< / span > < span class = "p" > ,< / span >
< span class = "nt" > " size" < / span > < span class = "p" > :< / span > < span class = "mi" > 53< / span >
2014-01-11 09:08:37 +01:00
< span class = "p" > }< / span >
< span class = "p" > ],< / span >
2014-01-11 09:13:44 +01:00
< span class = "nt" > " size" < / span > < span class = "p" > :< / span > < span class = "mi" > 269< / span > < span class = "p" > ,< / span >
< span class = "nt" > " max_size" < / span > < span class = "p" > :< / span > < span class = "mi" > 4096< / span > < span class = "p" > ,< / span >
< span class = "nt" > " deflate_size" < / span > < span class = "p" > :< / span > < span class = "mi" > 269< / span > < span class = "p" > ,< / span >
< span class = "nt" > " max_deflate_size" < / span > < span class = "p" > :< / span > < span class = "mi" > 4096< / span >
2014-01-11 09:08:37 +01:00
< span class = "p" > }< / span >
2013-10-28 16:24:56 +01:00
< span class = "p" > }< / span >
2014-01-11 09:08:37 +01:00
< span class = "p" > ]< / span >
< span class = "p" > }< / span >
2013-10-28 16:24:56 +01:00
< / pre > < / div >
< / div >
< / div >
< div class = "section" id = "inflatehd-header-decompressor" >
< h3 > inflatehd - header decompressor< a class = "headerlink" href = "#inflatehd-header-decompressor" title = "Permalink to this headline" > ¶< / a > < / h3 >
2014-01-11 09:08:37 +01:00
< p > The < tt class = "docutils literal" > < span class = "pre" > inflatehd< / span > < / tt > reads JSON data from stdin and outputs decompressed
name/value pairs in JSON.< / p >
2014-04-08 17:17:05 +02:00
< p > The root JSON object must include < tt class = "docutils literal" > < span class = "pre" > cases< / span > < / tt > key. Its value has to
include the sequence of compressed header block. They share the same
compression context and are processed in the order they appear. Each
2014-02-16 07:51:22 +01:00
item in the sequence is a JSON object and it must have at least
2014-04-08 17:17:05 +02:00
< tt class = "docutils literal" > < span class = "pre" > wire< / span > < / tt > key. Its value is a compressed header block in hex string.< / p >
2013-10-28 16:24:56 +01:00
< p > Example:< / p >
2014-01-11 09:13:44 +01:00
< div class = "highlight-json" > < div class = "highlight" > < pre > < span class = "p" > {< / span >
< span class = "nt" > " cases" < / span > < span class = "p" > :< / span >
2014-01-11 09:08:37 +01:00
< span class = "p" > [< / span >
2014-01-11 09:13:44 +01:00
< span class = "p" > {< / span > < span class = "nt" > " wire" < / span > < span class = "p" > :< / span > < span class = "s2" > " 8285" < / span > < span class = "p" > },< / span >
< span class = "p" > {< / span > < span class = "nt" > " wire" < / span > < span class = "p" > :< / span > < span class = "s2" > " 8583" < / span > < span class = "p" > }< / span >
2014-01-11 09:08:37 +01:00
< span class = "p" > ]< / span >
< span class = "p" > }< / span >
2013-10-28 16:24:56 +01:00
< / pre > < / div >
< / div >
2014-04-08 17:17:05 +02:00
< p > The output is JSON object. It should include < tt class = "docutils literal" > < span class = "pre" > cases< / span > < / tt > key and its
2014-01-11 09:08:37 +01:00
value is an array of JSON object, which has at least following keys:< / p >
2013-10-28 16:24:56 +01:00
< dl class = "docutils" >
< dt > seq< / dt >
< dd > The index of header set in the input.< / dd >
< dt > headers< / dt >
2014-02-16 07:51:22 +01:00
< dd > The JSON array includes decompressed name/value pairs.< / dd >
2014-01-11 09:08:37 +01:00
< dt > wire< / dt >
< dd > The compressed header block in hex string.< / dd >
< dt > header_table_size< / dt >
2014-03-03 17:17:25 +01:00
< dd > The header table size adjusted before inflating compressed header
2014-01-11 09:08:37 +01:00
block.< / dd >
2013-10-28 16:24:56 +01:00
< / dl >
< p > Example:< / p >
2014-01-11 09:13:44 +01:00
< div class = "highlight-json" > < div class = "highlight" > < pre > < span class = "p" > {< / span >
< span class = "nt" > " cases" < / span > < span class = "p" > :< / span >
2014-01-11 09:08:37 +01:00
< span class = "p" > [< / span >
< span class = "p" > {< / span >
2014-01-11 09:13:44 +01:00
< span class = "nt" > " seq" < / span > < span class = "p" > :< / span > < span class = "mi" > 0< / span > < span class = "p" > ,< / span >
< span class = "nt" > " wire" < / span > < span class = "p" > :< / span > < span class = "s2" > " 01881f3468e5891afcbf83868a3d856659c62e3f" < / span > < span class = "p" > ,< / span >
< span class = "nt" > " headers" < / span > < span class = "p" > :< / span > < span class = "p" > [< / span >
2014-01-11 09:08:37 +01:00
< span class = "p" > {< / span >
2014-01-11 09:13:44 +01:00
< span class = "nt" > " :authority" < / span > < span class = "p" > :< / span > < span class = "s2" > " example.org" < / span >
2014-01-11 09:08:37 +01:00
< span class = "p" > },< / span >
< span class = "p" > {< / span >
2014-01-11 09:13:44 +01:00
< span class = "nt" > " :method" < / span > < span class = "p" > :< / span > < span class = "s2" > " GET" < / span >
2014-01-11 09:08:37 +01:00
< span class = "p" > },< / span >
< span class = "p" > {< / span >
2014-01-11 09:13:44 +01:00
< span class = "nt" > " :path" < / span > < span class = "p" > :< / span > < span class = "s2" > " /" < / span >
2014-01-11 09:08:37 +01:00
< span class = "p" > },< / span >
< span class = "p" > {< / span >
2014-01-11 09:13:44 +01:00
< span class = "nt" > " :scheme" < / span > < span class = "p" > :< / span > < span class = "s2" > " https" < / span >
2014-01-11 09:08:37 +01:00
< span class = "p" > },< / span >
< span class = "p" > {< / span >
2014-01-11 09:13:44 +01:00
< span class = "nt" > " user-agent" < / span > < span class = "p" > :< / span > < span class = "s2" > " nghttp2" < / span >
2014-01-11 09:08:37 +01:00
< span class = "p" > }< / span >
< span class = "p" > ],< / span >
2014-01-11 09:13:44 +01:00
< span class = "nt" > " header_table_size" < / span > < span class = "p" > :< / span > < span class = "mi" > 4096< / span >
2014-01-11 09:08:37 +01:00
< span class = "p" > }< / span >
< span class = "p" > ,< / span >
< span class = "p" > {< / span >
2014-01-11 09:13:44 +01:00
< span class = "nt" > " seq" < / span > < span class = "p" > :< / span > < span class = "mi" > 1< / span > < span class = "p" > ,< / span >
< span class = "nt" > " wire" < / span > < span class = "p" > :< / span > < span class = "s2" > " 88448504252dd5918485" < / span > < span class = "p" > ,< / span >
< span class = "nt" > " headers" < / span > < span class = "p" > :< / span > < span class = "p" > [< / span >
2014-01-11 09:08:37 +01:00
< span class = "p" > {< / span >
2014-01-11 09:13:44 +01:00
< span class = "nt" > " :method" < / span > < span class = "p" > :< / span > < span class = "s2" > " POST" < / span >
2014-01-11 09:08:37 +01:00
< span class = "p" > },< / span >
< span class = "p" > {< / span >
2014-01-11 09:13:44 +01:00
< span class = "nt" > " :path" < / span > < span class = "p" > :< / span > < span class = "s2" > " /account" < / span >
2014-01-11 09:08:37 +01:00
< span class = "p" > },< / span >
< span class = "p" > {< / span >
2014-01-11 09:13:44 +01:00
< span class = "nt" > " user-agent" < / span > < span class = "p" > :< / span > < span class = "s2" > " nghttp2" < / span >
2014-01-11 09:08:37 +01:00
< span class = "p" > },< / span >
< span class = "p" > {< / span >
2014-01-11 09:13:44 +01:00
< span class = "nt" > " :scheme" < / span > < span class = "p" > :< / span > < span class = "s2" > " https" < / span >
2014-01-11 09:08:37 +01:00
< span class = "p" > },< / span >
< span class = "p" > {< / span >
2014-01-11 09:13:44 +01:00
< span class = "nt" > " :authority" < / span > < span class = "p" > :< / span > < span class = "s2" > " example.org" < / span >
2014-01-11 09:08:37 +01:00
< span class = "p" > }< / span >
< span class = "p" > ],< / span >
2014-01-11 09:13:44 +01:00
< span class = "nt" > " header_table_size" < / span > < span class = "p" > :< / span > < span class = "mi" > 4096< / span >
2014-01-11 09:08:37 +01:00
< span class = "p" > }< / span >
< span class = "p" > ]< / span >
< span class = "p" > }< / span >
2013-10-28 16:24:56 +01:00
< / pre > < / div >
< / div >
2014-01-11 09:08:37 +01:00
< p > The output can be used as the input for < tt class = "docutils literal" > < span class = "pre" > deflatehd< / span > < / tt > and
< tt class = "docutils literal" > < span class = "pre" > inflatehd< / span > < / tt > .< / p >
< p > With < tt class = "docutils literal" > < span class = "pre" > -d< / span > < / tt > option, the extra < tt class = "docutils literal" > < span class = "pre" > header_table< / span > < / tt > key is added and its
2014-03-03 17:17:25 +01:00
associated value includes the state of dynamic header table after the
2014-04-08 17:17:05 +02:00
corresponding header set was processed. The format is the same as
2013-10-28 16:24:56 +01:00
< tt class = "docutils literal" > < span class = "pre" > deflatehd< / span > < / tt > .< / p >
< / div >
< / div >
2014-01-10 17:07:30 +01:00
< div class = "section" id = "python-bindings" >
< h2 > Python bindings< a class = "headerlink" href = "#python-bindings" title = "Permalink to this headline" > ¶< / a > < / h2 >
2014-04-08 17:17:05 +02:00
< p > This < tt class = "docutils literal" > < span class = "pre" > python< / span > < / tt > directory contains nghttp2 Python bindings. The
bindings currently provide HPACK compressor and decompressor classes
and HTTP/2 server.< / p >
2014-01-10 17:07:30 +01:00
< p > The extension module is called < tt class = "docutils literal" > < span class = "pre" > nghttp2< / span > < / tt > .< / p >
< p > < tt class = "docutils literal" > < span class = "pre" > make< / span > < / tt > will build the bindings and target Python version is
2014-04-08 17:17:05 +02:00
determined by configure script. If the detected Python version is not
2014-01-10 17:07:30 +01:00
what you expect, specify a path to Python executable in < tt class = "docutils literal" > < span class = "pre" > PYTHON< / span > < / tt >
variable as an argument to configure script (e.g., < tt class = "docutils literal" > < span class = "pre" > ./configure< / span >
2014-05-14 17:22:42 +02:00
< span class = "pre" > PYTHON=/usr/bin/python3.4< / span > < / tt > ).< / p >
2014-01-10 17:07:30 +01:00
< p > The following example code illustrates basic usage of HPACK compressor
and decompressor in Python:< / p >
2014-01-10 18:03:15 +01:00
< div class = "highlight-python" > < div class = "highlight" > < pre > < span class = "kn" > import< / span > < span class = "nn" > binascii< / span >
< span class = "kn" > import< / span > < span class = "nn" > nghttp2< / span >
2014-01-10 17:07:30 +01:00
2014-02-16 07:51:22 +01:00
< span class = "n" > deflater< / span > < span class = "o" > =< / span > < span class = "n" > nghttp2< / span > < span class = "o" > .< / span > < span class = "n" > HDDeflater< / span > < span class = "p" > ()< / span >
< span class = "n" > inflater< / span > < span class = "o" > =< / span > < span class = "n" > nghttp2< / span > < span class = "o" > .< / span > < span class = "n" > HDInflater< / span > < span class = "p" > ()< / span >
2014-01-10 17:07:30 +01:00
2014-01-10 18:03:15 +01:00
< span class = "n" > data< / span > < span class = "o" > =< / span > < span class = "n" > deflater< / span > < span class = "o" > .< / span > < span class = "n" > deflate< / span > < span class = "p" > ([(< / span > < span class = "n" > b< / span > < span class = "s" > ' foo' < / span > < span class = "p" > ,< / span > < span class = "n" > b< / span > < span class = "s" > ' bar' < / span > < span class = "p" > ),< / span >
< span class = "p" > (< / span > < span class = "n" > b< / span > < span class = "s" > ' baz' < / span > < span class = "p" > ,< / span > < span class = "n" > b< / span > < span class = "s" > ' buz' < / span > < span class = "p" > )])< / span >
< span class = "k" > print< / span > < span class = "p" > (< / span > < span class = "n" > binascii< / span > < span class = "o" > .< / span > < span class = "n" > b2a_hex< / span > < span class = "p" > (< / span > < span class = "n" > data< / span > < span class = "p" > ))< / span >
2014-01-10 17:07:30 +01:00
2014-01-10 18:03:15 +01:00
< span class = "n" > hdrs< / span > < span class = "o" > =< / span > < span class = "n" > inflater< / span > < span class = "o" > .< / span > < span class = "n" > inflate< / span > < span class = "p" > (< / span > < span class = "n" > data< / span > < span class = "p" > )< / span >
< span class = "k" > print< / span > < span class = "p" > (< / span > < span class = "n" > hdrs< / span > < span class = "p" > )< / span >
< / pre > < / div >
2014-01-10 17:07:30 +01:00
< / div >
2014-02-24 17:49:22 +01:00
< p > The < tt class = "docutils literal" > < span class = "pre" > nghttp2.HTTP2Server< / span > < / tt > class builds on top of the asyncio event
2014-04-08 17:17:05 +02:00
loop. On construction, < em > RequestHandlerClass< / em > must be given, which
must be a subclass of < tt class = "docutils literal" > < span class = "pre" > nghttp2.BaseRequestHandler< / span > < / tt > class.< / p >
< p > The < tt class = "docutils literal" > < span class = "pre" > BaseRequestHandler< / span > < / tt > class is used to handle the HTTP/2 stream.
By default, it does nothing. It must be subclassed to handle each
event callback method.< / p >
< p > The first callback method invoked is < tt class = "docutils literal" > < span class = "pre" > on_headers()< / span > < / tt > . It is called
2014-03-03 17:17:25 +01:00
when HEADERS frame, which includes request header fields, has arrived.< / p >
2014-02-24 17:49:22 +01:00
< p > If request has request body, < tt class = "docutils literal" > < span class = "pre" > on_data(data)< / span > < / tt > is invoked for each
chunk of received data.< / p >
< p > When whole request is received, < tt class = "docutils literal" > < span class = "pre" > on_request_done()< / span > < / tt > is invoked.< / p >
< p > When stream is closed, < tt class = "docutils literal" > < span class = "pre" > on_close(error_code)< / span > < / tt > is called.< / p >
2014-04-08 17:17:05 +02:00
< p > The application can send response using < tt class = "docutils literal" > < span class = "pre" > send_response()< / span > < / tt > method.
It can be used in < tt class = "docutils literal" > < span class = "pre" > on_headers()< / span > < / tt > , < tt class = "docutils literal" > < span class = "pre" > on_data()< / span > < / tt > or
2014-02-24 17:49:22 +01:00
< tt class = "docutils literal" > < span class = "pre" > on_request_done()< / span > < / tt > .< / p >
2014-04-08 17:17:05 +02:00
< p > The application can push resource using < tt class = "docutils literal" > < span class = "pre" > push()< / span > < / tt > method. It must be
2014-02-24 17:49:22 +01:00
used before < tt class = "docutils literal" > < span class = "pre" > send_response()< / span > < / tt > call.< / p >
< p > The following instance variables are available:< / p >
< dl class = "docutils" >
< dt > client_address< / dt >
< dd > Contains a tuple of the form (host, port) referring to the
client’ s address.< / dd >
< dt > stream_id< / dt >
2014-03-03 17:17:25 +01:00
< dd > Stream ID of this stream.< / dd >
2014-02-24 17:49:22 +01:00
< dt > scheme< / dt >
2014-04-08 17:17:05 +02:00
< dd > Scheme of the request URI. This is a value of :scheme header
field.< / dd >
2014-02-24 17:49:22 +01:00
< dt > method< / dt >
2014-04-08 17:17:05 +02:00
< dd > Method of this stream. This is a value of :method header field.< / dd >
2014-02-24 17:49:22 +01:00
< dt > host< / dt >
< dd > This is a value of :authority or host header field.< / dd >
< dt > path< / dt >
< dd > This is a value of :path header field.< / dd >
< / dl >
< p > The following example illustrates the HTTP2Server and
BaseRequestHandler usage:< / p >
< div class = "highlight-python" > < div class = "highlight" > < pre > < span class = "c" > #!/usr/bin/env python< / span >
< span class = "kn" > import< / span > < span class = "nn" > io< / span > < span class = "o" > ,< / span > < span class = "nn" > ssl< / span >
< span class = "kn" > import< / span > < span class = "nn" > nghttp2< / span >
< span class = "k" > class< / span > < span class = "nc" > Handler< / span > < span class = "p" > (< / span > < span class = "n" > nghttp2< / span > < span class = "o" > .< / span > < span class = "n" > BaseRequestHandler< / span > < span class = "p" > ):< / span >
< span class = "k" > def< / span > < span class = "nf" > on_headers< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ):< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > push< / span > < span class = "p" > (< / span > < span class = "n" > path< / span > < span class = "o" > =< / span > < span class = "s" > ' /css/bootstrap.css' < / span > < span class = "p" > ,< / span >
2014-02-25 16:02:26 +01:00
< span class = "n" > request_headers< / span > < span class = "o" > =< / span > < span class = "p" > [(< / span > < span class = "s" > ' content-length' < / span > < span class = "p" > ,< / span > < span class = "s" > ' 3' < / span > < span class = "p" > )],< / span >
2014-02-24 17:49:22 +01:00
< span class = "n" > status< / span > < span class = "o" > =< / span > < span class = "mi" > 200< / span > < span class = "p" > ,< / span >
< span class = "n" > body< / span > < span class = "o" > =< / span > < span class = "s" > ' foo' < / span > < span class = "p" > )< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > push< / span > < span class = "p" > (< / span > < span class = "n" > path< / span > < span class = "o" > =< / span > < span class = "s" > ' /js/bootstrap.js' < / span > < span class = "p" > ,< / span >
< span class = "n" > method< / span > < span class = "o" > =< / span > < span class = "s" > ' GET' < / span > < span class = "p" > ,< / span >
2014-02-25 16:02:26 +01:00
< span class = "n" > request_headers< / span > < span class = "o" > =< / span > < span class = "p" > [(< / span > < span class = "s" > ' content-length' < / span > < span class = "p" > ,< / span > < span class = "s" > ' 10' < / span > < span class = "p" > )],< / span >
2014-02-24 17:49:22 +01:00
< span class = "n" > status< / span > < span class = "o" > =< / span > < span class = "mi" > 200< / span > < span class = "p" > ,< / span >
< span class = "n" > body< / span > < span class = "o" > =< / span > < span class = "s" > ' foobarbuzz' < / span > < span class = "p" > )< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > send_response< / span > < span class = "p" > (< / span > < span class = "n" > status< / span > < span class = "o" > =< / span > < span class = "mi" > 200< / span > < span class = "p" > ,< / span >
2014-02-25 16:02:26 +01:00
< span class = "n" > headers< / span > < span class = "o" > =< / span > < span class = "p" > [(< / span > < span class = "s" > ' content-type' < / span > < span class = "p" > ,< / span > < span class = "s" > ' text/plain' < / span > < span class = "p" > )],< / span >
2014-02-24 17:49:22 +01:00
< span class = "n" > body< / span > < span class = "o" > =< / span > < span class = "n" > io< / span > < span class = "o" > .< / span > < span class = "n" > BytesIO< / span > < span class = "p" > (< / span > < span class = "n" > b< / span > < span class = "s" > ' nghttp2-python FTW' < / span > < span class = "p" > ))< / span >
< span class = "n" > ctx< / span > < span class = "o" > =< / span > < span class = "n" > ssl< / span > < span class = "o" > .< / span > < span class = "n" > SSLContext< / span > < span class = "p" > (< / span > < span class = "n" > ssl< / span > < span class = "o" > .< / span > < span class = "n" > PROTOCOL_SSLv23< / span > < span class = "p" > )< / span >
< span class = "n" > ctx< / span > < span class = "o" > .< / span > < span class = "n" > options< / span > < span class = "o" > =< / span > < span class = "n" > ssl< / span > < span class = "o" > .< / span > < span class = "n" > OP_ALL< / span > < span class = "o" > |< / span > < span class = "n" > ssl< / span > < span class = "o" > .< / span > < span class = "n" > OP_NO_SSLv2< / span >
< span class = "n" > ctx< / span > < span class = "o" > .< / span > < span class = "n" > load_cert_chain< / span > < span class = "p" > (< / span > < span class = "s" > ' server.crt' < / span > < span class = "p" > ,< / span > < span class = "s" > ' server.key' < / span > < span class = "p" > )< / span >
< span class = "c" > # give None to ssl to make the server non-SSL/TLS< / span >
< span class = "n" > server< / span > < span class = "o" > =< / span > < span class = "n" > nghttp2< / span > < span class = "o" > .< / span > < span class = "n" > HTTP2Server< / span > < span class = "p" > ((< / span > < span class = "s" > ' 127.0.0.1' < / span > < span class = "p" > ,< / span > < span class = "mi" > 8443< / span > < span class = "p" > ),< / span > < span class = "n" > Handler< / span > < span class = "p" > ,< / span > < span class = "n" > ssl< / span > < span class = "o" > =< / span > < span class = "n" > ctx< / span > < span class = "p" > )< / span >
< span class = "n" > server< / span > < span class = "o" > .< / span > < span class = "n" > serve_forever< / span > < span class = "p" > ()< / span >
< / pre > < / div >
2014-01-10 17:07:30 +01:00
< / div >
< / div >
2013-07-28 14:26:41 +02:00
< / div >
2014-02-02 10:36:57 +01:00
< / div >
2013-12-06 17:29:39 +01:00
< footer >
2014-02-02 10:36:57 +01:00
< div class = "rst-footer-buttons" role = "navigation" aria-label = "footer navigation" >
2013-12-06 17:29:39 +01:00
2014-05-16 17:06:42 +02:00
< a href = "tutorial-client.html" class = "btn btn-neutral float-right" title = "Tutorial: HTTP/2 client" > Next < span class = "fa fa-arrow-circle-right" > < / span > < / a >
2013-12-06 17:29:39 +01:00
2014-04-05 12:26:23 +02:00
< a href = "index.html" class = "btn btn-neutral" title = "nghttp2 - HTTP/2 C Library" > < span class = "fa fa-arrow-circle-left" > < / span > Previous< / a >
2013-12-06 17:29:39 +01:00
< / div >
< hr / >
2014-02-02 10:36:57 +01:00
< div role = "contentinfo" >
< p >
© Copyright 2012, 2014, Tatsuhiro Tsujikawa.
< / p >
< / div >
2013-07-28 14:26:41 +02:00
2014-02-02 10:36:57 +01:00
< a href = "https://github.com/snide/sphinx_rtd_theme" > Sphinx theme< / a > provided by < a href = "https://readthedocs.org" > Read the Docs< / a >
2013-12-06 17:29:39 +01:00
< / footer >
2013-07-28 14:26:41 +02:00
< / div >
< / div >
2013-12-06 17:29:39 +01:00
< / section >
< / div >
2014-05-16 17:06:42 +02:00
< script type = "text/javascript" >
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
2014-08-01 13:56:52 +02:00
VERSION:'0.5.2-DEV',
2014-05-16 17:06:42 +02:00
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: false
};
< / script >
< script type = "text/javascript" src = "_static/jquery.js" > < / script >
< script type = "text/javascript" src = "_static/underscore.js" > < / script >
< script type = "text/javascript" src = "_static/doctools.js" > < / script >
< script type = "text/javascript" src = "_static/js/theme.js" > < / script >
< script type = "text/javascript" >
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
< / script >
2013-12-06 17:29:39 +01:00
< / body >
2013-07-28 14:26:41 +02:00
< / html >
