walkero
/
nghttp2
1
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity

Update doc

This commit is contained in:
Tatsuhiro Tsujikawa 2013-08-25 22:59:06 +09:00
parent ecc93347fb
commit 72c279c7b1
8 changed files with 147 additions and 100 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
_sources/apiref.txt
View File

@ -271,16 +271,12 @@ Enums
The PRIORITY flag. The PRIORITY flag.
.. macro:: NGHTTP2_FLAG_END_PUSH_PROMISE .. macro:: NGHTTP2_FLAG_END_PUSH_PROMISE
(``0x1``) (``0x4``)
The END_PUSH_PROMISE flag. The END_PUSH_PROMISE flag.
.. macro:: NGHTTP2_FLAG_PONG .. macro:: NGHTTP2_FLAG_PONG
(``0x1``) (``0x1``)
The PONG flag. The PONG flag.
.. macro:: NGHTTP2_FLAG_END_FLOW_CONTROL
(``0x1``)
The END_FLOW_CONTROL flag.
.. type:: nghttp2_settings_id .. type:: nghttp2_settings_id
@ -1363,6 +1359,8 @@ Functions
:macro:`NGHTTP2_ERR_NOMEM` :macro:`NGHTTP2_ERR_NOMEM`
Out of memory. Out of memory.
:macro:`NGHTTP2_ERR_STREAM_CLOSED`
The stream is already closed or does not exist.
.. function:: int nghttp2_submit_priority(nghttp2_session *session, int32_t stream_id, int32_t pri) .. function:: int nghttp2_submit_priority(nghttp2_session *session, int32_t stream_id, int32_t pri)
@ -1377,6 +1375,8 @@ Functions
Out of memory. Out of memory.
:macro:`NGHTTP2_ERR_INVALID_ARGUMENT` :macro:`NGHTTP2_ERR_INVALID_ARGUMENT`
The *pri* is negative. The *pri* is negative.
:macro:`NGHTTP2_ERR_STREAM_CLOSED`
The stream is already closed or does not exist.
.. function:: int nghttp2_submit_rst_stream(nghttp2_session *session, int32_t stream_id, nghttp2_error_code error_code) .. function:: int nghttp2_submit_rst_stream(nghttp2_session *session, int32_t stream_id, nghttp2_error_code error_code)
@ -1408,7 +1408,8 @@ Functions
negative error codes: negative error codes:
:macro:`NGHTTP2_ERR_INVALID_ARGUMENT` :macro:`NGHTTP2_ERR_INVALID_ARGUMENT`
The *iv* contains duplicate settings ID or invalid value. The *iv* contains invalid value (e.g., attempting to re-enable
flow control).
:macro:`NGHTTP2_ERR_NOMEM` :macro:`NGHTTP2_ERR_NOMEM`
Out of memory. Out of memory.
@ -1445,6 +1446,8 @@ Functions
:macro:`NGHTTP2_ERR_INVALID_ARGUMENT` :macro:`NGHTTP2_ERR_INVALID_ARGUMENT`
The *nv* includes empty name or ``NULL`` value. The *nv* includes empty name or ``NULL`` value.
:macro:`NGHTTP2_ERR_STREAM_CLOSED`
The stream is already closed or does not exist.
:macro:`NGHTTP2_ERR_NOMEM` :macro:`NGHTTP2_ERR_NOMEM`
Out of memory. Out of memory.
@ -1489,6 +1492,8 @@ Functions
Submits WINDOW_UPDATE frame. Submits WINDOW_UPDATE frame.
The *flags* is currently ignored.
If the *window_size_increment* is positive, the WINDOW_UPDATE with If the *window_size_increment* is positive, the WINDOW_UPDATE with
that value as window_size_increment is queued. If the that value as window_size_increment is queued. If the
*window_size_increment* is larger than the received bytes from the *window_size_increment* is larger than the received bytes from the
@ -1507,9 +1512,7 @@ Functions
negative error codes: negative error codes:
:macro:`NGHTTP2_ERR_INVALID_ARGUMENT` :macro:`NGHTTP2_ERR_INVALID_ARGUMENT`
The *delta_window_size* is 0 and The *delta_window_size* is 0.
:macro:`NGHTTP2_FLAG_END_FLOW_CONTROL` bit is not set in
*flags*.
:macro:`NGHTTP2_ERR_FLOW_CONTROL` :macro:`NGHTTP2_ERR_FLOW_CONTROL`
The local window size overflow or gets negative. The local window size overflow or gets negative.
:macro:`NGHTTP2_ERR_STREAM_CLOSED` :macro:`NGHTTP2_ERR_STREAM_CLOSED`

2
_static/default2.css
View File

@ -1,4 +1,4 @@
@import url(http://fonts.googleapis.com/css?family=Roboto:400,400italic,500,500italic); @import url(//fonts.googleapis.com/css?family=Roboto:400,400italic,500,500italic);
pre, tt { pre, tt {
font-family: monospace, sans-serif; font-family: monospace, sans-serif;

23
apiref.html
View File

@ -448,7 +448,7 @@ The PRIORITY flag.</p>
<dl class="macro"> <dl class="macro">
<dt id="NGHTTP2_FLAG_END_PUSH_PROMISE"> <dt id="NGHTTP2_FLAG_END_PUSH_PROMISE">
<tt class="descname">NGHTTP2_FLAG_END_PUSH_PROMISE</tt><a class="headerlink" href="#NGHTTP2_FLAG_END_PUSH_PROMISE" title="Permalink to this definition"></a></dt> <tt class="descname">NGHTTP2_FLAG_END_PUSH_PROMISE</tt><a class="headerlink" href="#NGHTTP2_FLAG_END_PUSH_PROMISE" title="Permalink to this definition"></a></dt>
<dd><p>(<tt class="docutils literal"><span class="pre">0x1</span></tt>) <dd><p>(<tt class="docutils literal"><span class="pre">0x4</span></tt>)
The END_PUSH_PROMISE flag.</p> The END_PUSH_PROMISE flag.</p>
</dd></dl> </dd></dl>
@ -459,13 +459,6 @@ The END_PUSH_PROMISE flag.</p>
The PONG flag.</p> The PONG flag.</p>
</dd></dl> </dd></dl>
<dl class="macro">
<dt id="NGHTTP2_FLAG_END_FLOW_CONTROL">
<tt class="descname">NGHTTP2_FLAG_END_FLOW_CONTROL</tt><a class="headerlink" href="#NGHTTP2_FLAG_END_FLOW_CONTROL" title="Permalink to this definition"></a></dt>
<dd><p>(<tt class="docutils literal"><span class="pre">0x1</span></tt>)
The END_FLOW_CONTROL flag.</p>
</dd></dl>
</dd></dl> </dd></dl>
<dl class="type"> <dl class="type">
@ -1793,6 +1786,8 @@ negative error codes:</p>
<dl class="docutils"> <dl class="docutils">
<dt><a class="reference internal" href="#NGHTTP2_ERR_NOMEM" title="NGHTTP2_ERR_NOMEM"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_ERR_NOMEM</span></tt></a></dt> <dt><a class="reference internal" href="#NGHTTP2_ERR_NOMEM" title="NGHTTP2_ERR_NOMEM"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_ERR_NOMEM</span></tt></a></dt>
<dd>Out of memory.</dd> <dd>Out of memory.</dd>
<dt><a class="reference internal" href="#NGHTTP2_ERR_STREAM_CLOSED" title="NGHTTP2_ERR_STREAM_CLOSED"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_ERR_STREAM_CLOSED</span></tt></a></dt>
<dd>The stream is already closed or does not exist.</dd>
</dl> </dl>
</dd></dl> </dd></dl>
@ -1808,6 +1803,8 @@ negative error codes:</p>
<dd>Out of memory.</dd> <dd>Out of memory.</dd>
<dt><a class="reference internal" href="#NGHTTP2_ERR_INVALID_ARGUMENT" title="NGHTTP2_ERR_INVALID_ARGUMENT"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_ERR_INVALID_ARGUMENT</span></tt></a></dt> <dt><a class="reference internal" href="#NGHTTP2_ERR_INVALID_ARGUMENT" title="NGHTTP2_ERR_INVALID_ARGUMENT"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_ERR_INVALID_ARGUMENT</span></tt></a></dt>
<dd>The <em>pri</em> is negative.</dd> <dd>The <em>pri</em> is negative.</dd>
<dt><a class="reference internal" href="#NGHTTP2_ERR_STREAM_CLOSED" title="NGHTTP2_ERR_STREAM_CLOSED"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_ERR_STREAM_CLOSED</span></tt></a></dt>
<dd>The stream is already closed or does not exist.</dd>
</dl> </dl>
</dd></dl> </dd></dl>
@ -1839,7 +1836,8 @@ RST_STREAM is issued against such a stream.</p>
negative error codes:</p> negative error codes:</p>
<dl class="docutils"> <dl class="docutils">
<dt><a class="reference internal" href="#NGHTTP2_ERR_INVALID_ARGUMENT" title="NGHTTP2_ERR_INVALID_ARGUMENT"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_ERR_INVALID_ARGUMENT</span></tt></a></dt> <dt><a class="reference internal" href="#NGHTTP2_ERR_INVALID_ARGUMENT" title="NGHTTP2_ERR_INVALID_ARGUMENT"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_ERR_INVALID_ARGUMENT</span></tt></a></dt>
<dd>The <em>iv</em> contains duplicate settings ID or invalid value.</dd> <dd>The <em>iv</em> contains invalid value (e.g., attempting to re-enable
flow control).</dd>
<dt><a class="reference internal" href="#NGHTTP2_ERR_NOMEM" title="NGHTTP2_ERR_NOMEM"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_ERR_NOMEM</span></tt></a></dt> <dt><a class="reference internal" href="#NGHTTP2_ERR_NOMEM" title="NGHTTP2_ERR_NOMEM"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_ERR_NOMEM</span></tt></a></dt>
<dd>Out of memory.</dd> <dd>Out of memory.</dd>
</dl> </dl>
@ -1873,6 +1871,8 @@ negative error codes:</p>
<dl class="docutils"> <dl class="docutils">
<dt><a class="reference internal" href="#NGHTTP2_ERR_INVALID_ARGUMENT" title="NGHTTP2_ERR_INVALID_ARGUMENT"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_ERR_INVALID_ARGUMENT</span></tt></a></dt> <dt><a class="reference internal" href="#NGHTTP2_ERR_INVALID_ARGUMENT" title="NGHTTP2_ERR_INVALID_ARGUMENT"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_ERR_INVALID_ARGUMENT</span></tt></a></dt>
<dd>The <em>nv</em> includes empty name or <tt class="docutils literal"><span class="pre">NULL</span></tt> value.</dd> <dd>The <em>nv</em> includes empty name or <tt class="docutils literal"><span class="pre">NULL</span></tt> value.</dd>
<dt><a class="reference internal" href="#NGHTTP2_ERR_STREAM_CLOSED" title="NGHTTP2_ERR_STREAM_CLOSED"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_ERR_STREAM_CLOSED</span></tt></a></dt>
<dd>The stream is already closed or does not exist.</dd>
<dt><a class="reference internal" href="#NGHTTP2_ERR_NOMEM" title="NGHTTP2_ERR_NOMEM"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_ERR_NOMEM</span></tt></a></dt> <dt><a class="reference internal" href="#NGHTTP2_ERR_NOMEM" title="NGHTTP2_ERR_NOMEM"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_ERR_NOMEM</span></tt></a></dt>
<dd>Out of memory.</dd> <dd>Out of memory.</dd>
</dl> </dl>
@ -1918,6 +1918,7 @@ negative error codes:</p>
<dt id="nghttp2_submit_window_update"> <dt id="nghttp2_submit_window_update">
int <tt class="descname">nghttp2_submit_window_update</tt><big>(</big><a class="reference internal" href="#nghttp2_session" title="nghttp2_session">nghttp2_session</a><em>&nbsp;*session</em>, uint8_t<em>&nbsp;flags</em>, int32_t<em>&nbsp;stream_id</em>, int32_t<em>&nbsp;window_size_increment</em><big>)</big><a class="headerlink" href="#nghttp2_submit_window_update" title="Permalink to this definition"></a></dt> int <tt class="descname">nghttp2_submit_window_update</tt><big>(</big><a class="reference internal" href="#nghttp2_session" title="nghttp2_session">nghttp2_session</a><em>&nbsp;*session</em>, uint8_t<em>&nbsp;flags</em>, int32_t<em>&nbsp;stream_id</em>, int32_t<em>&nbsp;window_size_increment</em><big>)</big><a class="headerlink" href="#nghttp2_submit_window_update" title="Permalink to this definition"></a></dt>
<dd><p>Submits WINDOW_UPDATE frame.</p> <dd><p>Submits WINDOW_UPDATE frame.</p>
<p>The <em>flags</em> is currently ignored.</p>
<p>If the <em>window_size_increment</em> is positive, the WINDOW_UPDATE with <p>If the <em>window_size_increment</em> is positive, the WINDOW_UPDATE with
that value as window_size_increment is queued. If the that value as window_size_increment is queued. If the
<em>window_size_increment</em> is larger than the received bytes from the <em>window_size_increment</em> is larger than the received bytes from the
@ -1934,9 +1935,7 @@ received bytes count.</p>
negative error codes:</p> negative error codes:</p>
<dl class="docutils"> <dl class="docutils">
<dt><a class="reference internal" href="#NGHTTP2_ERR_INVALID_ARGUMENT" title="NGHTTP2_ERR_INVALID_ARGUMENT"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_ERR_INVALID_ARGUMENT</span></tt></a></dt> <dt><a class="reference internal" href="#NGHTTP2_ERR_INVALID_ARGUMENT" title="NGHTTP2_ERR_INVALID_ARGUMENT"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_ERR_INVALID_ARGUMENT</span></tt></a></dt>
<dd>The <em>delta_window_size</em> is 0 and <dd>The <em>delta_window_size</em> is 0.</dd>
<a class="reference internal" href="#NGHTTP2_FLAG_END_FLOW_CONTROL" title="NGHTTP2_FLAG_END_FLOW_CONTROL"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_FLAG_END_FLOW_CONTROL</span></tt></a> bit is not set in
<em>flags</em>.</dd>
<dt><a class="reference internal" href="#NGHTTP2_ERR_FLOW_CONTROL" title="NGHTTP2_ERR_FLOW_CONTROL"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_ERR_FLOW_CONTROL</span></tt></a></dt> <dt><a class="reference internal" href="#NGHTTP2_ERR_FLOW_CONTROL" title="NGHTTP2_ERR_FLOW_CONTROL"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_ERR_FLOW_CONTROL</span></tt></a></dt>
<dd>The local window size overflow or gets negative.</dd> <dd>The local window size overflow or gets negative.</dd>
<dt><a class="reference internal" href="#NGHTTP2_ERR_STREAM_CLOSED" title="NGHTTP2_ERR_STREAM_CLOSED"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_ERR_STREAM_CLOSED</span></tt></a></dt> <dt><a class="reference internal" href="#NGHTTP2_ERR_STREAM_CLOSED" title="NGHTTP2_ERR_STREAM_CLOSED"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_ERR_STREAM_CLOSED</span></tt></a></dt>

8
genindex.html
View File

@ -225,10 +225,6 @@
</dt> </dt>
<dt><a href="apiref.html#NGHTTP2_FLAG_END_FLOW_CONTROL">NGHTTP2_FLAG_END_FLOW_CONTROL (C macro)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_FLAG_END_HEADERS">NGHTTP2_FLAG_END_HEADERS (C macro)</a> <dt><a href="apiref.html#NGHTTP2_FLAG_END_HEADERS">NGHTTP2_FLAG_END_HEADERS (C macro)</a>
</dt> </dt>
@ -460,12 +456,12 @@
<dt><a href="apiref.html#nghttp2_on_data_chunk_recv_callback">nghttp2_on_data_chunk_recv_callback (C type)</a> <dt><a href="apiref.html#nghttp2_on_data_chunk_recv_callback">nghttp2_on_data_chunk_recv_callback (C type)</a>
</dt> </dt>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="apiref.html#nghttp2_on_data_recv_callback">nghttp2_on_data_recv_callback (C type)</a> <dt><a href="apiref.html#nghttp2_on_data_recv_callback">nghttp2_on_data_recv_callback (C type)</a>
</dt> </dt>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="apiref.html#nghttp2_on_data_send_callback">nghttp2_on_data_send_callback (C type)</a> <dt><a href="apiref.html#nghttp2_on_data_send_callback">nghttp2_on_data_send_callback (C type)</a>
</dt> </dt>

1
index.html
View File

@ -57,6 +57,7 @@ version 2.0.</p>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="package_README.html">nghttp2 - HTTP/2.0 C Library</a><ul> <li class="toctree-l1"><a class="reference internal" href="package_README.html">nghttp2 - HTTP/2.0 C Library</a><ul>
<li class="toctree-l2"><a class="reference internal" href="package_README.html#development-status">Development Status</a></li> <li class="toctree-l2"><a class="reference internal" href="package_README.html#development-status">Development Status</a></li>
<li class="toctree-l2"><a class="reference internal" href="package_README.html#public-test-server">Public Test Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="package_README.html#requirements">Requirements</a></li> <li class="toctree-l2"><a class="reference internal" href="package_README.html#requirements">Requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="package_README.html#build-from-git">Build from git</a></li> <li class="toctree-l2"><a class="reference internal" href="package_README.html#build-from-git">Build from git</a></li>
<li class="toctree-l2"><a class="reference internal" href="package_README.html#building-documentation">Building documentation</a></li> <li class="toctree-l2"><a class="reference internal" href="package_README.html#building-documentation">Building documentation</a></li>

BIN
objects.inv
View File

Binary file not shown.

190
package_README.html
View File

@ -58,14 +58,60 @@
version 2.0.</p> version 2.0.</p>
<div class="section" id="development-status"> <div class="section" id="development-status">
<h2>Development Status<a class="headerlink" href="#development-status" title="Permalink to this headline"></a></h2> <h2>Development Status<a class="headerlink" href="#development-status" title="Permalink to this headline"></a></h2>
<p>We started to implement HTTP-draft-04/2.0 <p>We started to implement HTTP-draft-06/2.0
(<a class="reference external" href="http://tools.ietf.org/html/draft-ietf-httpbis-http2-04">http://tools.ietf.org/html/draft-ietf-httpbis-http2-04</a>) based on (<a class="reference external" href="http://tools.ietf.org/html/draft-ietf-httpbis-http2-06">http://tools.ietf.org/html/draft-ietf-httpbis-http2-06</a>) and the
spdylay code base. The header compression is based on header compression
<a class="reference external" href="http://tools.ietf.org/html/draft-ietf-httpbis-header-compression-01">http://tools.ietf.org/html/draft-ietf-httpbis-header-compression-01</a></p> (<a class="reference external" href="http://tools.ietf.org/html/draft-ietf-httpbis-header-compression-02">http://tools.ietf.org/html/draft-ietf-httpbis-header-compression-02</a>).</p>
<p>Currently, the library lacks the following features:</p> <p>The nghttp2 code base was forked from spdylay project.</p>
<ul class="simple"> <table border="1" class="docutils">
<li>Header continuation</li> <colgroup>
<li>ALPN: instead, NPN is used</li> <col width="53%" />
<col width="47%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Features</th>
<th class="head">HTTP-draft-04/2.0</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>Flow Control</td>
<td>Done</td>
</tr>
<tr class="row-odd"><td>Header Compression</td>
<td>Done</td>
</tr>
<tr class="row-even"><td>Reprioritization</td>
<td>Done</td>
</tr>
<tr class="row-odd"><td>Header Continuation</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td>Server Push</td>
<td>Done</td>
</tr>
<tr class="row-odd"><td>HTTP Upgrade</td>
<td>Done</td>
</tr>
<tr class="row-even"><td>ALPN</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td>NPN</td>
<td>Done</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="public-test-server">
<h2>Public Test Server<a class="headerlink" href="#public-test-server" title="Permalink to this headline"></a></h2>
<p>The following endpoints are available to try out nghttp2
implementation. These endpoints supports <tt class="docutils literal"><span class="pre">HTTP-draft-06/2.0</span></tt> and
the earlier draft versions are not supporeted.</p>
<ul>
<li><p class="first"><a class="reference external" href="https://106.186.112.116:8443">https://106.186.112.116:8443</a> TLS + NPN</p>
<p>Note: certificate is self-signed and a browser will show alert</p>
</li>
<li><p class="first"><a class="reference external" href="http://106.186.112.116:8080">http://106.186.112.116:8080</a> direct, HTTP Upgrade</p>
</li>
</ul> </ul>
</div> </div>
<div class="section" id="requirements"> <div class="section" id="requirements">
@ -147,37 +193,36 @@ $ make</pre>
<h3>nghttp - client<a class="headerlink" href="#nghttp-client" title="Permalink to this headline"></a></h3> <h3>nghttp - client<a class="headerlink" href="#nghttp-client" title="Permalink to this headline"></a></h3>
<p><tt class="docutils literal"><span class="pre">nghttp</span></tt> is a HTTP/2.0 client. It can connect to the HTTP/2.0 server <p><tt class="docutils literal"><span class="pre">nghttp</span></tt> is a HTTP/2.0 client. It can connect to the HTTP/2.0 server
with prior knowledge, HTTP Upgrade and NPN TLS extension.</p> with prior knowledge, HTTP Upgrade and NPN TLS extension.</p>
<p>By default, it uses SSL/TLS connection. Use <tt class="docutils literal"><span class="pre">--no-tls</span></tt> option to
disable it.</p>
<p>It has verbose output mode for framing information. Here is sample <p>It has verbose output mode for framing information. Here is sample
output from <tt class="docutils literal"><span class="pre">nghttp</span></tt> client:</p> output from <tt class="docutils literal"><span class="pre">nghttp</span></tt> client:</p>
<div class="highlight-c"><pre>$ src/nghttp -nv https://localhost:3000/ <div class="highlight-c"><pre>$ src/nghttp -vn https://localhost:8443
[ 0.000] NPN select next protocol: the remote server offers: [ 0.001] NPN select next protocol: the remote server offers:
* HTTP-draft-04/2.0 * HTTP-draft-06/2.0
* spdy/3 * spdy/3
* spdy/2 * spdy/2
* http/1.1 * http/1.1
NPN selected the protocol: HTTP-draft-04/2.0 NPN selected the protocol: HTTP-draft-06/2.0
[ 0.005] send SETTINGS frame &lt;length=0, flags=0, stream_id=0&gt; [ 0.006] send SETTINGS frame &lt;length=16, flags=0x00, stream_id=0&gt;
(niv=0) (niv=2)
[ 0.005] send HEADERS frame &lt;length=58, flags=5, stream_id=1&gt; [MAX_CONCURRENT_STREAMS(4):100]
[INITIAL_WINDOW_SIZE(7):65535]
[ 0.006] send HEADERS frame &lt;length=58, flags=0x05, stream_id=1&gt;
; END_STREAM | END_HEADERS ; END_STREAM | END_HEADERS
; Open new stream ; Open new stream
:host: localhost:3000 :host: localhost:8443
:method: GET :method: GET
:path: / :path: /
:scheme: https :scheme: https
accept: */* accept: */*
accept-encoding: gzip, deflate accept-encoding: gzip, deflate
user-agent: nghttp2/0.1.0-DEV user-agent: nghttp2/0.1.0-DEV
[ 0.005] recv SETTINGS frame &lt;length=16, flags=0, stream_id=0&gt; [ 0.007] recv SETTINGS frame &lt;length=16, flags=0x00, stream_id=0&gt;
(niv=2) (niv=2)
[4:100] [MAX_CONCURRENT_STREAMS(4):100]
[7:65536] [INITIAL_WINDOW_SIZE(7):65535]
[ 0.005] recv WINDOW_UPDATE frame &lt;length=4, flags=1, stream_id=0&gt; [ 0.008] recv WINDOW_UPDATE frame &lt;length=4, flags=0x00, stream_id=0&gt;
; END_FLOW_CONTROL (window_size_increment=1000000007)
(window_size_increment=0) [ 0.008] recv HEADERS frame &lt;length=179, flags=0x04, stream_id=1&gt;
[ 0.006] recv HEADERS frame &lt;length=179, flags=4, stream_id=1&gt;
; END_HEADERS ; END_HEADERS
; First response header ; First response header
:status: 200 OK :status: 200 OK
@ -185,65 +230,66 @@ output from <tt class="docutils literal"><span class="pre">nghttp</span></tt> cl
content-encoding: gzip content-encoding: gzip
content-length: 56 content-length: 56
content-type: text/html content-type: text/html
date: Sat, 27 Jul 2013 12:08:56 GMT date: Thu, 22 Aug 2013 16:37:17 GMT
etag: "cf405c-2d-45adabdf282c0" etag: "cf405c-2d-45adabdf282c0"
last-modified: Tue, 04 Nov 2008 10:44:03 GMT last-modified: Tue, 04 Nov 2008 10:44:03 GMT
server: Apache/2.2.22 (Debian) server: Apache/2.2.22 (Debian)
vary: Accept-Encoding vary: Accept-Encoding
via: 1.1 nghttpx via: 1.1 nghttpx
[ 0.006] recv DATA frame (length=56, flags=0, stream_id=1) [ 0.009] recv DATA frame &lt;length=56, flags=0x00, stream_id=1&gt;
[ 0.006] recv DATA frame (length=0, flags=1, stream_id=1) [ 0.009] recv DATA frame &lt;length=0, flags=0x01, stream_id=1&gt;
[ 0.006] send GOAWAY frame &lt;length=8, flags=0, stream_id=0&gt; ; END_STREAM
(last_stream_id=0, error_code=NO_ERROR(0), opaque_data=)</pre> [ 0.009] send GOAWAY frame &lt;length=8, flags=0x00, stream_id=0&gt;
(last_stream_id=0, error_code=NO_ERROR(0), opaque_data(0)=[])</pre>
</div> </div>
<p>The HTTP Upgrade is performed like this:</p> <p>The HTTP Upgrade is performed like this:</p>
<div class="highlight-c"><pre>$ src/nghttp --no-tls -nvu http://localhost:3000/ <div class="highlight-c"><pre>$ src/nghttp -vnu http://localhost:8080
[ 0.000] HTTP Upgrade request [ 0.000] HTTP Upgrade request
GET / HTTP/1.1 GET / HTTP/1.1
Host: localhost:3000 Host: localhost:8080
Connection: Upgrade, HTTP2-Settings Connection: Upgrade, HTTP2-Settings
Upgrade: HTTP-draft-04/2.0 Upgrade: HTTP-draft-06/2.0
HTTP2-Settings: AAAABAAAAGQAAAAHAAD__w HTTP2-Settings: AAAABAAAAGQAAAAHAAD__w
Accept: */* Accept: */*
User-Agent: nghttp2/0.1.0-DEV User-Agent: nghttp2/0.1.0-DEV
[ 0.183] HTTP Upgrade response [ 0.000] HTTP Upgrade response
HTTP/1.1 101 Switching Protocols HTTP/1.1 101 Switching Protocols
Connection: Upgrade Connection: Upgrade
Upgrade: HTTP/2.0 Upgrade: HTTP/2.0
[ 0.183] HTTP Upgrade success [ 0.000] HTTP Upgrade success
[ 0.183] send SETTINGS frame &lt;length=16, flags=0x00, stream_id=0&gt; [ 0.001] send SETTINGS frame &lt;length=16, flags=0x00, stream_id=0&gt;
(niv=2) (niv=2)
[4:100] [MAX_CONCURRENT_STREAMS(4):100]
[7:65535] [INITIAL_WINDOW_SIZE(7):65535]
[ 0.202] recv SETTINGS frame &lt;length=16, flags=0x00, stream_id=0&gt; [ 0.001] recv SETTINGS frame &lt;length=16, flags=0x00, stream_id=0&gt;
(niv=2) (niv=2)
[4:100] [MAX_CONCURRENT_STREAMS(4):100]
[7:65536] [INITIAL_WINDOW_SIZE(7):65535]
[ 0.202] recv WINDOW_UPDATE frame &lt;length=4, flags=0x01, stream_id=0&gt; [ 0.001] recv WINDOW_UPDATE frame &lt;length=4, flags=0x00, stream_id=0&gt;
; END_FLOW_CONTROL (window_size_increment=1000000007)
(window_size_increment=0) [ 0.001] recv HEADERS frame &lt;length=198, flags=0x04, stream_id=1&gt;
[ 0.275] recv HEADERS frame &lt;length=198, flags=0x04, stream_id=1&gt;
; END_HEADERS ; END_HEADERS
; First response header ; First response header
:status: 200 OK :status: 200 OK
accept-ranges: bytes accept-ranges: bytes
content-length: 45 content-length: 45
content-type: text/html content-type: text/html
date: Sat, 03 Aug 2013 10:21:20 GMT date: Thu, 22 Aug 2013 16:39:04 GMT
etag: "cf405c-2d-45adabdf282c0" etag: "cf405c-2d-45adabdf282c0"
last-modified: Tue, 04 Nov 2008 10:44:03 GMT last-modified: Tue, 04 Nov 2008 10:44:03 GMT
server: Apache/2.2.22 (Debian) server: Apache/2.2.22 (Debian)
vary: Accept-Encoding vary: Accept-Encoding
via: 1.1 nghttpx via: 1.1 nghttpx
x-pad: avoid browser bug x-pad: avoid browser bug
[ 0.275] recv DATA frame (length=45, flags=0, stream_id=1) [ 0.001] recv DATA frame &lt;length=45, flags=0x00, stream_id=1&gt;
[ 0.275] recv DATA frame (length=0, flags=1, stream_id=1) [ 0.001] recv DATA frame &lt;length=0, flags=0x01, stream_id=1&gt;
[ 0.275] send GOAWAY frame &lt;length=8, flags=0x00, stream_id=0&gt; ; END_STREAM
(last_stream_id=0, error_code=NO_ERROR(0), opaque_data=)</pre> [ 0.001] send GOAWAY frame &lt;length=8, flags=0x00, stream_id=0&gt;
(last_stream_id=0, error_code=NO_ERROR(0), opaque_data(0)=[])</pre>
</div> </div>
</div> </div>
<div class="section" id="nghttpd-server"> <div class="section" id="nghttpd-server">
@ -256,46 +302,47 @@ disable it.</p>
HTTP/2.0 connection. No HTTP Upgrade is supported.</p> HTTP/2.0 connection. No HTTP Upgrade is supported.</p>
<p>Just like <tt class="docutils literal"><span class="pre">nghttp</span></tt>, it has verbose output mode for framing <p>Just like <tt class="docutils literal"><span class="pre">nghttp</span></tt>, it has verbose output mode for framing
information. Here is sample output from <tt class="docutils literal"><span class="pre">nghttpd</span></tt> server:</p> information. Here is sample output from <tt class="docutils literal"><span class="pre">nghttpd</span></tt> server:</p>
<div class="highlight-c"><pre>$ src/nghttpd 3000 --no-tls -v <div class="highlight-c"><pre>$ src/nghttpd --no-tls -v 8080
IPv4: listen on port 3000 IPv4: listen on port 8080
IPv6: listen on port 3000 IPv6: listen on port 8080
[id=1] [ 1.020] send SETTINGS frame &lt;length=8, flags=0, stream_id=0&gt; [id=1] [ 14.716] send SETTINGS frame &lt;length=8, flags=0x00, stream_id=0&gt;
(niv=1) (niv=1)
[4:100] [MAX_CONCURRENT_STREAMS(4):100]
[id=1] [ 1.020] closed [id=1] [ 14.717] recv SETTINGS frame &lt;length=16, flags=0x00, stream_id=0&gt;
[id=2] [ 1.838] send SETTINGS frame &lt;length=8, flags=0, stream_id=0&gt; (niv=2)
(niv=1) [MAX_CONCURRENT_STREAMS(4):100]
[4:100] [INITIAL_WINDOW_SIZE(7):65535]
[id=2] [ 1.838] recv SETTINGS frame &lt;length=0, flags=0, stream_id=0&gt; [id=1] [ 14.717] recv HEADERS frame &lt;length=58, flags=0x05, stream_id=1&gt;
(niv=0)
[id=2] [ 1.838] recv HEADERS frame &lt;length=58, flags=5, stream_id=1&gt;
; END_STREAM | END_HEADERS ; END_STREAM | END_HEADERS
; Open new stream ; Open new stream
:host: localhost:3000 :host: localhost:8080
:method: GET :method: GET
:path: / :path: /
:scheme: http :scheme: http
accept: */* accept: */*
accept-encoding: gzip, deflate accept-encoding: gzip, deflate
user-agent: nghttp2/0.1.0-DEV user-agent: nghttp2/0.1.0-DEV
[id=2] [ 1.838] send HEADERS frame &lt;length=105, flags=4, stream_id=1&gt; [id=1] [ 14.717] send HEADERS frame &lt;length=105, flags=0x04, stream_id=1&gt;
; END_HEADERS ; END_HEADERS
; First response header ; First response header
:status: 404 Not Found :status: 404 Not Found
content-encoding: gzip content-encoding: gzip
content-type: text/html; charset=UTF-8 content-type: text/html; charset=UTF-8
date: Sat, 27 Jul 2013 12:32:10 GMT date: Thu, 22 Aug 2013 16:41:05 GMT
server: nghttpd nghttp2/0.1.0-DEV server: nghttpd nghttp2/0.1.0-DEV
[id=2] [ 1.838] send DATA frame (length=127, flags=0, stream_id=1) [id=1] [ 14.717] send DATA frame &lt;length=128, flags=0x00, stream_id=1&gt;
[id=2] [ 1.838] send DATA frame (length=0, flags=1, stream_id=1) [id=1] [ 14.717] send DATA frame &lt;length=0, flags=0x01, stream_id=1&gt;
[id=2] [ 1.838] stream_id=1 closed ; END_STREAM
[id=2] [ 1.839] closed</pre> [id=1] [ 14.717] stream_id=1 closed
[id=1] [ 14.717] recv GOAWAY frame &lt;length=8, flags=0x00, stream_id=0&gt;
(last_stream_id=0, error_code=NO_ERROR(0), opaque_data(0)=[])
[id=1] [ 14.717] closed</pre>
</div> </div>
</div> </div>
<div class="section" id="nghttpx-proxy"> <div class="section" id="nghttpx-proxy">
<h3>nghttpx - proxy<a class="headerlink" href="#nghttpx-proxy" title="Permalink to this headline"></a></h3> <h3>nghttpx - proxy<a class="headerlink" href="#nghttpx-proxy" title="Permalink to this headline"></a></h3>
<p>The <tt class="docutils literal"><span class="pre">nghttpx</span></tt> is a multi-threaded reverse proxy for <p>The <tt class="docutils literal"><span class="pre">nghttpx</span></tt> is a multi-threaded reverse proxy for
HTTP-draft-04/2.0, SPDY and HTTP/1.1. It has several operation modes:</p> HTTP-draft-06/2.0, SPDY and HTTP/1.1. It has several operation modes:</p>
<table border="1" class="docutils"> <table border="1" class="docutils">
<colgroup> <colgroup>
<col width="24%" /> <col width="24%" />
@ -339,7 +386,7 @@ HTTP-draft-04/2.0, SPDY and HTTP/1.1. It has several operation modes:</p>
</tbody> </tbody>
</table> </table>
<p>The interesting mode at the moment is the default mode. It works like <p>The interesting mode at the moment is the default mode. It works like
a reverse proxy and listens HTTP-draft-04/2.0, SPDY and HTTP/1.1 and a reverse proxy and listens HTTP-draft-06/2.0, SPDY and HTTP/1.1 and
can be deployed SSL/TLS terminator for existing web server.</p> can be deployed SSL/TLS terminator for existing web server.</p>
<p>The default mode, <tt class="docutils literal"><span class="pre">--spdy</span></tt> and <tt class="docutils literal"><span class="pre">--spdy-bridge</span></tt> modes use SSL/TLS <p>The default mode, <tt class="docutils literal"><span class="pre">--spdy</span></tt> and <tt class="docutils literal"><span class="pre">--spdy-bridge</span></tt> modes use SSL/TLS
in the frontend connection by default. To disable SSL/TLS, use in the frontend connection by default. To disable SSL/TLS, use
@ -437,6 +484,7 @@ the outside HTTP/2.0 proxy through HTTP proxy:</p>
<ul> <ul>
<li><a class="reference internal" href="#">nghttp2 - HTTP/2.0 C Library</a><ul> <li><a class="reference internal" href="#">nghttp2 - HTTP/2.0 C Library</a><ul>
<li><a class="reference internal" href="#development-status">Development Status</a></li> <li><a class="reference internal" href="#development-status">Development Status</a></li>
<li><a class="reference internal" href="#public-test-server">Public Test Server</a></li>
<li><a class="reference internal" href="#requirements">Requirements</a></li> <li><a class="reference internal" href="#requirements">Requirements</a></li>
<li><a class="reference internal" href="#build-from-git">Build from git</a></li> <li><a class="reference internal" href="#build-from-git">Build from git</a></li>
<li><a class="reference internal" href="#building-documentation">Building documentation</a></li> <li><a class="reference internal" href="#building-documentation">Building documentation</a></li>

2
searchindex.js
View File

File diff suppressed because one or more lines are too long