Skip to content

N
nghttp2
Commit 72c279c7 authored by Tatsuhiro Tsujikawa's avatar Tatsuhiro Tsujikawa
Browse files
Options

Update doc

parent ecc93347
Expand all Hide whitespace changes
Inline Side-by-side
Showing with 147 additions and 100 deletions
_sources/apiref.txt
View file @ 72c279c7
......@@ -271,16 +271,12 @@ Enums
The PRIORITY flag.
.. macro:: NGHTTP2_FLAG_END_PUSH_PROMISE
(``0x1``)
(``0x4``)
The END_PUSH_PROMISE flag.
.. macro:: NGHTTP2_FLAG_PONG
(``0x1``)
The PONG flag.
.. macro:: NGHTTP2_FLAG_END_FLOW_CONTROL
(``0x1``)
The END_FLOW_CONTROL flag.
.. type:: nghttp2_settings_id
......@@ -1363,6 +1359,8 @@ Functions
:macro:`NGHTTP2_ERR_NOMEM`
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)
......@@ -1377,6 +1375,8 @@ Functions
Out of memory.
:macro:`NGHTTP2_ERR_INVALID_ARGUMENT`
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)
......@@ -1408,7 +1408,8 @@ Functions
negative error codes:
: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`
Out of memory.
......@@ -1445,6 +1446,8 @@ Functions
:macro:`NGHTTP2_ERR_INVALID_ARGUMENT`
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`
Out of memory.
......@@ -1489,6 +1492,8 @@ Functions
Submits WINDOW_UPDATE frame.
The *flags* is currently ignored.
If the *window_size_increment* is positive, the WINDOW_UPDATE with
that value as window_size_increment is queued. If the
*window_size_increment* is larger than the received bytes from the
......@@ -1507,9 +1512,7 @@ Functions
negative error codes:
:macro:`NGHTTP2_ERR_INVALID_ARGUMENT`
The *delta_window_size* is 0 and
:macro:`NGHTTP2_FLAG_END_FLOW_CONTROL` bit is not set in
*flags*.
The *delta_window_size* is 0.
:macro:`NGHTTP2_ERR_FLOW_CONTROL`
The local window size overflow or gets negative.
:macro:`NGHTTP2_ERR_STREAM_CLOSED`
......
_static/default2.css
View file @ 72c279c7
@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 {
font-family: monospace, sans-serif;
......
apiref.html
View file @ 72c279c7
......@@ -448,7 +448,7 @@ The PRIORITY flag.</p>
<dl class="macro">
<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>
<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>
</dd></dl>
......@@ -459,13 +459,6 @@ The END_PUSH_PROMISE flag.</p>
The PONG flag.</p>
</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>
<dl class="type">
......@@ -1793,6 +1786,8 @@ negative error codes:</p>
<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>
<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>
</dd></dl>
......@@ -1808,6 +1803,8 @@ negative error codes:</p>
<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>
<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>
</dd></dl>
......@@ -1839,7 +1836,8 @@ RST_STREAM is issued against such a stream.</p>
negative error codes:</p>
<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>
<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>
<dd>Out of memory.</dd>
</dl>
......@@ -1873,6 +1871,8 @@ negative error codes:</p>
<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>
<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>
<dd>Out of memory.</dd>
</dl>
......@@ -1918,6 +1918,7 @@ negative error codes:</p>
<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>
<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
that value as window_size_increment is queued. If 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>
<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>
<dd>The <em>delta_window_size</em> is 0 and
<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>
<dd>The <em>delta_window_size</em> is 0.</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>
<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>
......
genindex.html
View file @ 72c279c7
......@@ -225,10 +225,6 @@
</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>
......@@ -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>
</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>
</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>
......
index.html
View file @ 72c279c7
......@@ -57,6 +57,7 @@ version 2.0.</p>
<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#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#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>
......
objects.inv
View file @ 72c279c7
No preview for this file type
package_README.html
View file @ 72c279c7
This diff is collapsed.
searchindex.js
View file @ 72c279c7
This diff is collapsed.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment