Update doc
This commit is contained in:
parent
649e326ce7
commit
f0dfd69da4
|
@ -1594,12 +1594,15 @@ Functions
|
|||
: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, uint8_t flags, int32_t stream_id, int32_t pri)
|
||||
|
||||
|
||||
Submits PRIORITY frame to change the priority of stream *stream_id*
|
||||
to the priority value *pri*.
|
||||
|
||||
The *flags* is currently ignored and should be
|
||||
:macro:`NGHTTP2_FLAG_NONE`.
|
||||
|
||||
This function returns 0 if it succeeds, or one of the following
|
||||
negative error codes:
|
||||
|
||||
|
@ -1610,25 +1613,31 @@ Functions
|
|||
: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, uint8_t flags, int32_t stream_id, nghttp2_error_code error_code)
|
||||
|
||||
|
||||
Submits RST_STREAM frame to cancel/reject the stream *stream_id*
|
||||
with the error code *error_code*.
|
||||
|
||||
The *flags* is currently ignored and should be
|
||||
:macro:`NGHTTP2_FLAG_NONE`.
|
||||
|
||||
This function returns 0 if it succeeds, or one of the following
|
||||
negative error codes:
|
||||
|
||||
:macro:`NGHTTP2_ERR_NOMEM`
|
||||
Out of memory.
|
||||
|
||||
.. function:: int nghttp2_submit_settings(nghttp2_session *session, const nghttp2_settings_entry *iv, size_t niv)
|
||||
.. function:: int nghttp2_submit_settings(nghttp2_session *session, uint8_t flags, const nghttp2_settings_entry *iv, size_t niv)
|
||||
|
||||
|
||||
Stores local settings and submits SETTINGS frame. The *iv* is the
|
||||
pointer to the array of :type:`nghttp2_settings_entry`. The *niv*
|
||||
indicates the number of :type:`nghttp2_settings_entry`.
|
||||
|
||||
The *flags* is currently ignored and should be
|
||||
:macro:`NGHTTP2_FLAG_NONE`.
|
||||
|
||||
This function does not take ownership of the *iv*. This function
|
||||
copies all the elements in the *iv*.
|
||||
|
||||
|
@ -1683,13 +1692,16 @@ Functions
|
|||
:macro:`NGHTTP2_ERR_NOMEM`
|
||||
Out of memory.
|
||||
|
||||
.. function:: int nghttp2_submit_ping(nghttp2_session *session, uint8_t *opaque_data)
|
||||
.. function:: int nghttp2_submit_ping(nghttp2_session *session, uint8_t flags, uint8_t *opaque_data)
|
||||
|
||||
|
||||
Submits PING frame. You don't have to send PING back when you
|
||||
received PING frame. The library automatically submits PING frame
|
||||
in this case.
|
||||
|
||||
The *flags* is currently ignored and should be
|
||||
:macro:`NGHTTP2_FLAG_NONE`.
|
||||
|
||||
If the *opaque_data* is non ``NULL``, then it should point to the 8
|
||||
bytes array of memory to specify opaque data to send with PING
|
||||
frame. If the *opaque_data* is ``NULL``, zero-cleared 8 bytes will
|
||||
|
@ -1701,11 +1713,14 @@ Functions
|
|||
:macro:`NGHTTP2_ERR_NOMEM`
|
||||
Out of memory.
|
||||
|
||||
.. function:: int nghttp2_submit_goaway(nghttp2_session *session, nghttp2_error_code error_code, uint8_t *opaque_data, size_t opaque_data_len)
|
||||
.. function:: int nghttp2_submit_goaway(nghttp2_session *session, uint8_t flags, nghttp2_error_code error_code, uint8_t *opaque_data, size_t opaque_data_len)
|
||||
|
||||
|
||||
Submits GOAWAY frame with the error code *error_code*.
|
||||
|
||||
The *flags* is currently ignored and should be
|
||||
:macro:`NGHTTP2_FLAG_NONE`.
|
||||
|
||||
If the *opaque_data* is not ``NULL`` and *opaque_data_len* is not
|
||||
zero, those data will be sent as additional debug data. The
|
||||
library makes a copy of the memory region pointed by *opaque_data*
|
||||
|
@ -1724,7 +1739,8 @@ Functions
|
|||
|
||||
Submits WINDOW_UPDATE frame.
|
||||
|
||||
The *flags* is currently ignored.
|
||||
The *flags* is currently ignored and should be
|
||||
:macro:`NGHTTP2_FLAG_NONE`.
|
||||
|
||||
If the *window_size_increment* is positive, the WINDOW_UPDATE with
|
||||
that value as window_size_increment is queued. If the
|
||||
|
@ -1740,11 +1756,12 @@ Functions
|
|||
should be submitted, then WINDOW_UPDATE is queued with the current
|
||||
received bytes count.
|
||||
|
||||
If the *window_size_increment* is 0, the function does nothing and
|
||||
returns 0.
|
||||
|
||||
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.
|
||||
:macro:`NGHTTP2_ERR_FLOW_CONTROL`
|
||||
The local window size overflow or gets negative.
|
||||
:macro:`NGHTTP2_ERR_STREAM_CLOSED`
|
||||
|
|
27
apiref.html
27
apiref.html
|
@ -2032,9 +2032,11 @@ negative error codes:</p>
|
|||
|
||||
<dl class="function">
|
||||
<dt id="nghttp2_submit_priority">
|
||||
int <tt class="descname">nghttp2_submit_priority</tt><big>(</big><a class="reference internal" href="#nghttp2_session" title="nghttp2_session">nghttp2_session</a><em> *session</em>, int32_t<em> stream_id</em>, int32_t<em> pri</em><big>)</big><a class="headerlink" href="#nghttp2_submit_priority" title="Permalink to this definition">¶</a></dt>
|
||||
int <tt class="descname">nghttp2_submit_priority</tt><big>(</big><a class="reference internal" href="#nghttp2_session" title="nghttp2_session">nghttp2_session</a><em> *session</em>, uint8_t<em> flags</em>, int32_t<em> stream_id</em>, int32_t<em> pri</em><big>)</big><a class="headerlink" href="#nghttp2_submit_priority" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Submits PRIORITY frame to change the priority of stream <em>stream_id</em>
|
||||
to the priority value <em>pri</em>.</p>
|
||||
<p>The <em>flags</em> is currently ignored and should be
|
||||
<a class="reference internal" href="#NGHTTP2_FLAG_NONE" title="NGHTTP2_FLAG_NONE"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_FLAG_NONE</span></tt></a>.</p>
|
||||
<p>This function returns 0 if it succeeds, or one of the following
|
||||
negative error codes:</p>
|
||||
<dl class="docutils">
|
||||
|
@ -2049,9 +2051,11 @@ negative error codes:</p>
|
|||
|
||||
<dl class="function">
|
||||
<dt id="nghttp2_submit_rst_stream">
|
||||
int <tt class="descname">nghttp2_submit_rst_stream</tt><big>(</big><a class="reference internal" href="#nghttp2_session" title="nghttp2_session">nghttp2_session</a><em> *session</em>, int32_t<em> stream_id</em>, <a class="reference internal" href="#nghttp2_error_code" title="nghttp2_error_code">nghttp2_error_code</a><em> error_code</em><big>)</big><a class="headerlink" href="#nghttp2_submit_rst_stream" title="Permalink to this definition">¶</a></dt>
|
||||
int <tt class="descname">nghttp2_submit_rst_stream</tt><big>(</big><a class="reference internal" href="#nghttp2_session" title="nghttp2_session">nghttp2_session</a><em> *session</em>, uint8_t<em> flags</em>, int32_t<em> stream_id</em>, <a class="reference internal" href="#nghttp2_error_code" title="nghttp2_error_code">nghttp2_error_code</a><em> error_code</em><big>)</big><a class="headerlink" href="#nghttp2_submit_rst_stream" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Submits RST_STREAM frame to cancel/reject the stream <em>stream_id</em>
|
||||
with the error code <em>error_code</em>.</p>
|
||||
<p>The <em>flags</em> is currently ignored and should be
|
||||
<a class="reference internal" href="#NGHTTP2_FLAG_NONE" title="NGHTTP2_FLAG_NONE"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_FLAG_NONE</span></tt></a>.</p>
|
||||
<p>This function returns 0 if it succeeds, or one of the following
|
||||
negative error codes:</p>
|
||||
<dl class="docutils">
|
||||
|
@ -2062,10 +2066,12 @@ negative error codes:</p>
|
|||
|
||||
<dl class="function">
|
||||
<dt id="nghttp2_submit_settings">
|
||||
int <tt class="descname">nghttp2_submit_settings</tt><big>(</big><a class="reference internal" href="#nghttp2_session" title="nghttp2_session">nghttp2_session</a><em> *session</em>, const <a class="reference internal" href="#nghttp2_settings_entry" title="nghttp2_settings_entry">nghttp2_settings_entry</a><em> *iv</em>, size_t<em> niv</em><big>)</big><a class="headerlink" href="#nghttp2_submit_settings" title="Permalink to this definition">¶</a></dt>
|
||||
int <tt class="descname">nghttp2_submit_settings</tt><big>(</big><a class="reference internal" href="#nghttp2_session" title="nghttp2_session">nghttp2_session</a><em> *session</em>, uint8_t<em> flags</em>, const <a class="reference internal" href="#nghttp2_settings_entry" title="nghttp2_settings_entry">nghttp2_settings_entry</a><em> *iv</em>, size_t<em> niv</em><big>)</big><a class="headerlink" href="#nghttp2_submit_settings" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Stores local settings and submits SETTINGS frame. The <em>iv</em> is the
|
||||
pointer to the array 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>. The <em>niv</em>
|
||||
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>The <em>flags</em> is currently ignored and should be
|
||||
<a class="reference internal" href="#NGHTTP2_FLAG_NONE" title="NGHTTP2_FLAG_NONE"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_FLAG_NONE</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’s local window size, if the window
|
||||
|
@ -2119,10 +2125,12 @@ negative error codes:</p>
|
|||
|
||||
<dl class="function">
|
||||
<dt id="nghttp2_submit_ping">
|
||||
int <tt class="descname">nghttp2_submit_ping</tt><big>(</big><a class="reference internal" href="#nghttp2_session" title="nghttp2_session">nghttp2_session</a><em> *session</em>, uint8_t<em> *opaque_data</em><big>)</big><a class="headerlink" href="#nghttp2_submit_ping" title="Permalink to this definition">¶</a></dt>
|
||||
int <tt class="descname">nghttp2_submit_ping</tt><big>(</big><a class="reference internal" href="#nghttp2_session" title="nghttp2_session">nghttp2_session</a><em> *session</em>, uint8_t<em> flags</em>, uint8_t<em> *opaque_data</em><big>)</big><a class="headerlink" href="#nghttp2_submit_ping" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Submits PING frame. You don’t have to send PING back when you
|
||||
received PING frame. The library automatically submits PING frame
|
||||
in this case.</p>
|
||||
<p>The <em>flags</em> is currently ignored and should be
|
||||
<a class="reference internal" href="#NGHTTP2_FLAG_NONE" title="NGHTTP2_FLAG_NONE"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_FLAG_NONE</span></tt></a>.</p>
|
||||
<p>If the <em>opaque_data</em> is non <tt class="docutils literal"><span class="pre">NULL</span></tt>, then it should point to the 8
|
||||
bytes array of memory to specify opaque data to send with PING
|
||||
frame. If the <em>opaque_data</em> is <tt class="docutils literal"><span class="pre">NULL</span></tt>, zero-cleared 8 bytes will
|
||||
|
@ -2137,8 +2145,10 @@ negative error codes:</p>
|
|||
|
||||
<dl class="function">
|
||||
<dt id="nghttp2_submit_goaway">
|
||||
int <tt class="descname">nghttp2_submit_goaway</tt><big>(</big><a class="reference internal" href="#nghttp2_session" title="nghttp2_session">nghttp2_session</a><em> *session</em>, <a class="reference internal" href="#nghttp2_error_code" title="nghttp2_error_code">nghttp2_error_code</a><em> error_code</em>, uint8_t<em> *opaque_data</em>, size_t<em> opaque_data_len</em><big>)</big><a class="headerlink" href="#nghttp2_submit_goaway" title="Permalink to this definition">¶</a></dt>
|
||||
int <tt class="descname">nghttp2_submit_goaway</tt><big>(</big><a class="reference internal" href="#nghttp2_session" title="nghttp2_session">nghttp2_session</a><em> *session</em>, uint8_t<em> flags</em>, <a class="reference internal" href="#nghttp2_error_code" title="nghttp2_error_code">nghttp2_error_code</a><em> error_code</em>, uint8_t<em> *opaque_data</em>, size_t<em> opaque_data_len</em><big>)</big><a class="headerlink" href="#nghttp2_submit_goaway" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Submits GOAWAY frame with the error code <em>error_code</em>.</p>
|
||||
<p>The <em>flags</em> is currently ignored and should be
|
||||
<a class="reference internal" href="#NGHTTP2_FLAG_NONE" title="NGHTTP2_FLAG_NONE"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_FLAG_NONE</span></tt></a>.</p>
|
||||
<p>If the <em>opaque_data</em> is not <tt class="docutils literal"><span class="pre">NULL</span></tt> and <em>opaque_data_len</em> is not
|
||||
zero, those data will be sent as additional debug data. The
|
||||
library makes a copy of the memory region pointed by <em>opaque_data</em>
|
||||
|
@ -2157,7 +2167,8 @@ 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> *session</em>, uint8_t<em> flags</em>, int32_t<em> stream_id</em>, int32_t<em> 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>The <em>flags</em> is currently ignored and should be
|
||||
<a class="reference internal" href="#NGHTTP2_FLAG_NONE" title="NGHTTP2_FLAG_NONE"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_FLAG_NONE</span></tt></a>.</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
|
||||
|
@ -2170,11 +2181,11 @@ is decreased by -<em>window_size_increment</em>. If
|
|||
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>If the <em>window_size_increment</em> is 0, the function does nothing and
|
||||
returns 0.</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.</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>
|
||||
|
|
|
@ -1887,6 +1887,9 @@
|
|||
<span class="cm"> * Submits PRIORITY frame to change the priority of stream |stream_id|</span>
|
||||
<span class="cm"> * to the priority value |pri|.</span>
|
||||
<span class="cm"> *</span>
|
||||
<span class="cm"> * The |flags| is currently ignored and should be</span>
|
||||
<span class="cm"> * :enum:`NGHTTP2_FLAG_NONE`.</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>
|
||||
|
@ -1897,8 +1900,8 @@
|
|||
<span class="cm"> * :enum:`NGHTTP2_ERR_STREAM_CLOSED`</span>
|
||||
<span class="cm"> * The stream is already closed or does not exist.</span>
|
||||
<span class="cm"> */</span>
|
||||
<span class="kt">int</span> <span class="nf">nghttp2_submit_priority</span><span class="p">(</span><span class="n">nghttp2_session</span> <span class="o">*</span><span class="n">session</span><span class="p">,</span> <span class="kt">int32_t</span> <span class="n">stream_id</span><span class="p">,</span>
|
||||
<span class="kt">int32_t</span> <span class="n">pri</span><span class="p">);</span>
|
||||
<span class="kt">int</span> <span class="nf">nghttp2_submit_priority</span><span class="p">(</span><span class="n">nghttp2_session</span> <span class="o">*</span><span class="n">session</span><span class="p">,</span> <span class="kt">uint8_t</span> <span class="n">flags</span><span class="p">,</span>
|
||||
<span class="kt">int32_t</span> <span class="n">stream_id</span><span class="p">,</span> <span class="kt">int32_t</span> <span class="n">pri</span><span class="p">);</span>
|
||||
|
||||
<span class="cm">/**</span>
|
||||
<span class="cm"> * @function</span>
|
||||
|
@ -1906,13 +1909,17 @@
|
|||
<span class="cm"> * Submits RST_STREAM frame to cancel/reject the stream |stream_id|</span>
|
||||
<span class="cm"> * with the error code |error_code|.</span>
|
||||
<span class="cm"> *</span>
|
||||
<span class="cm"> * The |flags| is currently ignored and should be</span>
|
||||
<span class="cm"> * :enum:`NGHTTP2_FLAG_NONE`.</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>
|
||||
<span class="cm"> * :enum:`NGHTTP2_ERR_NOMEM`</span>
|
||||
<span class="cm"> * Out of memory.</span>
|
||||
<span class="cm"> */</span>
|
||||
<span class="kt">int</span> <span class="nf">nghttp2_submit_rst_stream</span><span class="p">(</span><span class="n">nghttp2_session</span> <span class="o">*</span><span class="n">session</span><span class="p">,</span> <span class="kt">int32_t</span> <span class="n">stream_id</span><span class="p">,</span>
|
||||
<span class="kt">int</span> <span class="nf">nghttp2_submit_rst_stream</span><span class="p">(</span><span class="n">nghttp2_session</span> <span class="o">*</span><span class="n">session</span><span class="p">,</span> <span class="kt">uint8_t</span> <span class="n">flags</span><span class="p">,</span>
|
||||
<span class="kt">int32_t</span> <span class="n">stream_id</span><span class="p">,</span>
|
||||
<span class="n">nghttp2_error_code</span> <span class="n">error_code</span><span class="p">);</span>
|
||||
|
||||
<span class="cm">/**</span>
|
||||
|
@ -1922,6 +1929,9 @@
|
|||
<span class="cm"> * pointer to the array of :type:`nghttp2_settings_entry`. The |niv|</span>
|
||||
<span class="cm"> * indicates the number of :type:`nghttp2_settings_entry`.</span>
|
||||
<span class="cm"> *</span>
|
||||
<span class="cm"> * The |flags| is currently ignored and should be</span>
|
||||
<span class="cm"> * :enum:`NGHTTP2_FLAG_NONE`.</span>
|
||||
<span class="cm"> *</span>
|
||||
<span class="cm"> * This function does not take ownership of the |iv|. This function</span>
|
||||
<span class="cm"> * copies all the elements in the |iv|.</span>
|
||||
<span class="cm"> *</span>
|
||||
|
@ -1938,7 +1948,7 @@
|
|||
<span class="cm"> * :enum:`NGHTTP2_ERR_NOMEM`</span>
|
||||
<span class="cm"> * Out of memory.</span>
|
||||
<span class="cm"> */</span>
|
||||
<span class="kt">int</span> <span class="nf">nghttp2_submit_settings</span><span class="p">(</span><span class="n">nghttp2_session</span> <span class="o">*</span><span class="n">session</span><span class="p">,</span>
|
||||
<span class="kt">int</span> <span class="nf">nghttp2_submit_settings</span><span class="p">(</span><span class="n">nghttp2_session</span> <span class="o">*</span><span class="n">session</span><span class="p">,</span> <span class="kt">uint8_t</span> <span class="n">flags</span><span class="p">,</span>
|
||||
<span class="k">const</span> <span class="n">nghttp2_settings_entry</span> <span class="o">*</span><span class="n">iv</span><span class="p">,</span> <span class="kt">size_t</span> <span class="n">niv</span><span class="p">);</span>
|
||||
|
||||
|
||||
|
@ -1990,6 +2000,9 @@
|
|||
<span class="cm"> * received PING frame. The library automatically submits PING frame</span>
|
||||
<span class="cm"> * in this case.</span>
|
||||
<span class="cm"> *</span>
|
||||
<span class="cm"> * The |flags| is currently ignored and should be</span>
|
||||
<span class="cm"> * :enum:`NGHTTP2_FLAG_NONE`.</span>
|
||||
<span class="cm"> *</span>
|
||||
<span class="cm"> * If the |opaque_data| is non ``NULL``, then it should point to the 8</span>
|
||||
<span class="cm"> * bytes array of memory to specify opaque data to send with PING</span>
|
||||
<span class="cm"> * frame. If the |opaque_data| is ``NULL``, zero-cleared 8 bytes will</span>
|
||||
|
@ -2001,13 +2014,17 @@
|
|||
<span class="cm"> * :enum:`NGHTTP2_ERR_NOMEM`</span>
|
||||
<span class="cm"> * Out of memory.</span>
|
||||
<span class="cm"> */</span>
|
||||
<span class="kt">int</span> <span class="nf">nghttp2_submit_ping</span><span class="p">(</span><span class="n">nghttp2_session</span> <span class="o">*</span><span class="n">session</span><span class="p">,</span> <span class="kt">uint8_t</span> <span class="o">*</span><span class="n">opaque_data</span><span class="p">);</span>
|
||||
<span class="kt">int</span> <span class="nf">nghttp2_submit_ping</span><span class="p">(</span><span class="n">nghttp2_session</span> <span class="o">*</span><span class="n">session</span><span class="p">,</span> <span class="kt">uint8_t</span> <span class="n">flags</span><span class="p">,</span>
|
||||
<span class="kt">uint8_t</span> <span class="o">*</span><span class="n">opaque_data</span><span class="p">);</span>
|
||||
|
||||
<span class="cm">/**</span>
|
||||
<span class="cm"> * @function</span>
|
||||
<span class="cm"> *</span>
|
||||
<span class="cm"> * Submits GOAWAY frame with the error code |error_code|.</span>
|
||||
<span class="cm"> *</span>
|
||||
<span class="cm"> * The |flags| is currently ignored and should be</span>
|
||||
<span class="cm"> * :enum:`NGHTTP2_FLAG_NONE`.</span>
|
||||
<span class="cm"> *</span>
|
||||
<span class="cm"> * If the |opaque_data| is not ``NULL`` and |opaque_data_len| is not</span>
|
||||
<span class="cm"> * zero, those data will be sent as additional debug data. The</span>
|
||||
<span class="cm"> * library makes a copy of the memory region pointed by |opaque_data|</span>
|
||||
|
@ -2021,7 +2038,7 @@
|
|||
<span class="cm"> * :enum:`NGHTTP2_ERR_NOMEM`</span>
|
||||
<span class="cm"> * Out of memory.</span>
|
||||
<span class="cm"> */</span>
|
||||
<span class="kt">int</span> <span class="nf">nghttp2_submit_goaway</span><span class="p">(</span><span class="n">nghttp2_session</span> <span class="o">*</span><span class="n">session</span><span class="p">,</span>
|
||||
<span class="kt">int</span> <span class="nf">nghttp2_submit_goaway</span><span class="p">(</span><span class="n">nghttp2_session</span> <span class="o">*</span><span class="n">session</span><span class="p">,</span> <span class="kt">uint8_t</span> <span class="n">flags</span><span class="p">,</span>
|
||||
<span class="n">nghttp2_error_code</span> <span class="n">error_code</span><span class="p">,</span>
|
||||
<span class="kt">uint8_t</span> <span class="o">*</span><span class="n">opaque_data</span><span class="p">,</span> <span class="kt">size_t</span> <span class="n">opaque_data_len</span><span class="p">);</span>
|
||||
|
||||
|
@ -2030,7 +2047,8 @@
|
|||
<span class="cm"> *</span>
|
||||
<span class="cm"> * Submits WINDOW_UPDATE frame.</span>
|
||||
<span class="cm"> *</span>
|
||||
<span class="cm"> * The |flags| is currently ignored.</span>
|
||||
<span class="cm"> * The |flags| is currently ignored and should be</span>
|
||||
<span class="cm"> * :enum:`NGHTTP2_FLAG_NONE`.</span>
|
||||
<span class="cm"> *</span>
|
||||
<span class="cm"> * If the |window_size_increment| is positive, the WINDOW_UPDATE with</span>
|
||||
<span class="cm"> * that value as window_size_increment is queued. If the</span>
|
||||
|
@ -2046,11 +2064,12 @@
|
|||
<span class="cm"> * should be submitted, then WINDOW_UPDATE is queued with the current</span>
|
||||
<span class="cm"> * received bytes count.</span>
|
||||
<span class="cm"> *</span>
|
||||
<span class="cm"> * If the |window_size_increment| is 0, the function does nothing and</span>
|
||||
<span class="cm"> * returns 0.</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>
|
||||
<span class="cm"> * :enum:`NGHTTP2_ERR_INVALID_ARGUMENT`</span>
|
||||
<span class="cm"> * The |delta_window_size| is 0.</span>
|
||||
<span class="cm"> * :enum:`NGHTTP2_ERR_FLOW_CONTROL`</span>
|
||||
<span class="cm"> * The local window size overflow or gets negative.</span>
|
||||
<span class="cm"> * :enum:`NGHTTP2_ERR_STREAM_CLOSED`</span>
|
||||
|
|
File diff suppressed because one or more lines are too long
Loading…
Reference in New Issue