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-09 01:52:42 +09:00
parent edd7420898
commit 3c400bc607
5 changed files with 126 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

69
_sources/apiref.txt
View File

@ -44,6 +44,11 @@ Macros
The lowest priority value
.. macro:: NGHTTP2_MAX_WINDOW_SIZE
The maximum window size
.. macro:: NGHTTP2_INITIAL_WINDOW_SIZE
@ -180,6 +185,10 @@ Enums
(``-523``)
Header block inflate/deflate error.
.. macro:: NGHTTP2_ERR_FLOW_CONTROL
(``-524``)
Flow control error
.. macro:: NGHTTP2_ERR_FATAL
(``-900``)
@ -374,13 +383,20 @@ Enums
Configuration options for :type:`nghttp2_session`.
.. macro:: NGHTTP2_OPT_NO_AUTO_WINDOW_UPDATE
.. macro:: NGHTTP2_OPT_NO_AUTO_STREAM_WINDOW_UPDATE
(``1``)
This option prevents the library from sending WINDOW_UPDATE
automatically. If this option is set, the application is
This option prevents the library from sending WINDOW_UPDATE for a
stream automatically. If this option is set, the application is
responsible for sending WINDOW_UPDATE using
`nghttp2_submit_window_update`.
.. macro:: NGHTTP2_OPT_NO_AUTO_CONNECTION_WINDOW_UPDATE
(``2``)
This option prevents the library from sending WINDOW_UPDATE for a
connection automatically. If this option is set, the application
is responsible for sending WINDOW_UPDATE with stream ID 0 using
`nghttp2_submit_window_update`.
@ -901,12 +917,19 @@ Functions
The following *optname* are supported:
:macro:`NGHTTP2_OPT_NO_AUTO_WINDOW_UPDATE`
:macro:`NGHTTP2_OPT_NO_AUTO_STREAM_WINDOW_UPDATE`
The *optval* must be a pointer to ``int``. If the *\*optval* is
nonzero, the library will not send WINDOW_UPDATE automatically.
Therefore, the application is responsible for sending
WINDOW_UPDATE using `nghttp2_submit_window_update`. This option
defaults to 0.
nonzero, the library will not send WINDOW_UPDATE for a stream
automatically. Therefore, the application is responsible for
sending WINDOW_UPDATE using
`nghttp2_submit_window_update`. This option defaults to 0.
:macro:`NGHTTP2_OPT_NO_AUTO_CONNECTION_WINDOW_UPDATE`
The *optval* must be a pointer to ``int``. If the *\*optval* is
nonzero, the library will not send WINDOW_UPDATE for connection
automatically. Therefore, the application is responsible for
sending WINDOW_UPDATE using
`nghttp2_submit_window_update`. This option defaults to 0.
This function returns 0 if it succeeds, or one of the following
negative error codes:
@ -1377,6 +1400,10 @@ Functions
This function does not take ownership of the *iv*. This function
copies all the elements in the *iv*.
While updating individual stream's local window size, if the window
size becomes strictly larger than NGHTTP2_MAX_WINDOW_SIZE,
RST_STREAM is issued against such a stream.
This function returns 0 if it succeeds, or one of the following
negative error codes:
@ -1460,21 +1487,31 @@ Functions
.. function:: int nghttp2_submit_window_update(nghttp2_session *session, uint8_t flags, int32_t stream_id, int32_t window_size_increment)
Submits WINDOW_UPDATE frame. The effective range of the
*window_size_increment* is [1, (1 << 31)-1], inclusive. But the
application must be responsible to keep the resulting window size
<= (1 << 31)-1. If :macro:`NGHTTP2_FLAG_END_FLOW_CONTROL` bit set in
the *flags*, 0 can be specified in the *window_size_increment*. In
fact, if this flag is set, the value specified in the
*window_size_increment* is ignored.
Submits WINDOW_UPDATE frame.
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
remote endpoint, the local window size is increased by that
difference.
If the *window_size_increment* is negative, the local window size
is decreased by -*window_size_increment*. If
:macro:`NGHTTP2_OPT_NO_AUTO_STREAM_WINDOW_UPDATE` (or
:macro:`NGHTTP2_OPT_NO_AUTO_CONNECTION_WINDOW_UPDATE` if *stream_id*
is 0) is not set and the library decided that the WINDOW_UPDATE
should be submitted, then WINDOW_UPDATE is queued with the current
received bytes count.
This function returns 0 if it succeeds, or one of the following
negative error codes:
:macro:`NGHTTP2_ERR_INVALID_ARGUMENT`
The *delta_window_size* is 0 or negative and
The *delta_window_size* is 0 and
:macro:`NGHTTP2_FLAG_END_FLOW_CONTROL` bit is not set in
*flags*.
:macro:`NGHTTP2_ERR_FLOW_CONTROL`
The local window size overflow or gets negative.
:macro:`NGHTTP2_ERR_STREAM_CLOSED`
The stream is already closed or does not exist.
:macro:`NGHTTP2_ERR_NOMEM`

74
apiref.html
View File

@ -98,6 +98,12 @@ callbacks.</p>
<dd><p>The lowest priority value</p>
</dd></dl>
<dl class="macro">
<dt id="NGHTTP2_MAX_WINDOW_SIZE">
<tt class="descname">NGHTTP2_MAX_WINDOW_SIZE</tt><a class="headerlink" href="#NGHTTP2_MAX_WINDOW_SIZE" title="Permalink to this definition"></a></dt>
<dd><p>The maximum window size</p>
</dd></dl>
<dl class="macro">
<dt id="NGHTTP2_INITIAL_WINDOW_SIZE">
<tt class="descname">NGHTTP2_INITIAL_WINDOW_SIZE</tt><a class="headerlink" href="#NGHTTP2_INITIAL_WINDOW_SIZE" title="Permalink to this definition"></a></dt>
@ -305,6 +311,13 @@ The length of the frame is too large.</p>
Header block inflate/deflate error.</p>
</dd></dl>
<dl class="macro">
<dt id="NGHTTP2_ERR_FLOW_CONTROL">
<tt class="descname">NGHTTP2_ERR_FLOW_CONTROL</tt><a class="headerlink" href="#NGHTTP2_ERR_FLOW_CONTROL" title="Permalink to this definition"></a></dt>
<dd><p>(<tt class="docutils literal"><span class="pre">-524</span></tt>)
Flow control error</p>
</dd></dl>
<dl class="macro">
<dt id="NGHTTP2_ERR_FATAL">
<tt class="descname">NGHTTP2_ERR_FATAL</tt><a class="headerlink" href="#NGHTTP2_ERR_FATAL" title="Permalink to this definition"></a></dt>
@ -605,15 +618,25 @@ which is analogous to HEADERS in SPDY.</p>
<tt class="descname">nghttp2_opt</tt><a class="headerlink" href="#nghttp2_opt" title="Permalink to this definition"></a></dt>
<dd><p>Configuration options for <a class="reference internal" href="#nghttp2_session" title="nghttp2_session"><tt class="xref c c-type docutils literal"><span class="pre">nghttp2_session</span></tt></a>.</p>
<dl class="macro">
<dt id="NGHTTP2_OPT_NO_AUTO_WINDOW_UPDATE">
<tt class="descname">NGHTTP2_OPT_NO_AUTO_WINDOW_UPDATE</tt><a class="headerlink" href="#NGHTTP2_OPT_NO_AUTO_WINDOW_UPDATE" title="Permalink to this definition"></a></dt>
<dt id="NGHTTP2_OPT_NO_AUTO_STREAM_WINDOW_UPDATE">
<tt class="descname">NGHTTP2_OPT_NO_AUTO_STREAM_WINDOW_UPDATE</tt><a class="headerlink" href="#NGHTTP2_OPT_NO_AUTO_STREAM_WINDOW_UPDATE" title="Permalink to this definition"></a></dt>
<dd><p>(<tt class="docutils literal"><span class="pre">1</span></tt>)
This option prevents the library from sending WINDOW_UPDATE
automatically. If this option is set, the application is
This option prevents the library from sending WINDOW_UPDATE for a
stream automatically. If this option is set, the application is
responsible for sending WINDOW_UPDATE using
<a class="reference internal" href="#nghttp2_submit_window_update" title="nghttp2_submit_window_update"><tt class="xref c c-func docutils literal"><span class="pre">nghttp2_submit_window_update()</span></tt></a>.</p>
</dd></dl>
<dl class="macro">
<dt id="NGHTTP2_OPT_NO_AUTO_CONNECTION_WINDOW_UPDATE">
<tt class="descname">NGHTTP2_OPT_NO_AUTO_CONNECTION_WINDOW_UPDATE</tt><a class="headerlink" href="#NGHTTP2_OPT_NO_AUTO_CONNECTION_WINDOW_UPDATE" title="Permalink to this definition"></a></dt>
<dd><p>(<tt class="docutils literal"><span class="pre">2</span></tt>)
This option prevents the library from sending WINDOW_UPDATE for a
connection automatically. If this option is set, the application
is responsible for sending WINDOW_UPDATE with stream ID 0 using
<a class="reference internal" href="#nghttp2_submit_window_update" title="nghttp2_submit_window_update"><tt class="xref c c-func docutils literal"><span class="pre">nghttp2_submit_window_update()</span></tt></a>.</p>
</dd></dl>
</dd></dl>
</div>
@ -1324,12 +1347,18 @@ required type of <em>optval</em> varies depending on the <em>optname</em>. See
below.</p>
<p>The following <em>optname</em> are supported:</p>
<dl class="docutils">
<dt><a class="reference internal" href="#NGHTTP2_OPT_NO_AUTO_WINDOW_UPDATE" title="NGHTTP2_OPT_NO_AUTO_WINDOW_UPDATE"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_OPT_NO_AUTO_WINDOW_UPDATE</span></tt></a></dt>
<dt><a class="reference internal" href="#NGHTTP2_OPT_NO_AUTO_STREAM_WINDOW_UPDATE" title="NGHTTP2_OPT_NO_AUTO_STREAM_WINDOW_UPDATE"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_OPT_NO_AUTO_STREAM_WINDOW_UPDATE</span></tt></a></dt>
<dd>The <em>optval</em> must be a pointer to <tt class="docutils literal"><span class="pre">int</span></tt>. If the <em>*optval</em> is
nonzero, the library will not send WINDOW_UPDATE automatically.
Therefore, the application is responsible for sending
WINDOW_UPDATE using <a class="reference internal" href="#nghttp2_submit_window_update" title="nghttp2_submit_window_update"><tt class="xref c c-func docutils literal"><span class="pre">nghttp2_submit_window_update()</span></tt></a>. This option
defaults to 0.</dd>
nonzero, the library will not send WINDOW_UPDATE for a stream
automatically. Therefore, the application is responsible for
sending WINDOW_UPDATE using
<a class="reference internal" href="#nghttp2_submit_window_update" title="nghttp2_submit_window_update"><tt class="xref c c-func docutils literal"><span class="pre">nghttp2_submit_window_update()</span></tt></a>. This option defaults to 0.</dd>
<dt><a class="reference internal" href="#NGHTTP2_OPT_NO_AUTO_CONNECTION_WINDOW_UPDATE" title="NGHTTP2_OPT_NO_AUTO_CONNECTION_WINDOW_UPDATE"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_OPT_NO_AUTO_CONNECTION_WINDOW_UPDATE</span></tt></a></dt>
<dd>The <em>optval</em> must be a pointer to <tt class="docutils literal"><span class="pre">int</span></tt>. If the <em>*optval</em> is
nonzero, the library will not send WINDOW_UPDATE for connection
automatically. Therefore, the application is responsible for
sending WINDOW_UPDATE using
<a class="reference internal" href="#nghttp2_submit_window_update" title="nghttp2_submit_window_update"><tt class="xref c c-func docutils literal"><span class="pre">nghttp2_submit_window_update()</span></tt></a>. This option defaults to 0.</dd>
</dl>
<p>This function returns 0 if it succeeds, or one of the following
negative error codes:</p>
@ -1803,6 +1832,9 @@ pointer to the array of <a class="reference internal" href="#nghttp2_settings_en
indicates the number of <a class="reference internal" href="#nghttp2_settings_entry" title="nghttp2_settings_entry"><tt class="xref c c-type docutils literal"><span class="pre">nghttp2_settings_entry</span></tt></a>.</p>
<p>This function does not take ownership of the <em>iv</em>. This function
copies all the elements in the <em>iv</em>.</p>
<p>While updating individual stream&#8217;s local window size, if the window
size becomes strictly larger than NGHTTP2_MAX_WINDOW_SIZE,
RST_STREAM is issued against such a stream.</p>
<p>This function returns 0 if it succeeds, or one of the following
negative error codes:</p>
<dl class="docutils">
@ -1885,20 +1917,28 @@ negative error codes:</p>
<dl class="function">
<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. The effective range of the
<em>window_size_increment</em> is [1, (1 &lt;&lt; 31)-1], inclusive. But the
application must be responsible to keep the resulting window size
&lt;= (1 &lt;&lt; 31)-1. If <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 set in
the <em>flags</em>, 0 can be specified in the <em>window_size_increment</em>. In
fact, if this flag is set, the value specified in the
<em>window_size_increment</em> is ignored.</p>
<dd><p>Submits WINDOW_UPDATE frame.</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
remote endpoint, the local window size is increased by that
difference.</p>
<p>If the <em>window_size_increment</em> is negative, the local window size
is decreased by -<em>window_size_increment</em>. If
<a class="reference internal" href="#NGHTTP2_OPT_NO_AUTO_STREAM_WINDOW_UPDATE" title="NGHTTP2_OPT_NO_AUTO_STREAM_WINDOW_UPDATE"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_OPT_NO_AUTO_STREAM_WINDOW_UPDATE</span></tt></a> (or
<a class="reference internal" href="#NGHTTP2_OPT_NO_AUTO_CONNECTION_WINDOW_UPDATE" title="NGHTTP2_OPT_NO_AUTO_CONNECTION_WINDOW_UPDATE"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_OPT_NO_AUTO_CONNECTION_WINDOW_UPDATE</span></tt></a> if <em>stream_id</em>
is 0) is not set and the library decided that the WINDOW_UPDATE
should be submitted, then WINDOW_UPDATE is queued with the current
received bytes count.</p>
<p>This function returns 0 if it succeeds, or one of the following
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 or negative and
<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>
<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>
<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>

18
genindex.html
View File

@ -129,6 +129,10 @@
</dt>
<dt><a href="apiref.html#NGHTTP2_ERR_FLOW_CONTROL">NGHTTP2_ERR_FLOW_CONTROL (C macro)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_ERR_FRAME_TOO_LARGE">NGHTTP2_ERR_FRAME_TOO_LARGE (C macro)</a>
</dt>
@ -425,6 +429,10 @@
</dt>
<dt><a href="apiref.html#NGHTTP2_MAX_WINDOW_SIZE">NGHTTP2_MAX_WINDOW_SIZE (C macro)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_NO_ERROR">NGHTTP2_NO_ERROR (C macro)</a>
</dt>
@ -452,12 +460,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>
@ -499,7 +507,11 @@
</dt>
<dt><a href="apiref.html#NGHTTP2_OPT_NO_AUTO_WINDOW_UPDATE">NGHTTP2_OPT_NO_AUTO_WINDOW_UPDATE (C macro)</a>
<dt><a href="apiref.html#NGHTTP2_OPT_NO_AUTO_CONNECTION_WINDOW_UPDATE">NGHTTP2_OPT_NO_AUTO_CONNECTION_WINDOW_UPDATE (C macro)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_OPT_NO_AUTO_STREAM_WINDOW_UPDATE">NGHTTP2_OPT_NO_AUTO_STREAM_WINDOW_UPDATE (C macro)</a>
</dt>

BIN
objects.inv
View File

Binary file not shown.

2
searchindex.js
View File

File diff suppressed because one or more lines are too long