<!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">
<title>nghttp2 - HTTP/2 C Library — nghttp2 1.38.0 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="index" title="Index"
href="genindex.html"/>
<link rel="search" title="Search" href="search.html"/>
<link rel="top" title="nghttp2 1.38.0 documentation" href="index.html"/>
<link rel="next" title="Contribution Guidelines" href="contribute.html"/>
<link rel="prev" title="nghttp2 - HTTP/2 C Library" href="index.html"/>
<script src="_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="index.html" class="icon icon-home"> nghttp2
</a>
<div class="version">
1.38.0
</div>
<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>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">nghttp2 - HTTP/2 C Library</a><ul>
<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="#building-nghttp2-from-release-tar-archive">Building nghttp2 from release tar archive</a></li>
<li class="toctree-l2"><a class="reference internal" href="#building-from-git">Building from git</a></li>
<li class="toctree-l2"><a class="reference internal" href="#notes-for-building-on-windows-msvc">Notes for building on Windows (MSVC)</a></li>
<li class="toctree-l2"><a class="reference internal" href="#notes-for-building-on-windows-mingw-cygwin">Notes for building on Windows (Mingw/Cygwin)</a></li>
<li class="toctree-l2"><a class="reference internal" href="#notes-for-installation-on-linux-systems">Notes for installation on Linux systems</a></li>
<li class="toctree-l2"><a class="reference internal" href="#building-the-documentation">Building the documentation</a></li>
<li class="toctree-l2"><a class="reference internal" href="#unit-tests">Unit tests</a></li>
<li class="toctree-l2"><a class="reference internal" href="#integration-tests">Integration tests</a></li>
<li class="toctree-l2"><a class="reference internal" href="#migration-from-v0-7-15-or-earlier">Migration from v0.7.15 or earlier</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#alpn-protocol-id-is-now-h2-and-h2c">ALPN protocol ID is now <code class="docutils literal notranslate"><span class="pre">h2</span></code> and <code class="docutils literal notranslate"><span class="pre">h2c</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#use-word-client-magic-where-we-use-client-connection-preface">Use word “client magic” where we use “client connection preface”</a></li>
<li class="toctree-l3"><a class="reference internal" href="#client-magic-is-sent-by-library">Client magic is sent by library</a></li>
<li class="toctree-l3"><a class="reference internal" href="#remove-http-alternative-services-alt-svc-related-code">Remove HTTP Alternative Services (Alt-Svc) related code</a></li>
<li class="toctree-l3"><a class="reference internal" href="#use-nghttp2-error-in-nghttp2-on-invalid-frame-recv-callback">Use nghttp2_error in nghttp2_on_invalid_frame_recv_callback</a></li>
<li class="toctree-l3"><a class="reference internal" href="#receive-client-magic-by-default">Receive client magic by default</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#client-server-and-proxy-programs">Client, Server and Proxy programs</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#nghttp-client">nghttp - client</a></li>
<li class="toctree-l3"><a class="reference internal" href="#nghttpd-server">nghttpd - server</a></li>
<li class="toctree-l3"><a class="reference internal" href="#nghttpx-proxy">nghttpx - proxy</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#benchmarking-tool">Benchmarking tool</a></li>
<li class="toctree-l2"><a class="reference internal" href="#hpack-tools">HPACK tools</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#deflatehd-header-compressor">deflatehd - header compressor</a></li>
<li class="toctree-l3"><a class="reference internal" href="#inflatehd-header-decompressor">inflatehd - header decompressor</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#libnghttp2-asio-high-level-http-2-c-library">libnghttp2_asio: High level HTTP/2 C++ library</a></li>
<li class="toctree-l2"><a class="reference internal" href="#python-bindings">Python bindings</a></li>
<li class="toctree-l2"><a class="reference internal" href="#contribution">Contribution</a></li>
<li class="toctree-l2"><a class="reference internal" href="#reporting-vulnerability">Reporting vulnerability</a></li>
<li class="toctree-l2"><a class="reference internal" href="#release-schedule">Release schedule</a></li>
<li class="toctree-l2"><a class="reference internal" href="#license">License</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="contribute.html">Contribution Guidelines</a></li>
<li class="toctree-l1"><a class="reference internal" href="building-android-binary.html">Building Android binary</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial-client.html">Tutorial: HTTP/2 client</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial-server.html">Tutorial: HTTP/2 server</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial-hpack.html">Tutorial: HPACK API</a></li>
<li class="toctree-l1"><a class="reference internal" href="nghttp.1.html">nghttp(1)</a></li>
<li class="toctree-l1"><a class="reference internal" href="nghttpd.1.html">nghttpd(1)</a></li>
<li class="toctree-l1"><a class="reference internal" href="nghttpx.1.html">nghttpx(1)</a></li>
<li class="toctree-l1"><a class="reference internal" href="h2load.1.html">h2load(1)</a></li>
<li class="toctree-l1"><a class="reference internal" href="nghttpx-howto.html">nghttpx - HTTP/2 proxy - HOW-TO</a></li>
<li class="toctree-l1"><a class="reference internal" href="h2load-howto.html">h2load - HTTP/2 benchmarking tool - HOW-TO</a></li>
<li class="toctree-l1"><a class="reference internal" href="programmers-guide.html">Programmers’ Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="apiref.html">API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="libnghttp2_asio.html">libnghttp2_asio: High level HTTP/2 C++ library</a></li>
<li class="toctree-l1"><a class="reference internal" href="python-apiref.html">Python API Reference</a></li>
<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>
<li class="toctree-l1"><a class="reference internal" href="asio_http2_server.h.html">asio_http2_server.h</a></li>
<li class="toctree-l1"><a class="reference internal" href="asio_http2_client.h.html">asio_http2_client.h</a></li>
<li class="toctree-l1"><a class="reference internal" href="asio_http2.h.html">asio_http2.h</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/nghttp2/nghttp2">Source</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/nghttp2/nghttp2/issues">Issues</a></li>
<li class="toctree-l1"><a class="reference external" href="https://nghttp2.org/">nghttp2.org</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">nghttp2</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> »</li>
<li>nghttp2 - HTTP/2 C Library</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<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>
<p>This is an implementation of the Hypertext Transfer Protocol version 2
in C.</p>
<p>The framing layer of HTTP/2 is implemented as a reusable C library.
On top of that, we have implemented an HTTP/2 client, server and
proxy. We have also developed load test and benchmarking tools for
HTTP/2.</p>
<p>An HPACK encoder and decoder are available as a public API.</p>
<p>An experimental high level C++ library is also available.</p>
<p>We have Python bindings of this library, but we do not have full
code coverage yet.</p>
<div class="section" id="development-status">
<h2>Development Status<a class="headerlink" href="#development-status" title="Permalink to this headline">¶</a></h2>
<p>We have implemented <a class="reference external" href="https://tools.ietf.org/html/rfc7540">RFC 7540</a>
HTTP/2 and <a class="reference external" href="https://tools.ietf.org/html/rfc7541">RFC 7541</a> HPACK -
Header Compression for HTTP/2</p>
<p>The nghttp2 code base was forked from the spdylay
(<a class="reference external" href="https://github.com/tatsuhiro-t/spdylay">https://github.com/tatsuhiro-t/spdylay</a>) project.</p>
</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 our nghttp2
implementation.</p>
<ul>
<li><p class="first"><a class="reference external" href="https://nghttp2.org/">https://nghttp2.org/</a> (TLS + ALPN/NPN)</p>
<p>This endpoint supports <code class="docutils literal notranslate"><span class="pre">h2</span></code>, <code class="docutils literal notranslate"><span class="pre">h2-16</span></code>, <code class="docutils literal notranslate"><span class="pre">h2-14</span></code>, and
<code class="docutils literal notranslate"><span class="pre">http/1.1</span></code> via ALPN/NPN and requires TLSv1.2 for HTTP/2
connection.</p>
</li>
<li><p class="first"><a class="reference external" href="http://nghttp2.org/">http://nghttp2.org/</a> (HTTP Upgrade and HTTP/2 Direct)</p>
<p><code class="docutils literal notranslate"><span class="pre">h2c</span></code> and <code class="docutils literal notranslate"><span class="pre">http/1.1</span></code>.</p>
</li>
</ul>
</div>
<div class="section" id="requirements">
<h2>Requirements<a class="headerlink" href="#requirements" title="Permalink to this headline">¶</a></h2>
<p>The following package is required to build the libnghttp2 library:</p>
<ul class="simple">
<li>pkg-config >= 0.20</li>
</ul>
<p>To build and run the unit test programs, the following package is
required:</p>
<ul class="simple">
<li>cunit >= 2.1</li>
</ul>
<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>
<p>If you need libnghttp2 (C library) only, then the above packages are
all you need. Use <code class="docutils literal notranslate"><span class="pre">--enable-lib-only</span></code> to ensure that only
libnghttp2 is built. This avoids potential build error related to
building bundled applications.</p>
<p>To build and run the application programs (<code class="docutils literal notranslate"><span class="pre">nghttp</span></code>, <code class="docutils literal notranslate"><span class="pre">nghttpd</span></code>,
<code class="docutils literal notranslate"><span class="pre">nghttpx</span></code> and <code class="docutils literal notranslate"><span class="pre">h2load</span></code>) in the <code class="docutils literal notranslate"><span class="pre">src</span></code> directory, the following packages
are required:</p>
<ul class="simple">
<li>OpenSSL >= 1.0.1</li>
<li>libev >= 4.11</li>
<li>zlib >= 1.2.3</li>
<li>libc-ares >= 1.7.5</li>
</ul>
<p>ALPN support requires OpenSSL >= 1.0.2 (released 22 January 2015).
LibreSSL >= 2.2.0 can be used instead of OpenSSL, but OpenSSL has more
features than LibreSSL at the time of this writing.</p>
<p>To enable <code class="docutils literal notranslate"><span class="pre">-a</span></code> option (getting linked assets from the downloaded
resource) in <code class="docutils literal notranslate"><span class="pre">nghttp</span></code>, the following package is required:</p>
<ul class="simple">
<li>libxml2 >= 2.6.26</li>
</ul>
<p>To enable systemd support in nghttpx, the following package is
required:</p>
<ul class="simple">
<li>libsystemd-dev >= 209</li>
</ul>
<p>The HPACK tools require the following package:</p>
<ul class="simple">
<li>jansson >= 2.5</li>
</ul>
<p>To build sources under the examples directory, libevent is required:</p>
<ul class="simple">
<li>libevent-openssl >= 2.0.8</li>
</ul>
<p>To mitigate heap fragmentation in long running server programs
(<code class="docutils literal notranslate"><span class="pre">nghttpd</span></code> and <code class="docutils literal notranslate"><span class="pre">nghttpx</span></code>), jemalloc is recommended:</p>
<ul>
<li><p class="first">jemalloc</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Alpine Linux currently does not support malloc replacement
due to musl limitations. See details in issue <a class="reference external" href="https://github.com/nghttp2/nghttp2/issues/762">#762</a>.</p>
</div>
</li>
</ul>
<p>libnghttp2_asio C++ library requires the following packages:</p>
<ul class="simple">
<li>libboost-dev >= 1.54.0</li>
<li>libboost-thread-dev >= 1.54.0</li>
</ul>
<p>The Python bindings require the following packages:</p>
<ul class="simple">
<li>cython >= 0.19</li>
<li>python >= 2.7</li>
<li>python-setuptools</li>
</ul>
<p>If you are using Ubuntu 16.04 LTS (Xenial Xerus) or Debian 8 (jessie)
and above, run the following to install the required packages:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>sudo apt-get install g++ make binutils autoconf automake autotools-dev libtool pkg-config \
zlib1g-dev libcunit1-dev libssl-dev libxml2-dev libev-dev libevent-dev libjansson-dev \
libc-ares-dev libjemalloc-dev libsystemd-dev \
cython python3-dev python-setuptools
</pre></div>
</div>
<p>To enable mruby support for nghttpx, <a class="reference external" href="https://github.com/mruby/mruby">mruby</a> is required. We need to build
mruby with C++ ABI explicitly turned on, and probably need other
mrgems, mruby is manged by git submodule under third-party/mruby
directory. Currently, mruby support for nghttpx is disabled by
default. To enable mruby support, use <code class="docutils literal notranslate"><span class="pre">--with-mruby</span></code> configure
option. Note that at the time of this writing, libmruby-dev and mruby
packages in Debian/Ubuntu are not usable for nghttp2, since they do
not enable C++ ABI. To build mruby, the following packages are
required:</p>
<ul class="simple">
<li>ruby</li>
<li>bison</li>
</ul>
<p>nghttpx supports <a class="reference external" href="https://github.com/h2o/neverbleed">neverbleed</a>,
privilege separation engine for OpenSSL / LibreSSL. In short, it
minimizes the risk of private key leakage when serious bug like
Heartbleed is exploited. The neverbleed is disabled by default. To
enable it, use <code class="docutils literal notranslate"><span class="pre">--with-neverbleed</span></code> configure option.</p>
<p>Compiling libnghttp2 C source code requires a C99 compiler. gcc 4.8
is known to be adequate. In order to compile the C++ source code, gcc
>= 6.0 or clang >= 6.0 is required. C++ source code requires C++14
language features.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">To enable mruby support in nghttpx, and use <code class="docutils literal notranslate"><span class="pre">--with-mruby</span></code>
configure option.</p>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Mac OS X users may need the <code class="docutils literal notranslate"><span class="pre">--disable-threads</span></code> configure option to
disable multi-threading in nghttpd, nghttpx and h2load to prevent
them from crashing. A patch is welcome to make multi threading work
on Mac OS X platform.</p>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">To compile the associated applications (nghttp, nghttpd, nghttpx
and h2load), you must use the <code class="docutils literal notranslate"><span class="pre">--enable-app</span></code> configure option and
ensure that the specified requirements above are met. Normally,
configure script checks required dependencies to build these
applications, and enable <code class="docutils literal notranslate"><span class="pre">--enable-app</span></code> automatically, so you
don’t have to use it explicitly. But if you found that
applications were not built, then using <code class="docutils literal notranslate"><span class="pre">--enable-app</span></code> may find
that cause, such as the missing dependency.</p>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p>In order to detect third party libraries, pkg-config is used
(however we don’t use pkg-config for some libraries (e.g., libev)).
By default, pkg-config searches <code class="docutils literal notranslate"><span class="pre">*.pc</span></code> file in the standard
locations (e.g., /usr/lib/pkgconfig). If it is necessary to use
<code class="docutils literal notranslate"><span class="pre">*.pc</span></code> file in the custom location, specify paths to
<code class="docutils literal notranslate"><span class="pre">PKG_CONFIG_PATH</span></code> environment variable, and pass it to configure
script, like so:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>$ ./configure PKG_CONFIG_PATH=/path/to/pkgconfig
</pre></div>
</div>
<p class="last">For pkg-config managed libraries, <code class="docutils literal notranslate"><span class="pre">*_CFLAG</span></code> and <code class="docutils literal notranslate"><span class="pre">*_LIBS</span></code>
environment variables are defined (e.g., <code class="docutils literal notranslate"><span class="pre">OPENSSL_CFLAGS</span></code>,
<code class="docutils literal notranslate"><span class="pre">OPENSSL_LIBS</span></code>). Specifying non-empty string to these variables
completely overrides pkg-config. In other words, if they are
specified, pkg-config is not used for detection, and user is
responsible to specify the correct values to these variables. For
complete list of these variables, run <code class="docutils literal notranslate"><span class="pre">./configure</span> <span class="pre">-h</span></code>.</p>
</div>
</div>
<div class="section" id="building-nghttp2-from-release-tar-archive">
<h2>Building nghttp2 from release tar archive<a class="headerlink" href="#building-nghttp2-from-release-tar-archive" title="Permalink to this headline">¶</a></h2>
<p>The nghttp2 project regularly releases tar archives which includes
nghttp2 source code, and generated build files. They can be
downloaded from <a class="reference external" href="https://github.com/nghttp2/nghttp2/releases">Releases</a> page.</p>
<p>Building nghttp2 from git requires autotools development packages.
Building from tar archives does not require them, and thus it is much
easier. The usual build step is as follows:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>$ tar xf nghttp2-X.Y.Z.tar.bz2
$ cd nghttp2-X.Y.Z
$ ./configure
$ make
</pre></div>
</div>
</div>
<div class="section" id="building-from-git">
<h2>Building from git<a class="headerlink" href="#building-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>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>$ git submodule update --init
$ autoreconf -i
$ automake
$ autoconf
$ ./configure
$ make
</pre></div>
</div>
</div>
<div class="section" id="notes-for-building-on-windows-msvc">
<h2>Notes for building on Windows (MSVC)<a class="headerlink" href="#notes-for-building-on-windows-msvc" title="Permalink to this headline">¶</a></h2>
<p>The easiest way to build native Windows nghttp2 dll is use <a class="reference external" href="https://cmake.org/">cmake</a>. The free version of <a class="reference external" href="http://landinghub.visualstudio.com/visual-cpp-build-tools">Visual C++ Build Tools</a> works
fine.</p>
<ol class="arabic simple">
<li>Install cmake for windows</li>
<li>Open “Visual C++ … Native Build Tool Command Prompt”, and inside
nghttp2 directly, run <code class="docutils literal notranslate"><span class="pre">cmake</span></code>.</li>
<li>Then run <code class="docutils literal notranslate"><span class="pre">cmake</span> <span class="pre">--build</span></code> to build library.</li>
<li>nghttp2.dll, nghttp2.lib, nghttp2.exp are placed under lib directory.</li>
</ol>
<p>Note that the above steps most likely produce nghttp2 library only.
No bundled applications are compiled.</p>
</div>
<div class="section" id="notes-for-building-on-windows-mingw-cygwin">
<h2>Notes for building on Windows (Mingw/Cygwin)<a class="headerlink" href="#notes-for-building-on-windows-mingw-cygwin" title="Permalink to this headline">¶</a></h2>
<p>Under Mingw environment, you can only compile the library, it’s
<code class="docutils literal notranslate"><span class="pre">libnghttp2-X.dll</span></code> and <code class="docutils literal notranslate"><span class="pre">libnghttp2.a</span></code>.</p>
<p>If you want to compile the applications(<code class="docutils literal notranslate"><span class="pre">h2load</span></code>, <code class="docutils literal notranslate"><span class="pre">nghttp</span></code>,
<code class="docutils literal notranslate"><span class="pre">nghttpx</span></code>, <code class="docutils literal notranslate"><span class="pre">nghttpd</span></code>), you need to use the Cygwin environment.</p>
<p>Under Cygwin environment, to compile the applications you need to
compile and install the libev first.</p>
<p>Secondly, you need to undefine the macro <code class="docutils literal notranslate"><span class="pre">__STRICT_ANSI__</span></code>, if you
not, the functions <code class="docutils literal notranslate"><span class="pre">fdopen</span></code>, <code class="docutils literal notranslate"><span class="pre">fileno</span></code> and <code class="docutils literal notranslate"><span class="pre">strptime</span></code> will not
available.</p>
<p>the sample command like this:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>$ export CFLAGS="-U__STRICT_ANSI__ -I$libev_PREFIX/include -L$libev_PREFIX/lib"
$ export CXXFLAGS=$CFLAGS
$ ./configure
$ make
</pre></div>
</div>
<p>If you want to compile the applications under <code class="docutils literal notranslate"><span class="pre">examples/</span></code>, you need
to remove or rename the <code class="docutils literal notranslate"><span class="pre">event.h</span></code> from libev’s installation, because
it conflicts with libevent’s installation.</p>
</div>
<div class="section" id="notes-for-installation-on-linux-systems">
<h2>Notes for installation on Linux systems<a class="headerlink" href="#notes-for-installation-on-linux-systems" title="Permalink to this headline">¶</a></h2>
<p>After installing nghttp2 tool suite with <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">install</span></code> one might experience a similar error:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>nghttpx: error while loading shared libraries: libnghttp2.so.14: cannot open shared object file: No such file or directory
</pre></div>
</div>
<p>This means that the tool is unable to locate the <code class="docutils literal notranslate"><span class="pre">libnghttp2.so</span></code> shared library.</p>
<p>To update the shared library cache run <code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">ldconfig</span></code>.</p>
</div>
<div class="section" id="building-the-documentation">
<h2>Building the documentation<a class="headerlink" href="#building-the-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 the documentation, run:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>$ make html
</pre></div>
</div>
<p>The documents will be generated under <code class="docutils literal notranslate"><span class="pre">doc/manual/html/</span></code>.</p>
<p>The generated documents will not be installed with <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">install</span></code>.</p>
<p>The online documentation is available at
<a class="reference external" href="https://nghttp2.org/documentation/">https://nghttp2.org/documentation/</a></p>
</div>
<div class="section" id="unit-tests">
<h2>Unit tests<a class="headerlink" href="#unit-tests" title="Permalink to this headline">¶</a></h2>
<p>Unit tests are done by simply running <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">check</span></code>.</p>
</div>
<div class="section" id="integration-tests">
<h2>Integration tests<a class="headerlink" href="#integration-tests" title="Permalink to this headline">¶</a></h2>
<p>We have the integration tests for the nghttpx proxy server. The tests are
written in the <a class="reference external" href="http://golang.org/">Go programming language</a> and uses
its testing framework. We depend on the following libraries:</p>
<ul class="simple">
<li>golang.org/x/net/http2</li>
<li>golang.org/x/net/websocket</li>
<li><a class="reference external" href="https://github.com/tatsuhiro-t/go-nghttp2">https://github.com/tatsuhiro-t/go-nghttp2</a></li>
</ul>
<p>To download the above packages, after settings <code class="docutils literal notranslate"><span class="pre">GOPATH</span></code>, run the
following command under <code class="docutils literal notranslate"><span class="pre">integration-tests</span></code> directory:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>$ make itprep
</pre></div>
</div>
<p>To run the tests, run the following command under
<code class="docutils literal notranslate"><span class="pre">integration-tests</span></code> directory:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>$ make it
</pre></div>
</div>
<p>Inside the tests, we use port 3009 to run the test subject server.</p>
</div>
<div class="section" id="migration-from-v0-7-15-or-earlier">
<h2>Migration from v0.7.15 or earlier<a class="headerlink" href="#migration-from-v0-7-15-or-earlier" title="Permalink to this headline">¶</a></h2>
<p>nghttp2 v1.0.0 introduced several backward incompatible changes. In
this section, we describe these changes and how to migrate to v1.0.0.</p>
<div class="section" id="alpn-protocol-id-is-now-h2-and-h2c">
<h3>ALPN protocol ID is now <code class="docutils literal notranslate"><span class="pre">h2</span></code> and <code class="docutils literal notranslate"><span class="pre">h2c</span></code><a class="headerlink" href="#alpn-protocol-id-is-now-h2-and-h2c" title="Permalink to this headline">¶</a></h3>
<p>Previously we announced <code class="docutils literal notranslate"><span class="pre">h2-14</span></code> and <code class="docutils literal notranslate"><span class="pre">h2c-14</span></code>. v1.0.0 implements
final protocol version, and we changed ALPN ID to <code class="docutils literal notranslate"><span class="pre">h2</span></code> and <code class="docutils literal notranslate"><span class="pre">h2c</span></code>.
The macros <code class="docutils literal notranslate"><span class="pre">NGHTTP2_PROTO_VERSION_ID</span></code>,
<code class="docutils literal notranslate"><span class="pre">NGHTTP2_PROTO_VERSION_ID_LEN</span></code>,
<code class="docutils literal notranslate"><span class="pre">NGHTTP2_CLEARTEXT_PROTO_VERSION_ID</span></code>, and
<code class="docutils literal notranslate"><span class="pre">NGHTTP2_CLEARTEXT_PROTO_VERSION_ID_LEN</span></code> have been updated to
reflect this change.</p>
<p>Basically, existing applications do not have to do anything, just
recompiling is enough for this change.</p>
</div>
<div class="section" id="use-word-client-magic-where-we-use-client-connection-preface">
<h3>Use word “client magic” where we use “client connection preface”<a class="headerlink" href="#use-word-client-magic-where-we-use-client-connection-preface" title="Permalink to this headline">¶</a></h3>
<p>We use “client connection preface” to mean first 24 bytes of client
connection preface. This is technically not correct, since client
connection preface is composed of 24 bytes client magic byte string
followed by SETTINGS frame. For clarification, we call “client magic”
for this 24 bytes byte string and updated API.</p>
<ul class="simple">
<li><code class="docutils literal notranslate"><span class="pre">NGHTTP2_CLIENT_CONNECTION_PREFACE</span></code> was replaced with
<code class="docutils literal notranslate"><span class="pre">NGHTTP2_CLIENT_MAGIC</span></code>.</li>
<li><code class="docutils literal notranslate"><span class="pre">NGHTTP2_CLIENT_CONNECTION_PREFACE_LEN</span></code> was replaced with
<code class="docutils literal notranslate"><span class="pre">NGHTTP2_CLIENT_MAGIC_LEN</span></code>.</li>
<li><code class="docutils literal notranslate"><span class="pre">NGHTTP2_BAD_PREFACE</span></code> was renamed as <code class="docutils literal notranslate"><span class="pre">NGHTTP2_BAD_CLIENT_MAGIC</span></code></li>
</ul>
<p>The already deprecated <code class="docutils literal notranslate"><span class="pre">NGHTTP2_CLIENT_CONNECTION_HEADER</span></code> and
<code class="docutils literal notranslate"><span class="pre">NGHTTP2_CLIENT_CONNECTION_HEADER_LEN</span></code> were removed.</p>
<p>If application uses these macros, just replace old ones with new ones.
Since v1.0.0, client magic is sent by library (see next subsection),
so client application may just remove these macro use.</p>
</div>
<div class="section" id="client-magic-is-sent-by-library">
<h3>Client magic is sent by library<a class="headerlink" href="#client-magic-is-sent-by-library" title="Permalink to this headline">¶</a></h3>
<p>Previously nghttp2 library did not send client magic, which is first
24 bytes byte string of client connection preface, and client
applications have to send it by themselves. Since v1.0.0, client
magic is sent by library via first call of <code class="docutils literal notranslate"><span class="pre">nghttp2_session_send()</span></code>
or <code class="docutils literal notranslate"><span class="pre">nghttp2_session_mem_send()</span></code>.</p>
<p>The client applications which send client magic must remove the
relevant code.</p>
</div>
<div class="section" id="remove-http-alternative-services-alt-svc-related-code">
<h3>Remove HTTP Alternative Services (Alt-Svc) related code<a class="headerlink" href="#remove-http-alternative-services-alt-svc-related-code" title="Permalink to this headline">¶</a></h3>
<p>Alt-Svc specification is not finalized yet. To make our API stable,
we have decided to remove all Alt-Svc related API from nghttp2.</p>
<ul class="simple">
<li><code class="docutils literal notranslate"><span class="pre">NGHTTP2_EXT_ALTSVC</span></code> was removed.</li>
<li><code class="docutils literal notranslate"><span class="pre">nghttp2_ext_altsvc</span></code> was removed.</li>
</ul>
<p>We have already removed the functionality of Alt-Svc in v0.7 series
and they have been essentially noop. The application using these
macro and struct, remove those lines.</p>
</div>
<div class="section" id="use-nghttp2-error-in-nghttp2-on-invalid-frame-recv-callback">
<h3>Use nghttp2_error in nghttp2_on_invalid_frame_recv_callback<a class="headerlink" href="#use-nghttp2-error-in-nghttp2-on-invalid-frame-recv-callback" title="Permalink to this headline">¶</a></h3>
<p>Previously <code class="docutils literal notranslate"><span class="pre">nghttp2_on_invalid_frame_recv_cb_called</span></code> took the
<code class="docutils literal notranslate"><span class="pre">error_code</span></code>, defined in <code class="docutils literal notranslate"><span class="pre">nghttp2_error_code</span></code>, as parameter. But
they are not detailed enough to debug. Therefore, we decided to use
more detailed <code class="docutils literal notranslate"><span class="pre">nghttp2_error</span></code> values instead.</p>
<p>The application using this callback should update the callback
signature. If it treats <code class="docutils literal notranslate"><span class="pre">error_code</span></code> as HTTP/2 error code, update
the code so that it is treated as <code class="docutils literal notranslate"><span class="pre">nghttp2_error</span></code>.</p>
</div>
<div class="section" id="receive-client-magic-by-default">
<h3>Receive client magic by default<a class="headerlink" href="#receive-client-magic-by-default" title="Permalink to this headline">¶</a></h3>
<p>Previously nghttp2 did not process client magic (24 bytes byte
string). To make it deal with it, we had to use
<code class="docutils literal notranslate"><span class="pre">nghttp2_option_set_recv_client_preface()</span></code>. Since v1.0.0, nghttp2
processes client magic by default and
<code class="docutils literal notranslate"><span class="pre">nghttp2_option_set_recv_client_preface()</span></code> was removed.</p>
<p>Some application may want to disable this behaviour, so we added
<code class="docutils literal notranslate"><span class="pre">nghttp2_option_set_no_recv_client_magic()</span></code> to achieve this.</p>
<p>The application using <code class="docutils literal notranslate"><span class="pre">nghttp2_option_set_recv_client_preface()</span></code>
with nonzero value, just remove it.</p>
<p>The application using <code class="docutils literal notranslate"><span class="pre">nghttp2_option_set_recv_client_preface()</span></code>
with zero value or not using it must use
<code class="docutils literal notranslate"><span class="pre">nghttp2_option_set_no_recv_client_magic()</span></code> with nonzero value.</p>
</div>
</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>
<p>The <code class="docutils literal notranslate"><span class="pre">src</span></code> directory contains the HTTP/2 client, server and proxy programs.</p>
<div class="section" id="nghttp-client">
<h3>nghttp - client<a class="headerlink" href="#nghttp-client" title="Permalink to this headline">¶</a></h3>
<p><code class="docutils literal notranslate"><span class="pre">nghttp</span></code> is a HTTP/2 client. It can connect to the HTTP/2 server
with prior knowledge, HTTP Upgrade and NPN/ALPN TLS extension.</p>
<p>It has verbose output mode for framing information. Here is sample
output from <code class="docutils literal notranslate"><span class="pre">nghttp</span></code> client:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>$ nghttp -nv https://nghttp2.org
[ 0.190] Connected
The negotiated protocol: h2
[ 0.212] recv SETTINGS frame <length=12, flags=0x00, stream_id=0>
(niv=2)
[SETTINGS_MAX_CONCURRENT_STREAMS(0x03):100]
[SETTINGS_INITIAL_WINDOW_SIZE(0x04):65535]
[ 0.212] send SETTINGS frame <length=12, flags=0x00, stream_id=0>
(niv=2)
[SETTINGS_MAX_CONCURRENT_STREAMS(0x03):100]
[SETTINGS_INITIAL_WINDOW_SIZE(0x04):65535]
[ 0.212] send SETTINGS frame <length=0, flags=0x01, stream_id=0>
; ACK
(niv=0)
[ 0.212] send PRIORITY frame <length=5, flags=0x00, stream_id=3>
(dep_stream_id=0, weight=201, exclusive=0)
[ 0.212] send PRIORITY frame <length=5, flags=0x00, stream_id=5>
(dep_stream_id=0, weight=101, exclusive=0)
[ 0.212] send PRIORITY frame <length=5, flags=0x00, stream_id=7>
(dep_stream_id=0, weight=1, exclusive=0)
[ 0.212] send PRIORITY frame <length=5, flags=0x00, stream_id=9>
(dep_stream_id=7, weight=1, exclusive=0)
[ 0.212] send PRIORITY frame <length=5, flags=0x00, stream_id=11>
(dep_stream_id=3, weight=1, exclusive=0)
[ 0.212] send HEADERS frame <length=39, flags=0x25, stream_id=13>
; END_STREAM | END_HEADERS | PRIORITY
(padlen=0, dep_stream_id=11, weight=16, exclusive=0)
; Open new stream
:method: GET
:path: /
:scheme: https
:authority: nghttp2.org
accept: */*
accept-encoding: gzip, deflate
user-agent: nghttp2/1.0.1-DEV
[ 0.221] recv SETTINGS frame <length=0, flags=0x01, stream_id=0>
; ACK
(niv=0)
[ 0.221] recv (stream_id=13) :method: GET
[ 0.221] recv (stream_id=13) :scheme: https
[ 0.221] recv (stream_id=13) :path: /stylesheets/screen.css
[ 0.221] recv (stream_id=13) :authority: nghttp2.org
[ 0.221] recv (stream_id=13) accept-encoding: gzip, deflate
[ 0.222] recv (stream_id=13) user-agent: nghttp2/1.0.1-DEV
[ 0.222] recv PUSH_PROMISE frame <length=50, flags=0x04, stream_id=13>
; END_HEADERS
(padlen=0, promised_stream_id=2)
[ 0.222] recv (stream_id=13) :status: 200
[ 0.222] recv (stream_id=13) date: Thu, 21 May 2015 16:38:14 GMT
[ 0.222] recv (stream_id=13) content-type: text/html
[ 0.222] recv (stream_id=13) last-modified: Fri, 15 May 2015 15:38:06 GMT
[ 0.222] recv (stream_id=13) etag: W/"555612de-19f6"
[ 0.222] recv (stream_id=13) link: </stylesheets/screen.css>; rel=preload; as=stylesheet
[ 0.222] recv (stream_id=13) content-encoding: gzip
[ 0.222] recv (stream_id=13) server: nghttpx nghttp2/1.0.1-DEV
[ 0.222] recv (stream_id=13) via: 1.1 nghttpx
[ 0.222] recv (stream_id=13) strict-transport-security: max-age=31536000
[ 0.222] recv HEADERS frame <length=166, flags=0x04, stream_id=13>
; END_HEADERS
(padlen=0)
; First response header
[ 0.222] recv DATA frame <length=2601, flags=0x01, stream_id=13>
; END_STREAM
[ 0.222] recv (stream_id=2) :status: 200
[ 0.222] recv (stream_id=2) date: Thu, 21 May 2015 16:38:14 GMT
[ 0.222] recv (stream_id=2) content-type: text/css
[ 0.222] recv (stream_id=2) last-modified: Fri, 15 May 2015 15:38:06 GMT
[ 0.222] recv (stream_id=2) etag: W/"555612de-9845"
[ 0.222] recv (stream_id=2) content-encoding: gzip
[ 0.222] recv (stream_id=2) server: nghttpx nghttp2/1.0.1-DEV
[ 0.222] recv (stream_id=2) via: 1.1 nghttpx
[ 0.222] recv (stream_id=2) strict-transport-security: max-age=31536000
[ 0.222] recv HEADERS frame <length=32, flags=0x04, stream_id=2>
; END_HEADERS
(padlen=0)
; First push response header
[ 0.228] recv DATA frame <length=8715, flags=0x01, stream_id=2>
; END_STREAM
[ 0.228] send GOAWAY frame <length=8, flags=0x00, stream_id=0>
(last_stream_id=2, error_code=NO_ERROR(0x00), opaque_data(0)=[])
</pre></div>
</div>
<p>The HTTP Upgrade is performed like so:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>$ nghttp -nvu http://nghttp2.org
[ 0.011] Connected
[ 0.011] HTTP Upgrade request
GET / HTTP/1.1
Host: nghttp2.org
Connection: Upgrade, HTTP2-Settings
Upgrade: h2c
HTTP2-Settings: AAMAAABkAAQAAP__
Accept: */*
User-Agent: nghttp2/1.0.1-DEV
[ 0.018] HTTP Upgrade response
HTTP/1.1 101 Switching Protocols
Connection: Upgrade
Upgrade: h2c
[ 0.018] HTTP Upgrade success
[ 0.018] recv SETTINGS frame <length=12, flags=0x00, stream_id=0>
(niv=2)
[SETTINGS_MAX_CONCURRENT_STREAMS(0x03):100]
[SETTINGS_INITIAL_WINDOW_SIZE(0x04):65535]
[ 0.018] send SETTINGS frame <length=12, flags=0x00, stream_id=0>
(niv=2)
[SETTINGS_MAX_CONCURRENT_STREAMS(0x03):100]
[SETTINGS_INITIAL_WINDOW_SIZE(0x04):65535]
[ 0.018] send SETTINGS frame <length=0, flags=0x01, stream_id=0>
; ACK
(niv=0)
[ 0.018] send PRIORITY frame <length=5, flags=0x00, stream_id=3>
(dep_stream_id=0, weight=201, exclusive=0)
[ 0.018] send PRIORITY frame <length=5, flags=0x00, stream_id=5>
(dep_stream_id=0, weight=101, exclusive=0)
[ 0.018] send PRIORITY frame <length=5, flags=0x00, stream_id=7>
(dep_stream_id=0, weight=1, exclusive=0)
[ 0.018] send PRIORITY frame <length=5, flags=0x00, stream_id=9>
(dep_stream_id=7, weight=1, exclusive=0)
[ 0.018] send PRIORITY frame <length=5, flags=0x00, stream_id=11>
(dep_stream_id=3, weight=1, exclusive=0)
[ 0.018] send PRIORITY frame <length=5, flags=0x00, stream_id=1>
(dep_stream_id=11, weight=16, exclusive=0)
[ 0.019] recv (stream_id=1) :method: GET
[ 0.019] recv (stream_id=1) :scheme: http
[ 0.019] recv (stream_id=1) :path: /stylesheets/screen.css
[ 0.019] recv (stream_id=1) host: nghttp2.org
[ 0.019] recv (stream_id=1) user-agent: nghttp2/1.0.1-DEV
[ 0.019] recv PUSH_PROMISE frame <length=49, flags=0x04, stream_id=1>
; END_HEADERS
(padlen=0, promised_stream_id=2)
[ 0.019] recv (stream_id=1) :status: 200
[ 0.019] recv (stream_id=1) date: Thu, 21 May 2015 16:39:16 GMT
[ 0.019] recv (stream_id=1) content-type: text/html
[ 0.019] recv (stream_id=1) content-length: 6646
[ 0.019] recv (stream_id=1) last-modified: Fri, 15 May 2015 15:38:06 GMT
[ 0.019] recv (stream_id=1) etag: "555612de-19f6"
[ 0.019] recv (stream_id=1) link: </stylesheets/screen.css>; rel=preload; as=stylesheet
[ 0.019] recv (stream_id=1) accept-ranges: bytes
[ 0.019] recv (stream_id=1) server: nghttpx nghttp2/1.0.1-DEV
[ 0.019] recv (stream_id=1) via: 1.1 nghttpx
[ 0.019] recv HEADERS frame <length=157, flags=0x04, stream_id=1>
; END_HEADERS
(padlen=0)
; First response header
[ 0.019] recv DATA frame <length=6646, flags=0x01, stream_id=1>
; END_STREAM
[ 0.019] recv (stream_id=2) :status: 200
[ 0.019] recv (stream_id=2) date: Thu, 21 May 2015 16:39:16 GMT
[ 0.019] recv (stream_id=2) content-type: text/css
[ 0.019] recv (stream_id=2) content-length: 38981
[ 0.019] recv (stream_id=2) last-modified: Fri, 15 May 2015 15:38:06 GMT
[ 0.019] recv (stream_id=2) etag: "555612de-9845"
[ 0.019] recv (stream_id=2) accept-ranges: bytes
[ 0.019] recv (stream_id=2) server: nghttpx nghttp2/1.0.1-DEV
[ 0.019] recv (stream_id=2) via: 1.1 nghttpx
[ 0.019] recv HEADERS frame <length=36, flags=0x04, stream_id=2>
; END_HEADERS
(padlen=0)
; First push response header
[ 0.026] recv DATA frame <length=16384, flags=0x00, stream_id=2>
[ 0.027] recv DATA frame <length=7952, flags=0x00, stream_id=2>
[ 0.027] send WINDOW_UPDATE frame <length=4, flags=0x00, stream_id=0>
(window_size_increment=33343)
[ 0.032] send WINDOW_UPDATE frame <length=4, flags=0x00, stream_id=2>
(window_size_increment=33707)
[ 0.032] recv DATA frame <length=14645, flags=0x01, stream_id=2>
; END_STREAM
[ 0.032] recv SETTINGS frame <length=0, flags=0x01, stream_id=0>
; ACK
(niv=0)
[ 0.032] send GOAWAY frame <length=8, flags=0x00, stream_id=0>
(last_stream_id=2, error_code=NO_ERROR(0x00), opaque_data(0)=[])
</pre></div>
</div>
<p>Using the <code class="docutils literal notranslate"><span class="pre">-s</span></code> option, <code class="docutils literal notranslate"><span class="pre">nghttp</span></code> prints out some timing information for
requests, sorted by completion time:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>$ nghttp -nas https://nghttp2.org/
***** Statistics *****
Request timing:
responseEnd: the time when last byte of response was received
relative to connectEnd
requestStart: the time just before first byte of request was sent
relative to connectEnd. If '*' is shown, this was
pushed by server.
process: responseEnd - requestStart
code: HTTP status code
size: number of bytes received as response body without
inflation.
URI: request URI
see http://www.w3.org/TR/resource-timing/#processing-model
sorted by 'complete'
id responseEnd requestStart process code size request path
13 +37.19ms +280us 36.91ms 200 2K /
2 +72.65ms * +36.38ms 36.26ms 200 8K /stylesheets/screen.css
17 +77.43ms +38.67ms 38.75ms 200 3K /javascripts/octopress.js
15 +78.12ms +38.66ms 39.46ms 200 3K /javascripts/modernizr-2.0.js
</pre></div>
</div>
<p>Using the <code class="docutils literal notranslate"><span class="pre">-r</span></code> option, <code class="docutils literal notranslate"><span class="pre">nghttp</span></code> writes more detailed timing data to
the given file in HAR format.</p>
</div>
<div class="section" id="nghttpd-server">
<h3>nghttpd - server<a class="headerlink" href="#nghttpd-server" title="Permalink to this headline">¶</a></h3>
<p><code class="docutils literal notranslate"><span class="pre">nghttpd</span></code> is a multi-threaded static web server.</p>
<p>By default, it uses SSL/TLS connection. Use <code class="docutils literal notranslate"><span class="pre">--no-tls</span></code> option to
disable it.</p>
<p><code class="docutils literal notranslate"><span class="pre">nghttpd</span></code> only accepts HTTP/2 connections via NPN/ALPN or direct
HTTP/2 connections. No HTTP Upgrade is supported.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">-p</span></code> option allows users to configure server push.</p>
<p>Just like <code class="docutils literal notranslate"><span class="pre">nghttp</span></code>, it has a verbose output mode for framing
information. Here is sample output from <code class="docutils literal notranslate"><span class="pre">nghttpd</span></code>:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>$ nghttpd --no-tls -v 8080
IPv4: listen 0.0.0.0:8080
IPv6: listen :::8080
[id=1] [ 1.521] send SETTINGS frame <length=6, flags=0x00, stream_id=0>
(niv=1)
[SETTINGS_MAX_CONCURRENT_STREAMS(0x03):100]
[id=1] [ 1.521] recv SETTINGS frame <length=12, flags=0x00, stream_id=0>
(niv=2)
[SETTINGS_MAX_CONCURRENT_STREAMS(0x03):100]
[SETTINGS_INITIAL_WINDOW_SIZE(0x04):65535]
[id=1] [ 1.521] recv SETTINGS frame <length=0, flags=0x01, stream_id=0>
; ACK
(niv=0)
[id=1] [ 1.521] recv PRIORITY frame <length=5, flags=0x00, stream_id=3>
(dep_stream_id=0, weight=201, exclusive=0)
[id=1] [ 1.521] recv PRIORITY frame <length=5, flags=0x00, stream_id=5>
(dep_stream_id=0, weight=101, exclusive=0)
[id=1] [ 1.521] recv PRIORITY frame <length=5, flags=0x00, stream_id=7>
(dep_stream_id=0, weight=1, exclusive=0)
[id=1] [ 1.521] recv PRIORITY frame <length=5, flags=0x00, stream_id=9>
(dep_stream_id=7, weight=1, exclusive=0)
[id=1] [ 1.521] recv PRIORITY frame <length=5, flags=0x00, stream_id=11>
(dep_stream_id=3, weight=1, exclusive=0)
[id=1] [ 1.521] recv (stream_id=13) :method: GET
[id=1] [ 1.521] recv (stream_id=13) :path: /
[id=1] [ 1.521] recv (stream_id=13) :scheme: http
[id=1] [ 1.521] recv (stream_id=13) :authority: localhost:8080
[id=1] [ 1.521] recv (stream_id=13) accept: */*
[id=1] [ 1.521] recv (stream_id=13) accept-encoding: gzip, deflate
[id=1] [ 1.521] recv (stream_id=13) user-agent: nghttp2/1.0.0-DEV
[id=1] [ 1.521] recv HEADERS frame <length=41, flags=0x25, stream_id=13>
; END_STREAM | END_HEADERS | PRIORITY
(padlen=0, dep_stream_id=11, weight=16, exclusive=0)
; Open new stream
[id=1] [ 1.521] send SETTINGS frame <length=0, flags=0x01, stream_id=0>
; ACK
(niv=0)
[id=1] [ 1.521] send HEADERS frame <length=86, flags=0x04, stream_id=13>
; END_HEADERS
(padlen=0)
; First response header
:status: 200
server: nghttpd nghttp2/1.0.0-DEV
content-length: 10
cache-control: max-age=3600
date: Fri, 15 May 2015 14:49:04 GMT
last-modified: Tue, 30 Sep 2014 12:40:52 GMT
[id=1] [ 1.522] send DATA frame <length=10, flags=0x01, stream_id=13>
; END_STREAM
[id=1] [ 1.522] stream_id=13 closed
[id=1] [ 1.522] recv GOAWAY frame <length=8, flags=0x00, stream_id=0>
(last_stream_id=0, error_code=NO_ERROR(0x00), opaque_data(0)=[])
[id=1] [ 1.522] closed
</pre></div>
</div>
</div>
<div class="section" id="nghttpx-proxy">
<h3>nghttpx - proxy<a class="headerlink" href="#nghttpx-proxy" title="Permalink to this headline">¶</a></h3>
<p><code class="docutils literal notranslate"><span class="pre">nghttpx</span></code> is a multi-threaded reverse proxy for HTTP/2, and
HTTP/1.1, and powers <a class="reference external" href="http://nghttp2.org">http://nghttp2.org</a> and supports HTTP/2 server
push.</p>
<p>We reworked <code class="docutils literal notranslate"><span class="pre">nghttpx</span></code> command-line interface, and as a result, there
are several incompatibles from 1.8.0 or earlier. This is necessary to
extend its capability, and secure the further feature enhancements in
the future release. Please read <a class="reference external" href="https://nghttp2.org/documentation/nghttpx-howto.html#migration-from-nghttpx-v1-8-0-or-earlier">Migration from nghttpx v1.8.0 or
earlier</a>
to know how to migrate from earlier releases.</p>
<p><code class="docutils literal notranslate"><span class="pre">nghttpx</span></code> implements <a class="reference external" href="https://istlsfastyet.com/#server-performance">important performance-oriented features</a> in TLS, such as
session IDs, session tickets (with automatic key rotation), OCSP
stapling, dynamic record sizing, ALPN/NPN, forward secrecy and HTTP/2.
<code class="docutils literal notranslate"><span class="pre">nghttpx</span></code> also offers the functionality to share session cache and
ticket keys among multiple <code class="docutils literal notranslate"><span class="pre">nghttpx</span></code> instances via memcached.</p>
<p><code class="docutils literal notranslate"><span class="pre">nghttpx</span></code> has 2 operation modes:</p>
<table border="1" class="docutils">
<colgroup>
<col width="29%" />
<col width="25%" />
<col width="25%" />
<col width="21%" />
</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">
<tr class="row-even"><td>default mode</td>
<td>HTTP/2, HTTP/1.1</td>
<td>HTTP/1.1, HTTP/2</td>
<td>Reverse proxy</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">--http2-proxy</span></code></td>
<td>HTTP/2, HTTP/1.1</td>
<td>HTTP/1.1, HTTP/2</td>
<td>Forward proxy</td>
</tr>
</tbody>
</table>
<p>The interesting mode at the moment is the default mode. It works like
a reverse proxy and listens for HTTP/2, and HTTP/1.1 and can be
deployed as a SSL/TLS terminator for existing web server.</p>
<p>In all modes, the frontend connections are encrypted by SSL/TLS by
default. To disable encryption, use the <code class="docutils literal notranslate"><span class="pre">no-tls</span></code> keyword in
<code class="docutils literal notranslate"><span class="pre">--frontend</span></code> option. If encryption is disabled, incoming HTTP/1.1
connections can be upgraded to HTTP/2 through HTTP Upgrade. On the
other hard, backend connections are not encrypted by default. To
encrypt backend connections, use <code class="docutils literal notranslate"><span class="pre">tls</span></code> keyword in <code class="docutils literal notranslate"><span class="pre">--backend</span></code>
option.</p>
<p><code class="docutils literal notranslate"><span class="pre">nghttpx</span></code> supports a configuration file. See the <code class="docutils literal notranslate"><span class="pre">--conf</span></code> option and
sample configuration file <code class="docutils literal notranslate"><span class="pre">nghttpx.conf.sample</span></code>.</p>
<p>In the default mode, <code class="docutils literal notranslate"><span class="pre">nghttpx</span></code> works as reverse proxy to the backend
server:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>Client <-- (HTTP/2, HTTP/1.1) --> nghttpx <-- (HTTP/1.1, HTTP/2) --> Web Server
[reverse proxy]
</pre></div>
</div>
<p>With the <code class="docutils literal notranslate"><span class="pre">--http2-proxy</span></code> option, it works as forward proxy, and it
is so called secure HTTP/2 proxy:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>Client <-- (HTTP/2, HTTP/1.1) --> nghttpx <-- (HTTP/1.1) --> Proxy
[secure proxy] (e.g., Squid, ATS)
</pre></div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">Client</span></code> in the above example needs to be configured to use
<code class="docutils literal notranslate"><span class="pre">nghttpx</span></code> as secure proxy.</p>
<p>At the time of this writing, both Chrome and Firefox support secure
HTTP/2 proxy. One way to configure Chrome to use a secure proxy is to
create a proxy.pac script like this:</p>
<div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><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>
<span class="p">}</span>
</pre></div>
</div>
<p><code class="docutils literal notranslate"><span class="pre">SERVERADDR</span></code> and <code class="docutils literal notranslate"><span class="pre">PORT</span></code> is the hostname/address and port of the
machine nghttpx is running on. Please note that Chrome requires a valid
certificate for secure proxy.</p>
<p>Then run Chrome with the following arguments:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>$ google-chrome --proxy-pac-url=file:///path/to/proxy.pac --use-npn
</pre></div>
</div>
<p>The backend HTTP/2 connections can be tunneled through an HTTP proxy.
The proxy is specified using <code class="docutils literal notranslate"><span class="pre">--backend-http-proxy-uri</span></code>. The
following figure illustrates how nghttpx talks to the outside HTTP/2
proxy through an HTTP proxy:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>Client <-- (HTTP/2, HTTP/1.1) --> nghttpx <-- (HTTP/2) --
--===================---> HTTP/2 Proxy
(HTTP proxy tunnel) (e.g., nghttpx -s)
</pre></div>
</div>
</div>
</div>
<div class="section" id="benchmarking-tool">
<h2>Benchmarking tool<a class="headerlink" href="#benchmarking-tool" title="Permalink to this headline">¶</a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">h2load</span></code> program is a benchmarking tool for HTTP/2. The UI of
<code class="docutils literal notranslate"><span class="pre">h2load</span></code> is heavily inspired by <code class="docutils literal notranslate"><span class="pre">weighttp</span></code>
(<a class="reference external" href="https://github.com/lighttpd/weighttp">https://github.com/lighttpd/weighttp</a>). The typical usage is as
follows:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>$ h2load -n100000 -c100 -m100 https://localhost:8443/
starting benchmark...
spawning thread #0: 100 concurrent clients, 100000 total requests
Protocol: TLSv1.2
Cipher: ECDHE-RSA-AES128-GCM-SHA256
Server Temp Key: ECDH P-256 256 bits
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 771.26ms, 129658 req/s, 4.71MB/s
requests: 100000 total, 100000 started, 100000 done, 100000 succeeded, 0 failed, 0 errored
status codes: 100000 2xx, 0 3xx, 0 4xx, 0 5xx
traffic: 3812300 bytes total, 1009900 bytes headers, 1000000 bytes data
min max mean sd +/- sd
time for request: 25.12ms 124.55ms 51.07ms 15.36ms 84.87%
time for connect: 208.94ms 254.67ms 241.38ms 7.95ms 63.00%
time to 1st byte: 209.11ms 254.80ms 241.51ms 7.94ms 63.00%
</pre></div>
</div>
<p>The above example issued total 100,000 requests, using 100 concurrent
clients (in other words, 100 HTTP/2 sessions), and a maximum of 100 streams
per client. With the <code class="docutils literal notranslate"><span class="pre">-t</span></code> option, <code class="docutils literal notranslate"><span class="pre">h2load</span></code> will use multiple native
threads to avoid saturating a single core on client side.</p>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last"><strong>Don’t use this tool against publicly available servers.</strong> That is
considered a DOS attack. Please only use it against your private
servers.</p>
</div>
</div>
<div class="section" id="hpack-tools">
<h2>HPACK tools<a class="headerlink" href="#hpack-tools" title="Permalink to this headline">¶</a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">src</span></code> directory contains the HPACK tools. The <code class="docutils literal notranslate"><span class="pre">deflatehd</span></code> program is a
command-line header compression tool. The <code class="docutils literal notranslate"><span class="pre">inflatehd</span></code> program is a
command-line header decompression tool. Both tools read input from
stdin and write output to stdout. Errors are written to stderr.
They take JSON as input and output. We (mostly) use the 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>
<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>
<p>The <code class="docutils literal notranslate"><span class="pre">deflatehd</span></code> program reads JSON data or HTTP/1-style header fields from
stdin and outputs compressed header block in JSON.</p>
<p>For the JSON input, the root JSON object must include a <code class="docutils literal notranslate"><span class="pre">cases</span></code> 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
appear. Each item in the sequence is a JSON object and it must
include a <code class="docutils literal notranslate"><span class="pre">headers</span></code> key. Its value is an array of JSON objects,
which includes exactly one name/value pair.</p>
<p>Example:</p>
<div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="nt">"cases"</span><span class="p">:</span>
<span class="p">[</span>
<span class="p">{</span>
<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>
<span class="p">]</span>
<span class="p">},</span>
<span class="p">{</span>
<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>
<span class="p">]</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
</pre></div>
</div>
<p>With the <code class="docutils literal notranslate"><span class="pre">-t</span></code> option, the program can accept more familiar HTTP/1 style
header field blocks. Each header set is delimited by an empty line:</p>
<p>Example:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>:method: GET
:scheme: https
:path: /
:method: POST
user-agent: nghttp2
</pre></div>
</div>
<p>The output is in JSON object. It should include a <code class="docutils literal notranslate"><span class="pre">cases</span></code> key and its
value is an array of JSON objects, which has at least the following keys:</p>
<dl class="docutils">
<dt>seq</dt>
<dd>The index of header set in the input.</dd>
<dt>input_length</dt>
<dd>The sum of the length of the name/value pairs in the input.</dd>
<dt>output_length</dt>
<dd>The length of the compressed header block.</dd>
<dt>percentage_of_original_size</dt>
<dd><code class="docutils literal notranslate"><span class="pre">output_length</span></code> / <code class="docutils literal notranslate"><span class="pre">input_length</span></code> * 100</dd>
<dt>wire</dt>
<dd>The compressed header block as a hex string.</dd>
<dt>headers</dt>
<dd>The input header set.</dd>
<dt>header_table_size</dt>
<dd>The header table size adjusted before deflating the header set.</dd>
</dl>
<p>Examples:</p>
<div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="nt">"cases"</span><span class="p">:</span>
<span class="p">[</span>
<span class="p">{</span>
<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>
<span class="p">{</span>
<span class="nt">":authority"</span><span class="p">:</span> <span class="s2">"example.org"</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>
<span class="p">{</span>
<span class="nt">":scheme"</span><span class="p">:</span> <span class="s2">"https"</span>
<span class="p">},</span>
<span class="p">{</span>
<span class="nt">"user-agent"</span><span class="p">:</span> <span class="s2">"nghttp2"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="nt">"header_table_size"</span><span class="p">:</span> <span class="mi">4096</span>
<span class="p">}</span>
<span class="p">,</span>
<span class="p">{</span>
<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>
<span class="p">{</span>
<span class="nt">":authority"</span><span class="p">:</span> <span class="s2">"example.org"</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">"/account"</span>
<span class="p">},</span>
<span class="p">{</span>
<span class="nt">":scheme"</span><span class="p">:</span> <span class="s2">"https"</span>
<span class="p">},</span>
<span class="p">{</span>
<span class="nt">"user-agent"</span><span class="p">:</span> <span class="s2">"nghttp2"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="nt">"header_table_size"</span><span class="p">:</span> <span class="mi">4096</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
</pre></div>
</div>
<p>The output can be used as the input for <code class="docutils literal notranslate"><span class="pre">inflatehd</span></code> and
<code class="docutils literal notranslate"><span class="pre">deflatehd</span></code>.</p>
<p>With the <code class="docutils literal notranslate"><span class="pre">-d</span></code> option, the extra <code class="docutils literal notranslate"><span class="pre">header_table</span></code> key is added and its
associated value includes the state of dynamic header table after the
corresponding header set was processed. The value includes at least
the following keys:</p>
<dl class="docutils">
<dt>entries</dt>
<dd>The entry in the header table. If <code class="docutils literal notranslate"><span class="pre">referenced</span></code> is <code class="docutils literal notranslate"><span class="pre">true</span></code>, it
is in the reference set. The <code class="docutils literal notranslate"><span class="pre">size</span></code> includes the overhead (32
bytes). The <code class="docutils literal notranslate"><span class="pre">index</span></code> corresponds to the index of header table.
The <code class="docutils literal notranslate"><span class="pre">name</span></code> is the header field name and the <code class="docutils literal notranslate"><span class="pre">value</span></code> is the
header field value.</dd>
<dt>size</dt>
<dd>The sum of the spaces entries occupied, this includes the
entry overhead.</dd>
<dt>max_size</dt>
<dd>The maximum header table size.</dd>
<dt>deflate_size</dt>
<dd>The sum of the spaces entries occupied within
<code class="docutils literal notranslate"><span class="pre">max_deflate_size</span></code>.</dd>
<dt>max_deflate_size</dt>
<dd>The maximum header table size the encoder uses. This can be smaller
than <code class="docutils literal notranslate"><span class="pre">max_size</span></code>. In this case, the encoder only uses up to first
<code class="docutils literal notranslate"><span class="pre">max_deflate_size</span></code> buffer. Since the header table size is still
<code class="docutils literal notranslate"><span class="pre">max_size</span></code>, the encoder has to keep track of entries outside the
<code class="docutils literal notranslate"><span class="pre">max_deflate_size</span></code> but inside the <code class="docutils literal notranslate"><span class="pre">max_size</span></code> and make sure
that they are no longer referenced.</dd>
</dl>
<p>Example:</p>
<div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="nt">"cases"</span><span class="p">:</span>
<span class="p">[</span>
<span class="p">{</span>
<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>
<span class="p">{</span>
<span class="nt">":authority"</span><span class="p">:</span> <span class="s2">"example.org"</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>
<span class="p">{</span>
<span class="nt">":scheme"</span><span class="p">:</span> <span class="s2">"https"</span>
<span class="p">},</span>
<span class="p">{</span>
<span class="nt">"user-agent"</span><span class="p">:</span> <span class="s2">"nghttp2"</span>
<span class="p">}</span>
<span class="p">],</span>
<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>
<span class="p">{</span>
<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>
<span class="p">},</span>
<span class="p">{</span>
<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>
<span class="p">},</span>
<span class="p">{</span>
<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>
<span class="p">},</span>
<span class="p">{</span>
<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>
<span class="p">},</span>
<span class="p">{</span>
<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>
<span class="p">}</span>
<span class="p">],</span>
<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>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">,</span>
<span class="p">{</span>
<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>
<span class="p">{</span>
<span class="nt">":authority"</span><span class="p">:</span> <span class="s2">"example.org"</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">"/account"</span>
<span class="p">},</span>
<span class="p">{</span>
<span class="nt">":scheme"</span><span class="p">:</span> <span class="s2">"https"</span>
<span class="p">},</span>
<span class="p">{</span>
<span class="nt">"user-agent"</span><span class="p">:</span> <span class="s2">"nghttp2"</span>
<span class="p">}</span>
<span class="p">],</span>
<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>
<span class="p">{</span>
<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>
<span class="p">},</span>
<span class="p">{</span>
<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>
<span class="p">},</span>
<span class="p">{</span>
<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>
<span class="p">},</span>
<span class="p">{</span>
<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>
<span class="p">},</span>
<span class="p">{</span>
<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>
<span class="p">},</span>
<span class="p">{</span>
<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>
<span class="p">}</span>
<span class="p">],</span>
<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>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
</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>
<p>The <code class="docutils literal notranslate"><span class="pre">inflatehd</span></code> program reads JSON data from stdin and outputs decompressed
name/value pairs in JSON.</p>
<p>The root JSON object must include the <code class="docutils literal notranslate"><span class="pre">cases</span></code> key. Its value has to
include the sequence of compressed header blocks. They share the same
compression context and are processed in the order they appear. Each
item in the sequence is a JSON object and it must have at least a
<code class="docutils literal notranslate"><span class="pre">wire</span></code> key. Its value is a compressed header block as a hex string.</p>
<p>Example:</p>
<div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="nt">"cases"</span><span class="p">:</span>
<span class="p">[</span>
<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>
<span class="p">]</span>
<span class="p">}</span>
</pre></div>
</div>
<p>The output is a JSON object. It should include a <code class="docutils literal notranslate"><span class="pre">cases</span></code> key and its
value is an array of JSON objects, which has at least following keys:</p>
<dl class="docutils">
<dt>seq</dt>
<dd>The index of the header set in the input.</dd>
<dt>headers</dt>
<dd>A JSON array that includes decompressed name/value pairs.</dd>
<dt>wire</dt>
<dd>The compressed header block as a hex string.</dd>
<dt>header_table_size</dt>
<dd>The header table size adjusted before inflating compressed header
block.</dd>
</dl>
<p>Example:</p>
<div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="nt">"cases"</span><span class="p">:</span>
<span class="p">[</span>
<span class="p">{</span>
<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>
<span class="p">{</span>
<span class="nt">":authority"</span><span class="p">:</span> <span class="s2">"example.org"</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>
<span class="p">{</span>
<span class="nt">":scheme"</span><span class="p">:</span> <span class="s2">"https"</span>
<span class="p">},</span>
<span class="p">{</span>
<span class="nt">"user-agent"</span><span class="p">:</span> <span class="s2">"nghttp2"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="nt">"header_table_size"</span><span class="p">:</span> <span class="mi">4096</span>
<span class="p">}</span>
<span class="p">,</span>
<span class="p">{</span>
<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>
<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">"/account"</span>
<span class="p">},</span>
<span class="p">{</span>
<span class="nt">"user-agent"</span><span class="p">:</span> <span class="s2">"nghttp2"</span>
<span class="p">},</span>
<span class="p">{</span>
<span class="nt">":scheme"</span><span class="p">:</span> <span class="s2">"https"</span>
<span class="p">},</span>
<span class="p">{</span>
<span class="nt">":authority"</span><span class="p">:</span> <span class="s2">"example.org"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="nt">"header_table_size"</span><span class="p">:</span> <span class="mi">4096</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
</pre></div>
</div>
<p>The output can be used as the input for <code class="docutils literal notranslate"><span class="pre">deflatehd</span></code> and
<code class="docutils literal notranslate"><span class="pre">inflatehd</span></code>.</p>
<p>With the <code class="docutils literal notranslate"><span class="pre">-d</span></code> option, the extra <code class="docutils literal notranslate"><span class="pre">header_table</span></code> key is added and its
associated value includes the state of the dynamic header table after the
corresponding header set was processed. The format is the same as
<code class="docutils literal notranslate"><span class="pre">deflatehd</span></code>.</p>
</div>
</div>
<div class="section" id="libnghttp2-asio-high-level-http-2-c-library">
<h2>libnghttp2_asio: High level HTTP/2 C++ library<a class="headerlink" href="#libnghttp2-asio-high-level-http-2-c-library" title="Permalink to this headline">¶</a></h2>
<p>libnghttp2_asio is C++ library built on top of libnghttp2 and provides
high level abstraction API to build HTTP/2 applications. It depends
on the Boost::ASIO library and OpenSSL. Currently libnghttp2_asio
provides both client and server APIs.</p>
<p>libnghttp2_asio is not built by default. Use the <code class="docutils literal notranslate"><span class="pre">--enable-asio-lib</span></code>
configure flag to build libnghttp2_asio. The required Boost libraries
are:</p>
<ul class="simple">
<li>Boost::Asio</li>
<li>Boost::System</li>
<li>Boost::Thread</li>
</ul>
<p>The server API is designed to build an HTTP/2 server very easily to utilize
C++14 anonymous functions and closures. The bare minimum example of
an HTTP/2 server looks like this:</p>
<div class="highlight-cpp notranslate"><div class="highlight"><pre><span></span><span class="cp">#include</span> <span class="cpf"><iostream></span><span class="cp"></span>
<span class="cp">#include</span> <span class="cpf"><nghttp2/asio_http2_server.h></span><span class="cp"></span>
<span class="k">using</span> <span class="k">namespace</span> <span class="n">nghttp2</span><span class="o">::</span><span class="n">asio_http2</span><span class="p">;</span>
<span class="k">using</span> <span class="k">namespace</span> <span class="n">nghttp2</span><span class="o">::</span><span class="n">asio_http2</span><span class="o">::</span><span class="n">server</span><span class="p">;</span>
<span class="kt">int</span> <span class="nf">main</span><span class="p">(</span><span class="kt">int</span> <span class="n">argc</span><span class="p">,</span> <span class="kt">char</span> <span class="o">*</span><span class="n">argv</span><span class="p">[])</span> <span class="p">{</span>
<span class="n">boost</span><span class="o">::</span><span class="n">system</span><span class="o">::</span><span class="n">error_code</span> <span class="n">ec</span><span class="p">;</span>
<span class="n">http2</span> <span class="n">server</span><span class="p">;</span>
<span class="n">server</span><span class="p">.</span><span class="n">handle</span><span class="p">(</span><span class="s">"/"</span><span class="p">,</span> <span class="p">[](</span><span class="k">const</span> <span class="n">request</span> <span class="o">&</span><span class="n">req</span><span class="p">,</span> <span class="k">const</span> <span class="n">response</span> <span class="o">&</span><span class="n">res</span><span class="p">)</span> <span class="p">{</span>
<span class="n">res</span><span class="p">.</span><span class="n">write_head</span><span class="p">(</span><span class="mi">200</span><span class="p">);</span>
<span class="n">res</span><span class="p">.</span><span class="n">end</span><span class="p">(</span><span class="s">"hello, world</span><span class="se">\n</span><span class="s">"</span><span class="p">);</span>
<span class="p">});</span>
<span class="k">if</span> <span class="p">(</span><span class="n">server</span><span class="p">.</span><span class="n">listen_and_serve</span><span class="p">(</span><span class="n">ec</span><span class="p">,</span> <span class="s">"localhost"</span><span class="p">,</span> <span class="s">"3000"</span><span class="p">))</span> <span class="p">{</span>
<span class="n">std</span><span class="o">::</span><span class="n">cerr</span> <span class="o"><<</span> <span class="s">"error: "</span> <span class="o"><<</span> <span class="n">ec</span><span class="p">.</span><span class="n">message</span><span class="p">()</span> <span class="o"><<</span> <span class="n">std</span><span class="o">::</span><span class="n">endl</span><span class="p">;</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
<p>Here is sample code to use the client API:</p>
<div class="highlight-cpp notranslate"><div class="highlight"><pre><span></span><span class="cp">#include</span> <span class="cpf"><iostream></span><span class="cp"></span>
<span class="cp">#include</span> <span class="cpf"><nghttp2/asio_http2_client.h></span><span class="cp"></span>
<span class="k">using</span> <span class="n">boost</span><span class="o">::</span><span class="n">asio</span><span class="o">::</span><span class="n">ip</span><span class="o">::</span><span class="n">tcp</span><span class="p">;</span>
<span class="k">using</span> <span class="k">namespace</span> <span class="n">nghttp2</span><span class="o">::</span><span class="n">asio_http2</span><span class="p">;</span>
<span class="k">using</span> <span class="k">namespace</span> <span class="n">nghttp2</span><span class="o">::</span><span class="n">asio_http2</span><span class="o">::</span><span class="n">client</span><span class="p">;</span>
<span class="kt">int</span> <span class="nf">main</span><span class="p">(</span><span class="kt">int</span> <span class="n">argc</span><span class="p">,</span> <span class="kt">char</span> <span class="o">*</span><span class="n">argv</span><span class="p">[])</span> <span class="p">{</span>
<span class="n">boost</span><span class="o">::</span><span class="n">system</span><span class="o">::</span><span class="n">error_code</span> <span class="n">ec</span><span class="p">;</span>
<span class="n">boost</span><span class="o">::</span><span class="n">asio</span><span class="o">::</span><span class="n">io_service</span> <span class="n">io_service</span><span class="p">;</span>
<span class="c1">// connect to localhost:3000</span>
<span class="n">session</span> <span class="n">sess</span><span class="p">(</span><span class="n">io_service</span><span class="p">,</span> <span class="s">"localhost"</span><span class="p">,</span> <span class="s">"3000"</span><span class="p">);</span>
<span class="n">sess</span><span class="p">.</span><span class="n">on_connect</span><span class="p">([</span><span class="o">&</span><span class="n">sess</span><span class="p">](</span><span class="n">tcp</span><span class="o">::</span><span class="n">resolver</span><span class="o">::</span><span class="n">iterator</span> <span class="n">endpoint_it</span><span class="p">)</span> <span class="p">{</span>
<span class="n">boost</span><span class="o">::</span><span class="n">system</span><span class="o">::</span><span class="n">error_code</span> <span class="n">ec</span><span class="p">;</span>
<span class="k">auto</span> <span class="n">req</span> <span class="o">=</span> <span class="n">sess</span><span class="p">.</span><span class="n">submit</span><span class="p">(</span><span class="n">ec</span><span class="p">,</span> <span class="s">"GET"</span><span class="p">,</span> <span class="s">"http://localhost:3000/"</span><span class="p">);</span>
<span class="n">req</span><span class="o">-></span><span class="n">on_response</span><span class="p">([](</span><span class="k">const</span> <span class="n">response</span> <span class="o">&</span><span class="n">res</span><span class="p">)</span> <span class="p">{</span>
<span class="c1">// print status code and response header fields.</span>
<span class="n">std</span><span class="o">::</span><span class="n">cerr</span> <span class="o"><<</span> <span class="s">"HTTP/2 "</span> <span class="o"><<</span> <span class="n">res</span><span class="p">.</span><span class="n">status_code</span><span class="p">()</span> <span class="o"><<</span> <span class="n">std</span><span class="o">::</span><span class="n">endl</span><span class="p">;</span>
<span class="k">for</span> <span class="p">(</span><span class="k">auto</span> <span class="o">&</span><span class="nl">kv</span> <span class="p">:</span> <span class="n">res</span><span class="p">.</span><span class="n">header</span><span class="p">())</span> <span class="p">{</span>
<span class="n">std</span><span class="o">::</span><span class="n">cerr</span> <span class="o"><<</span> <span class="n">kv</span><span class="p">.</span><span class="n">first</span> <span class="o"><<</span> <span class="s">": "</span> <span class="o"><<</span> <span class="n">kv</span><span class="p">.</span><span class="n">second</span><span class="p">.</span><span class="n">value</span> <span class="o"><<</span> <span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">;</span>
<span class="p">}</span>
<span class="n">std</span><span class="o">::</span><span class="n">cerr</span> <span class="o"><<</span> <span class="n">std</span><span class="o">::</span><span class="n">endl</span><span class="p">;</span>
<span class="n">res</span><span class="p">.</span><span class="n">on_data</span><span class="p">([](</span><span class="k">const</span> <span class="kt">uint8_t</span> <span class="o">*</span><span class="n">data</span><span class="p">,</span> <span class="n">std</span><span class="o">::</span><span class="kt">size_t</span> <span class="n">len</span><span class="p">)</span> <span class="p">{</span>
<span class="n">std</span><span class="o">::</span><span class="n">cerr</span><span class="p">.</span><span class="n">write</span><span class="p">(</span><span class="k">reinterpret_cast</span><span class="o"><</span><span class="k">const</span> <span class="kt">char</span> <span class="o">*></span><span class="p">(</span><span class="n">data</span><span class="p">),</span> <span class="n">len</span><span class="p">);</span>
<span class="n">std</span><span class="o">::</span><span class="n">cerr</span> <span class="o"><<</span> <span class="n">std</span><span class="o">::</span><span class="n">endl</span><span class="p">;</span>
<span class="p">});</span>
<span class="p">});</span>
<span class="n">req</span><span class="o">-></span><span class="n">on_close</span><span class="p">([</span><span class="o">&</span><span class="n">sess</span><span class="p">](</span><span class="kt">uint32_t</span> <span class="n">error_code</span><span class="p">)</span> <span class="p">{</span>
<span class="c1">// shutdown session after first request was done.</span>
<span class="n">sess</span><span class="p">.</span><span class="n">shutdown</span><span class="p">();</span>
<span class="p">});</span>
<span class="p">});</span>
<span class="n">sess</span><span class="p">.</span><span class="n">on_error</span><span class="p">([](</span><span class="k">const</span> <span class="n">boost</span><span class="o">::</span><span class="n">system</span><span class="o">::</span><span class="n">error_code</span> <span class="o">&</span><span class="n">ec</span><span class="p">)</span> <span class="p">{</span>
<span class="n">std</span><span class="o">::</span><span class="n">cerr</span> <span class="o"><<</span> <span class="s">"error: "</span> <span class="o"><<</span> <span class="n">ec</span><span class="p">.</span><span class="n">message</span><span class="p">()</span> <span class="o"><<</span> <span class="n">std</span><span class="o">::</span><span class="n">endl</span><span class="p">;</span>
<span class="p">});</span>
<span class="n">io_service</span><span class="p">.</span><span class="n">run</span><span class="p">();</span>
<span class="p">}</span>
</pre></div>
</div>
<p>For more details, see the documentation of libnghttp2_asio.</p>
</div>
<div class="section" id="python-bindings">
<h2>Python bindings<a class="headerlink" href="#python-bindings" title="Permalink to this headline">¶</a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">python</span></code> directory contains nghttp2 Python bindings. The
bindings currently provide HPACK compressor and decompressor classes
and an HTTP/2 server.</p>
<p>The extension module is called <code class="docutils literal notranslate"><span class="pre">nghttp2</span></code>.</p>
<p><code class="docutils literal notranslate"><span class="pre">make</span></code> will build the bindings and target Python version is
determined by the <code class="docutils literal notranslate"><span class="pre">configure</span></code> script. If the detected Python version is not
what you expect, specify a path to Python executable in a <code class="docutils literal notranslate"><span class="pre">PYTHON</span></code>
variable as an argument to configure script (e.g., <code class="docutils literal notranslate"><span class="pre">./configure</span>
<span class="pre">PYTHON=/usr/bin/python3.5</span></code>).</p>
<p>The following example code illustrates basic usage of the HPACK compressor
and decompressor in Python:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">binascii</span>
<span class="kn">import</span> <span class="nn">nghttp2</span>
<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>
<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="sa">b</span><span class="s1">'foo'</span><span class="p">,</span> <span class="sa">b</span><span class="s1">'bar'</span><span class="p">),</span>
<span class="p">(</span><span class="sa">b</span><span class="s1">'baz'</span><span class="p">,</span> <span class="sa">b</span><span class="s1">'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>
<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>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">nghttp2.HTTP2Server</span></code> class builds on top of the asyncio event
loop. On construction, <em>RequestHandlerClass</em> must be given, which
must be a subclass of <code class="docutils literal notranslate"><span class="pre">nghttp2.BaseRequestHandler</span></code> class.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">BaseRequestHandler</span></code> 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 <code class="docutils literal notranslate"><span class="pre">on_headers()</span></code>. It is called
when HEADERS frame, which includes the request header fields, has arrived.</p>
<p>If the request has a request body, <code class="docutils literal notranslate"><span class="pre">on_data(data)</span></code> is invoked for each
chunk of received data.</p>
<p>Once the entire request is received, <code class="docutils literal notranslate"><span class="pre">on_request_done()</span></code> is invoked.</p>
<p>When the stream is closed, <code class="docutils literal notranslate"><span class="pre">on_close(error_code)</span></code> is called.</p>
<p>The application can send a response using <code class="docutils literal notranslate"><span class="pre">send_response()</span></code> method.
It can be used in <code class="docutils literal notranslate"><span class="pre">on_headers()</span></code>, <code class="docutils literal notranslate"><span class="pre">on_data()</span></code> or
<code class="docutils literal notranslate"><span class="pre">on_request_done()</span></code>.</p>
<p>The application can push resources using the <code class="docutils literal notranslate"><span class="pre">push()</span></code> method. It must be
used before the <code class="docutils literal notranslate"><span class="pre">send_response()</span></code> 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>
<dd>Stream ID of this stream.</dd>
<dt>scheme</dt>
<dd>Scheme of the request URI. This is a value of :scheme header
field.</dd>
<dt>method</dt>
<dd>Method of this stream. This is a value of :method header field.</dd>
<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 notranslate"><div class="highlight"><pre><span></span><span class="ch">#!/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="s1">'/css/bootstrap.css'</span><span class="p">,</span>
<span class="n">request_headers</span> <span class="o">=</span> <span class="p">[(</span><span class="s1">'content-length'</span><span class="p">,</span> <span class="s1">'3'</span><span class="p">)],</span>
<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="s1">'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="s1">'/js/bootstrap.js'</span><span class="p">,</span>
<span class="n">method</span><span class="o">=</span><span class="s1">'GET'</span><span class="p">,</span>
<span class="n">request_headers</span> <span class="o">=</span> <span class="p">[(</span><span class="s1">'content-length'</span><span class="p">,</span> <span class="s1">'10'</span><span class="p">)],</span>
<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="s1">'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>
<span class="n">headers</span> <span class="o">=</span> <span class="p">[(</span><span class="s1">'content-type'</span><span class="p">,</span> <span class="s1">'text/plain'</span><span class="p">)],</span>
<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="sa">b</span><span class="s1">'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="s1">'server.crt'</span><span class="p">,</span> <span class="s1">'server.key'</span><span class="p">)</span>
<span class="c1"># 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="s1">'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>
</div>
</div>
<div class="section" id="contribution">
<h2>Contribution<a class="headerlink" href="#contribution" title="Permalink to this headline">¶</a></h2>
<p>[This text was composed based on 1.2. License section of curl/libcurl
project.]</p>
<p>When contributing with code, you agree to put your changes and new
code under the same license nghttp2 is already using unless stated and
agreed otherwise.</p>
<p>When changing existing source code, do not alter the copyright of
the original file(s). The copyright will still be owned by the
original creator(s) or those who have been assigned copyright by the
original author(s).</p>
<p>By submitting a patch to the nghttp2 project, you (or your employer, as
the case may be) agree to assign the copyright of your submission to us.
.. the above really needs to be reworded to pass legal muster.
We will credit you for your
changes as far as possible, to give credit but also to keep a trace
back to who made what changes. Please always provide us with your
full real name when contributing!</p>
<p>See <a class="reference external" href="https://nghttp2.org/documentation/contribute.html">Contribution Guidelines</a> for more
details.</p>
</div>
<div class="section" id="reporting-vulnerability">
<h2>Reporting vulnerability<a class="headerlink" href="#reporting-vulnerability" title="Permalink to this headline">¶</a></h2>
<p>If you find a vulnerability in our software, please send the email to
“tatsuhiro.t at gmail dot com” about its details instead of submitting
issues on github issue page. It is a standard practice not to
disclose vulnerability information publicly until a fixed version is
released, or mitigation is worked out.</p>
<p>In the future, we may setup a dedicated mail address for this purpose.</p>
</div>
<div class="section" id="release-schedule">
<h2>Release schedule<a class="headerlink" href="#release-schedule" title="Permalink to this headline">¶</a></h2>
<p>In general, we follow <a class="reference external" href="http://semver.org/">Semantic Versioning</a>. We
release MINOR version update every month, and usually we ship it
around 25th day of every month.</p>
<p>We may release PATCH releases between the regular releases, mainly for
severe security bug fixes.</p>
<p>We have no plan to break API compatibility changes involving soname
bump, so MAJOR version will stay 1 for the foreseeable future.</p>
</div>
<div class="section" id="license">
<h2>License<a class="headerlink" href="#license" title="Permalink to this headline">¶</a></h2>
<p>The MIT License</p>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="contribute.html" class="btn btn-neutral float-right" title="Contribution Guidelines" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="index.html" class="btn btn-neutral" title="nghttp2 - HTTP/2 C Library" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2012, 2015, 2016, Tatsuhiro Tsujikawa.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'1.38.0',
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/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-release
>
by-pkgid
>
63d08e0672e8e21a61288844222458a9
>
files
>
220
