Update doc
This commit is contained in:
parent
5761af75d4
commit
3aba7fdd83
|
@ -411,6 +411,20 @@ Enums
|
|||
connection automatically. If this option is set, the application
|
||||
is responsible for sending WINDOW_UPDATE with stream ID 0 using
|
||||
`nghttp2_submit_window_update`.
|
||||
.. macro:: NGHTTP2_OPT_PEER_MAX_CONCURRENT_STREAMS
|
||||
|
||||
(``3``)
|
||||
This option sets the SETTINGS_MAX_CONCURRENT_STREAMS value of
|
||||
remote endpoint as if it is received in SETTINGS frame. Without
|
||||
specifying this option, before the local endpoint receives
|
||||
SETTINGS_MAX_CONCURRENT_STREAMS in SETTINGS frame from remote
|
||||
endpoint, SETTINGS_MAX_CONCURRENT_STREAMS is unlimited. This may
|
||||
cause problem if local endpoint submits lots of requests
|
||||
initially and sending them at once to the remote peer may lead to
|
||||
the rejection of some requests. Specifying this option to the
|
||||
sensible value, say 100, may avoid this kind of issue. This value
|
||||
will be overwritten if the local endpoint receives
|
||||
SETTINGS_MAX_CONCURRENT_STREAMS from the remote endpoint.
|
||||
|
||||
|
||||
|
||||
|
@ -1059,6 +1073,10 @@ Functions
|
|||
sending WINDOW_UPDATE using
|
||||
`nghttp2_submit_window_update`. This option defaults to 0.
|
||||
|
||||
:macro:`NGHTTP2_OPT_PEER_MAX_CONCURRENT_STREAMS`
|
||||
The *optval* must be a pointer to ``ssize_t``. It is an error
|
||||
if *\*optval* is 0 or negative.
|
||||
|
||||
This function returns 0 if it succeeds, or one of the following
|
||||
negative error codes:
|
||||
|
||||
|
|
20
apiref.html
20
apiref.html
|
@ -657,6 +657,23 @@ 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>
|
||||
|
||||
<dl class="macro">
|
||||
<dt id="NGHTTP2_OPT_PEER_MAX_CONCURRENT_STREAMS">
|
||||
<tt class="descname">NGHTTP2_OPT_PEER_MAX_CONCURRENT_STREAMS</tt><a class="headerlink" href="#NGHTTP2_OPT_PEER_MAX_CONCURRENT_STREAMS" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>(<tt class="docutils literal"><span class="pre">3</span></tt>)
|
||||
This option sets the SETTINGS_MAX_CONCURRENT_STREAMS value of
|
||||
remote endpoint as if it is received in SETTINGS frame. Without
|
||||
specifying this option, before the local endpoint receives
|
||||
SETTINGS_MAX_CONCURRENT_STREAMS in SETTINGS frame from remote
|
||||
endpoint, SETTINGS_MAX_CONCURRENT_STREAMS is unlimited. This may
|
||||
cause problem if local endpoint submits lots of requests
|
||||
initially and sending them at once to the remote peer may lead to
|
||||
the rejection of some requests. Specifying this option to the
|
||||
sensible value, say 100, may avoid this kind of issue. This value
|
||||
will be overwritten if the local endpoint receives
|
||||
SETTINGS_MAX_CONCURRENT_STREAMS from the remote endpoint.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
|
@ -1492,6 +1509,9 @@ 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>
|
||||
<dt><a class="reference internal" href="#NGHTTP2_OPT_PEER_MAX_CONCURRENT_STREAMS" title="NGHTTP2_OPT_PEER_MAX_CONCURRENT_STREAMS"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_OPT_PEER_MAX_CONCURRENT_STREAMS</span></tt></a></dt>
|
||||
<dd>The <em>optval</em> must be a pointer to <tt class="docutils literal"><span class="pre">ssize_t</span></tt>. It is an error
|
||||
if <em>*optval</em> is 0 or negative.</dd>
|
||||
</dl>
|
||||
<p>This function returns 0 if it succeeds, or one of the following
|
||||
negative error codes:</p>
|
||||
|
|
|
@ -480,12 +480,12 @@
|
|||
<dt><a href="apiref.html#nghttp2_nv_compare_name">nghttp2_nv_compare_name (C function)</a>
|
||||
</dt>
|
||||
|
||||
</dl></td>
|
||||
<td style="width: 33%" valign="top"><dl>
|
||||
|
||||
<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>
|
||||
|
@ -539,6 +539,10 @@
|
|||
</dt>
|
||||
|
||||
|
||||
<dt><a href="apiref.html#NGHTTP2_OPT_PEER_MAX_CONCURRENT_STREAMS">NGHTTP2_OPT_PEER_MAX_CONCURRENT_STREAMS (C macro)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="apiref.html#nghttp2_pack_settings_payload">nghttp2_pack_settings_payload (C function)</a>
|
||||
</dt>
|
||||
|
||||
|
|
|
@ -1258,7 +1258,21 @@
|
|||
<span class="cm"> * is responsible for sending WINDOW_UPDATE with stream ID 0 using</span>
|
||||
<span class="cm"> * `nghttp2_submit_window_update`.</span>
|
||||
<span class="cm"> */</span>
|
||||
<span class="n">NGHTTP2_OPT_NO_AUTO_CONNECTION_WINDOW_UPDATE</span> <span class="o">=</span> <span class="mi">2</span>
|
||||
<span class="n">NGHTTP2_OPT_NO_AUTO_CONNECTION_WINDOW_UPDATE</span> <span class="o">=</span> <span class="mi">2</span><span class="p">,</span>
|
||||
<span class="cm">/**</span>
|
||||
<span class="cm"> * This option sets the SETTINGS_MAX_CONCURRENT_STREAMS value of</span>
|
||||
<span class="cm"> * remote endpoint as if it is received in SETTINGS frame. Without</span>
|
||||
<span class="cm"> * specifying this option, before the local endpoint receives</span>
|
||||
<span class="cm"> * SETTINGS_MAX_CONCURRENT_STREAMS in SETTINGS frame from remote</span>
|
||||
<span class="cm"> * endpoint, SETTINGS_MAX_CONCURRENT_STREAMS is unlimited. This may</span>
|
||||
<span class="cm"> * cause problem if local endpoint submits lots of requests</span>
|
||||
<span class="cm"> * initially and sending them at once to the remote peer may lead to</span>
|
||||
<span class="cm"> * the rejection of some requests. Specifying this option to the</span>
|
||||
<span class="cm"> * sensible value, say 100, may avoid this kind of issue. This value</span>
|
||||
<span class="cm"> * will be overwritten if the local endpoint receives</span>
|
||||
<span class="cm"> * SETTINGS_MAX_CONCURRENT_STREAMS from the remote endpoint.</span>
|
||||
<span class="cm"> */</span>
|
||||
<span class="n">NGHTTP2_OPT_PEER_MAX_CONCURRENT_STREAMS</span> <span class="o">=</span> <span class="mi">3</span>
|
||||
<span class="p">}</span> <span class="n">nghttp2_opt</span><span class="p">;</span>
|
||||
|
||||
<span class="cm">/**</span>
|
||||
|
@ -1286,6 +1300,10 @@
|
|||
<span class="cm"> * sending WINDOW_UPDATE using</span>
|
||||
<span class="cm"> * `nghttp2_submit_window_update`. This option defaults to 0.</span>
|
||||
<span class="cm"> *</span>
|
||||
<span class="cm"> * :enum:`NGHTTP2_OPT_PEER_MAX_CONCURRENT_STREAMS`</span>
|
||||
<span class="cm"> * The |optval| must be a pointer to ``ssize_t``. It is an error</span>
|
||||
<span class="cm"> * if |*optval| is 0 or negative.</span>
|
||||
<span class="cm"> *</span>
|
||||
<span class="cm"> * This function returns 0 if it succeeds, or one of the following</span>
|
||||
<span class="cm"> * negative error codes:</span>
|
||||
<span class="cm"> *</span>
|
||||
|
|
BIN
objects.inv
BIN
objects.inv
Binary file not shown.
File diff suppressed because one or more lines are too long
Loading…
Reference in New Issue