Update doc
This commit is contained in:
parent
3aba7fdd83
commit
8fdd757280
|
@ -207,6 +207,10 @@ Enums
|
||||||
|
|
||||||
(``-525``)
|
(``-525``)
|
||||||
Insufficient buffer size given to function.
|
Insufficient buffer size given to function.
|
||||||
|
.. macro:: NGHTTP2_ERR_PAUSE
|
||||||
|
|
||||||
|
(``-526``)
|
||||||
|
Callback was paused by the application
|
||||||
.. macro:: NGHTTP2_ERR_FATAL
|
.. macro:: NGHTTP2_ERR_FATAL
|
||||||
|
|
||||||
(``-900``)
|
(``-900``)
|
||||||
|
@ -755,8 +759,19 @@ Types (structs, unions and typedefs)
|
||||||
argument passed in to the call to `nghttp2_session_client_new()` or
|
argument passed in to the call to `nghttp2_session_client_new()` or
|
||||||
`nghttp2_session_server_new()`.
|
`nghttp2_session_server_new()`.
|
||||||
|
|
||||||
|
If the application uses `nghttp2_session_mem_recv()`, it can return
|
||||||
|
:macro:`NGHTTP2_ERR_PAUSE` to make `nghttp2_session_mem_recv()`
|
||||||
|
return without processing further input bytes. The *frame*
|
||||||
|
parameter is retained until `nghttp2_session_continue()` is
|
||||||
|
called. The application must retain the input bytes which was used
|
||||||
|
to produce the *frame* parameter, because it may refer to the
|
||||||
|
memory region included in the input bytes. The application which
|
||||||
|
returns :macro:`NGHTTP2_ERR_PAUSE` must call
|
||||||
|
`nghttp2_session_continue()` before `nghttp2_session_mem_recv()`.
|
||||||
|
|
||||||
The implementation of this function must return 0 if it
|
The implementation of this function must return 0 if it
|
||||||
succeeds. If nonzero is returned, it is treated as fatal error and
|
succeeds. It may return :macro:`NGHTTP2_ERR_PAUSE`. If the other
|
||||||
|
nonzero value is returned, it is treated as fatal error and
|
||||||
`nghttp2_session_recv()` and `nghttp2_session_send()` functions
|
`nghttp2_session_recv()` and `nghttp2_session_send()` functions
|
||||||
immediately return :macro:`NGHTTP2_ERR_CALLBACK_FAILURE`.
|
immediately return :macro:`NGHTTP2_ERR_CALLBACK_FAILURE`.
|
||||||
|
|
||||||
|
@ -789,6 +804,16 @@ Types (structs, unions and typedefs)
|
||||||
third argument passed in to the call to
|
third argument passed in to the call to
|
||||||
`nghttp2_session_client_new()` or `nghttp2_session_server_new()`.
|
`nghttp2_session_client_new()` or `nghttp2_session_server_new()`.
|
||||||
|
|
||||||
|
If the application uses `nghttp2_session_mem_recv()`, it can return
|
||||||
|
:macro:`NGHTTP2_ERR_PAUSE` to make `nghttp2_session_mem_recv()`
|
||||||
|
return without processing further input bytes. The *frame*
|
||||||
|
parameter is retained until `nghttp2_session_continue()` is
|
||||||
|
called. The application must retain the input bytes which was used
|
||||||
|
to produce the *frame* parameter, because it may refer to the
|
||||||
|
memory region included in the input bytes. The application which
|
||||||
|
returns :macro:`NGHTTP2_ERR_PAUSE` must call
|
||||||
|
`nghttp2_session_continue()` before `nghttp2_session_mem_recv()`.
|
||||||
|
|
||||||
The implementation of this function must return 0 if it
|
The implementation of this function must return 0 if it
|
||||||
succeeds. If nonzero is returned, it is treated as fatal error and
|
succeeds. If nonzero is returned, it is treated as fatal error and
|
||||||
`nghttp2_session_recv()` and `nghttp2_session_send()` functions
|
`nghttp2_session_recv()` and `nghttp2_session_send()` functions
|
||||||
|
@ -1206,13 +1231,46 @@ Functions
|
||||||
`nghttp2_session_recv()`.
|
`nghttp2_session_recv()`.
|
||||||
|
|
||||||
In the current implementation, this function always tries to
|
In the current implementation, this function always tries to
|
||||||
processes all input data unless an error occurs.
|
processes all input data unless either an error occurs or
|
||||||
|
:macro:`NGHTTP2_ERR_PAUSE` is returned from
|
||||||
|
:member:`nghttp2_session_callbacks.on_frame_recv_callback` or
|
||||||
|
:member:`nghttp2_session_callbacks.on_data_chunk_recv_callback`.
|
||||||
|
If :macro:`NGHTTP2_ERR_PAUSE` is used, the return value includes the
|
||||||
|
number of bytes which was used to produce the data or frame for the
|
||||||
|
callback.
|
||||||
|
|
||||||
This function returns the number of processed bytes, or one of the
|
This function returns the number of processed bytes, or one of the
|
||||||
following negative error codes:
|
following negative error codes:
|
||||||
|
|
||||||
:macro:`NGHTTP2_ERR_NOMEM`
|
:macro:`NGHTTP2_ERR_NOMEM`
|
||||||
Out of memory.
|
Out of memory.
|
||||||
|
:macro:`NGHTTP2_ERR_CALLBACK_FAILURE`
|
||||||
|
The callback function failed.
|
||||||
|
|
||||||
|
.. function:: int nghttp2_session_continue(nghttp2_session *session)
|
||||||
|
|
||||||
|
|
||||||
|
Perform post-processing after `nghttp2_session_mem_recv()` was
|
||||||
|
paused by :macro:`NGHTTP2_ERR_PAUSE` from
|
||||||
|
:member:`nghttp2_session_callbacks.on_frame_recv_callback` or
|
||||||
|
:member:`nghttp2_session_callbacks.on_data_chunk_recv_callback`.
|
||||||
|
|
||||||
|
This function frees resources associated with paused frames. It
|
||||||
|
may also call additional callbacks, such as
|
||||||
|
:member:`nghttp2_session_callbacks.on_stream_close_callback`.
|
||||||
|
|
||||||
|
If this function succeeds, the application can call
|
||||||
|
`nghttp2_session_mem_recv()` again.
|
||||||
|
|
||||||
|
This function returns 0 if it succeeds, or one of the following
|
||||||
|
negative error codes:
|
||||||
|
|
||||||
|
|
||||||
|
:macro:`NGHTTP2_ERR_NOMEM`
|
||||||
|
Out of memory.
|
||||||
|
:macro:`NGHTTP2_ERR_CALLBACK_FAILURE`
|
||||||
|
The callback function failed.
|
||||||
|
|
||||||
|
|
||||||
.. function:: int nghttp2_session_resume_data(nghttp2_session *session, int32_t stream_id)
|
.. function:: int nghttp2_session_resume_data(nghttp2_session *session, int32_t stream_id)
|
||||||
|
|
||||||
|
|
60
apiref.html
60
apiref.html
|
@ -345,6 +345,13 @@ Flow control error</p>
|
||||||
Insufficient buffer size given to function.</p>
|
Insufficient buffer size given to function.</p>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
|
<dl class="macro">
|
||||||
|
<dt id="NGHTTP2_ERR_PAUSE">
|
||||||
|
<tt class="descname">NGHTTP2_ERR_PAUSE</tt><a class="headerlink" href="#NGHTTP2_ERR_PAUSE" title="Permalink to this definition">¶</a></dt>
|
||||||
|
<dd><p>(<tt class="docutils literal"><span class="pre">-526</span></tt>)
|
||||||
|
Callback was paused by the application</p>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="macro">
|
<dl class="macro">
|
||||||
<dt id="NGHTTP2_ERR_FATAL">
|
<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>
|
<tt class="descname">NGHTTP2_ERR_FATAL</tt><a class="headerlink" href="#NGHTTP2_ERR_FATAL" title="Permalink to this definition">¶</a></dt>
|
||||||
|
@ -1152,8 +1159,18 @@ typedef int <tt class="descname">(*nghttp2_on_frame_recv_callback)</tt><big>(</b
|
||||||
non-DATA frame is received. The <em>user_data</em> pointer is the third
|
non-DATA frame is received. The <em>user_data</em> pointer is the third
|
||||||
argument passed in to the call to <a class="reference internal" href="#nghttp2_session_client_new" title="nghttp2_session_client_new"><tt class="xref c c-func docutils literal"><span class="pre">nghttp2_session_client_new()</span></tt></a> or
|
argument passed in to the call to <a class="reference internal" href="#nghttp2_session_client_new" title="nghttp2_session_client_new"><tt class="xref c c-func docutils literal"><span class="pre">nghttp2_session_client_new()</span></tt></a> or
|
||||||
<a class="reference internal" href="#nghttp2_session_server_new" title="nghttp2_session_server_new"><tt class="xref c c-func docutils literal"><span class="pre">nghttp2_session_server_new()</span></tt></a>.</p>
|
<a class="reference internal" href="#nghttp2_session_server_new" title="nghttp2_session_server_new"><tt class="xref c c-func docutils literal"><span class="pre">nghttp2_session_server_new()</span></tt></a>.</p>
|
||||||
|
<p>If the application uses <a class="reference internal" href="#nghttp2_session_mem_recv" title="nghttp2_session_mem_recv"><tt class="xref c c-func docutils literal"><span class="pre">nghttp2_session_mem_recv()</span></tt></a>, it can return
|
||||||
|
<a class="reference internal" href="#NGHTTP2_ERR_PAUSE" title="NGHTTP2_ERR_PAUSE"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_ERR_PAUSE</span></tt></a> to make <a class="reference internal" href="#nghttp2_session_mem_recv" title="nghttp2_session_mem_recv"><tt class="xref c c-func docutils literal"><span class="pre">nghttp2_session_mem_recv()</span></tt></a>
|
||||||
|
return without processing further input bytes. The <em>frame</em>
|
||||||
|
parameter is retained until <a class="reference internal" href="#nghttp2_session_continue" title="nghttp2_session_continue"><tt class="xref c c-func docutils literal"><span class="pre">nghttp2_session_continue()</span></tt></a> is
|
||||||
|
called. The application must retain the input bytes which was used
|
||||||
|
to produce the <em>frame</em> parameter, because it may refer to the
|
||||||
|
memory region included in the input bytes. The application which
|
||||||
|
returns <a class="reference internal" href="#NGHTTP2_ERR_PAUSE" title="NGHTTP2_ERR_PAUSE"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_ERR_PAUSE</span></tt></a> must call
|
||||||
|
<a class="reference internal" href="#nghttp2_session_continue" title="nghttp2_session_continue"><tt class="xref c c-func docutils literal"><span class="pre">nghttp2_session_continue()</span></tt></a> before <a class="reference internal" href="#nghttp2_session_mem_recv" title="nghttp2_session_mem_recv"><tt class="xref c c-func docutils literal"><span class="pre">nghttp2_session_mem_recv()</span></tt></a>.</p>
|
||||||
<p>The implementation of this function must return 0 if it
|
<p>The implementation of this function must return 0 if it
|
||||||
succeeds. If nonzero is returned, it is treated as fatal error and
|
succeeds. It may return <a class="reference internal" href="#NGHTTP2_ERR_PAUSE" title="NGHTTP2_ERR_PAUSE"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_ERR_PAUSE</span></tt></a>. If the other
|
||||||
|
nonzero value is returned, it is treated as fatal error and
|
||||||
<a class="reference internal" href="#nghttp2_session_recv" title="nghttp2_session_recv"><tt class="xref c c-func docutils literal"><span class="pre">nghttp2_session_recv()</span></tt></a> and <a class="reference internal" href="#nghttp2_session_send" title="nghttp2_session_send"><tt class="xref c c-func docutils literal"><span class="pre">nghttp2_session_send()</span></tt></a> functions
|
<a class="reference internal" href="#nghttp2_session_recv" title="nghttp2_session_recv"><tt class="xref c c-func docutils literal"><span class="pre">nghttp2_session_recv()</span></tt></a> and <a class="reference internal" href="#nghttp2_session_send" title="nghttp2_session_send"><tt class="xref c c-func docutils literal"><span class="pre">nghttp2_session_send()</span></tt></a> functions
|
||||||
immediately return <a class="reference internal" href="#NGHTTP2_ERR_CALLBACK_FAILURE" title="NGHTTP2_ERR_CALLBACK_FAILURE"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_ERR_CALLBACK_FAILURE</span></tt></a>.</p>
|
immediately return <a class="reference internal" href="#NGHTTP2_ERR_CALLBACK_FAILURE" title="NGHTTP2_ERR_CALLBACK_FAILURE"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_ERR_CALLBACK_FAILURE</span></tt></a>.</p>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
@ -1186,6 +1203,15 @@ stream. You should use <a class="reference internal" href="#nghttp2_on_data_recv
|
||||||
know all data frames are received. The <em>user_data</em> pointer is the
|
know all data frames are received. The <em>user_data</em> pointer is the
|
||||||
third argument passed in to the call to
|
third argument passed in to the call to
|
||||||
<a class="reference internal" href="#nghttp2_session_client_new" title="nghttp2_session_client_new"><tt class="xref c c-func docutils literal"><span class="pre">nghttp2_session_client_new()</span></tt></a> or <a class="reference internal" href="#nghttp2_session_server_new" title="nghttp2_session_server_new"><tt class="xref c c-func docutils literal"><span class="pre">nghttp2_session_server_new()</span></tt></a>.</p>
|
<a class="reference internal" href="#nghttp2_session_client_new" title="nghttp2_session_client_new"><tt class="xref c c-func docutils literal"><span class="pre">nghttp2_session_client_new()</span></tt></a> or <a class="reference internal" href="#nghttp2_session_server_new" title="nghttp2_session_server_new"><tt class="xref c c-func docutils literal"><span class="pre">nghttp2_session_server_new()</span></tt></a>.</p>
|
||||||
|
<p>If the application uses <a class="reference internal" href="#nghttp2_session_mem_recv" title="nghttp2_session_mem_recv"><tt class="xref c c-func docutils literal"><span class="pre">nghttp2_session_mem_recv()</span></tt></a>, it can return
|
||||||
|
<a class="reference internal" href="#NGHTTP2_ERR_PAUSE" title="NGHTTP2_ERR_PAUSE"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_ERR_PAUSE</span></tt></a> to make <a class="reference internal" href="#nghttp2_session_mem_recv" title="nghttp2_session_mem_recv"><tt class="xref c c-func docutils literal"><span class="pre">nghttp2_session_mem_recv()</span></tt></a>
|
||||||
|
return without processing further input bytes. The <em>frame</em>
|
||||||
|
parameter is retained until <a class="reference internal" href="#nghttp2_session_continue" title="nghttp2_session_continue"><tt class="xref c c-func docutils literal"><span class="pre">nghttp2_session_continue()</span></tt></a> is
|
||||||
|
called. The application must retain the input bytes which was used
|
||||||
|
to produce the <em>frame</em> parameter, because it may refer to the
|
||||||
|
memory region included in the input bytes. The application which
|
||||||
|
returns <a class="reference internal" href="#NGHTTP2_ERR_PAUSE" title="NGHTTP2_ERR_PAUSE"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_ERR_PAUSE</span></tt></a> must call
|
||||||
|
<a class="reference internal" href="#nghttp2_session_continue" title="nghttp2_session_continue"><tt class="xref c c-func docutils literal"><span class="pre">nghttp2_session_continue()</span></tt></a> before <a class="reference internal" href="#nghttp2_session_mem_recv" title="nghttp2_session_mem_recv"><tt class="xref c c-func docutils literal"><span class="pre">nghttp2_session_mem_recv()</span></tt></a>.</p>
|
||||||
<p>The implementation of this function must return 0 if it
|
<p>The implementation of this function must return 0 if it
|
||||||
succeeds. If nonzero is returned, it is treated as fatal error and
|
succeeds. If nonzero is returned, it is treated as fatal error and
|
||||||
<a class="reference internal" href="#nghttp2_session_recv" title="nghttp2_session_recv"><tt class="xref c c-func docutils literal"><span class="pre">nghttp2_session_recv()</span></tt></a> and <a class="reference internal" href="#nghttp2_session_send" title="nghttp2_session_send"><tt class="xref c c-func docutils literal"><span class="pre">nghttp2_session_send()</span></tt></a> functions
|
<a class="reference internal" href="#nghttp2_session_recv" title="nghttp2_session_recv"><tt class="xref c c-func docutils literal"><span class="pre">nghttp2_session_recv()</span></tt></a> and <a class="reference internal" href="#nghttp2_session_send" title="nghttp2_session_send"><tt class="xref c c-func docutils literal"><span class="pre">nghttp2_session_send()</span></tt></a> functions
|
||||||
|
@ -1651,12 +1677,42 @@ function. If all bytes are processed, this function returns. The
|
||||||
other callbacks are called in the same way as they are in
|
other callbacks are called in the same way as they are in
|
||||||
<a class="reference internal" href="#nghttp2_session_recv" title="nghttp2_session_recv"><tt class="xref c c-func docutils literal"><span class="pre">nghttp2_session_recv()</span></tt></a>.</p>
|
<a class="reference internal" href="#nghttp2_session_recv" title="nghttp2_session_recv"><tt class="xref c c-func docutils literal"><span class="pre">nghttp2_session_recv()</span></tt></a>.</p>
|
||||||
<p>In the current implementation, this function always tries to
|
<p>In the current implementation, this function always tries to
|
||||||
processes all input data unless an error occurs.</p>
|
processes all input data unless either an error occurs or
|
||||||
|
<a class="reference internal" href="#NGHTTP2_ERR_PAUSE" title="NGHTTP2_ERR_PAUSE"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_ERR_PAUSE</span></tt></a> is returned from
|
||||||
|
<a class="reference internal" href="#nghttp2_session_callbacks.on_frame_recv_callback" title="nghttp2_session_callbacks.on_frame_recv_callback"><tt class="xref c c-member docutils literal"><span class="pre">nghttp2_session_callbacks.on_frame_recv_callback</span></tt></a> or
|
||||||
|
<a class="reference internal" href="#nghttp2_session_callbacks.on_data_chunk_recv_callback" title="nghttp2_session_callbacks.on_data_chunk_recv_callback"><tt class="xref c c-member docutils literal"><span class="pre">nghttp2_session_callbacks.on_data_chunk_recv_callback</span></tt></a>.
|
||||||
|
If <a class="reference internal" href="#NGHTTP2_ERR_PAUSE" title="NGHTTP2_ERR_PAUSE"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_ERR_PAUSE</span></tt></a> is used, the return value includes the
|
||||||
|
number of bytes which was used to produce the data or frame for the
|
||||||
|
callback.</p>
|
||||||
<p>This function returns the number of processed bytes, or one of the
|
<p>This function returns the number of processed bytes, or one of the
|
||||||
following negative error codes:</p>
|
following 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_CALLBACK_FAILURE" title="NGHTTP2_ERR_CALLBACK_FAILURE"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_ERR_CALLBACK_FAILURE</span></tt></a></dt>
|
||||||
|
<dd>The callback function failed.</dd>
|
||||||
|
</dl>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
<dl class="function">
|
||||||
|
<dt id="nghttp2_session_continue">
|
||||||
|
int <tt class="descname">nghttp2_session_continue</tt><big>(</big><a class="reference internal" href="#nghttp2_session" title="nghttp2_session">nghttp2_session</a><em> *session</em><big>)</big><a class="headerlink" href="#nghttp2_session_continue" title="Permalink to this definition">¶</a></dt>
|
||||||
|
<dd><p>Perform post-processing after <a class="reference internal" href="#nghttp2_session_mem_recv" title="nghttp2_session_mem_recv"><tt class="xref c c-func docutils literal"><span class="pre">nghttp2_session_mem_recv()</span></tt></a> was
|
||||||
|
paused by <a class="reference internal" href="#NGHTTP2_ERR_PAUSE" title="NGHTTP2_ERR_PAUSE"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_ERR_PAUSE</span></tt></a> from
|
||||||
|
<a class="reference internal" href="#nghttp2_session_callbacks.on_frame_recv_callback" title="nghttp2_session_callbacks.on_frame_recv_callback"><tt class="xref c c-member docutils literal"><span class="pre">nghttp2_session_callbacks.on_frame_recv_callback</span></tt></a> or
|
||||||
|
<a class="reference internal" href="#nghttp2_session_callbacks.on_data_chunk_recv_callback" title="nghttp2_session_callbacks.on_data_chunk_recv_callback"><tt class="xref c c-member docutils literal"><span class="pre">nghttp2_session_callbacks.on_data_chunk_recv_callback</span></tt></a>.</p>
|
||||||
|
<p>This function frees resources associated with paused frames. It
|
||||||
|
may also call additional callbacks, such as
|
||||||
|
<a class="reference internal" href="#nghttp2_session_callbacks.on_stream_close_callback" title="nghttp2_session_callbacks.on_stream_close_callback"><tt class="xref c c-member docutils literal"><span class="pre">nghttp2_session_callbacks.on_stream_close_callback</span></tt></a>.</p>
|
||||||
|
<p>If this function succeeds, the application can call
|
||||||
|
<a class="reference internal" href="#nghttp2_session_mem_recv" title="nghttp2_session_mem_recv"><tt class="xref c c-func docutils literal"><span class="pre">nghttp2_session_mem_recv()</span></tt></a> again.</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_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_CALLBACK_FAILURE" title="NGHTTP2_ERR_CALLBACK_FAILURE"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_ERR_CALLBACK_FAILURE</span></tt></a></dt>
|
||||||
|
<dd>The callback function failed.</dd>
|
||||||
</dl>
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
|
|
|
@ -181,6 +181,10 @@
|
||||||
</dt>
|
</dt>
|
||||||
|
|
||||||
|
|
||||||
|
<dt><a href="apiref.html#NGHTTP2_ERR_PAUSE">NGHTTP2_ERR_PAUSE (C macro)</a>
|
||||||
|
</dt>
|
||||||
|
|
||||||
|
|
||||||
<dt><a href="apiref.html#NGHTTP2_ERR_PROTO">NGHTTP2_ERR_PROTO (C macro)</a>
|
<dt><a href="apiref.html#NGHTTP2_ERR_PROTO">NGHTTP2_ERR_PROTO (C macro)</a>
|
||||||
</dt>
|
</dt>
|
||||||
|
|
||||||
|
@ -719,6 +723,10 @@
|
||||||
</dt>
|
</dt>
|
||||||
|
|
||||||
|
|
||||||
|
<dt><a href="apiref.html#nghttp2_session_continue">nghttp2_session_continue (C function)</a>
|
||||||
|
</dt>
|
||||||
|
|
||||||
|
|
||||||
<dt><a href="apiref.html#nghttp2_session_del">nghttp2_session_del (C function)</a>
|
<dt><a href="apiref.html#nghttp2_session_del">nghttp2_session_del (C function)</a>
|
||||||
</dt>
|
</dt>
|
||||||
|
|
||||||
|
|
|
@ -315,6 +315,10 @@
|
||||||
<span class="cm"> */</span>
|
<span class="cm"> */</span>
|
||||||
<span class="n">NGHTTP2_ERR_INSUFF_BUFSIZE</span> <span class="o">=</span> <span class="o">-</span><span class="mi">525</span><span class="p">,</span>
|
<span class="n">NGHTTP2_ERR_INSUFF_BUFSIZE</span> <span class="o">=</span> <span class="o">-</span><span class="mi">525</span><span class="p">,</span>
|
||||||
<span class="cm">/**</span>
|
<span class="cm">/**</span>
|
||||||
|
<span class="cm"> * Callback was paused by the application</span>
|
||||||
|
<span class="cm"> */</span>
|
||||||
|
<span class="n">NGHTTP2_ERR_PAUSE</span> <span class="o">=</span> <span class="o">-</span><span class="mi">526</span><span class="p">,</span>
|
||||||
|
<span class="cm">/**</span>
|
||||||
<span class="cm"> * The errors < :enum:`NGHTTP2_ERR_FATAL` mean that the library is</span>
|
<span class="cm"> * The errors < :enum:`NGHTTP2_ERR_FATAL` mean that the library is</span>
|
||||||
<span class="cm"> * under unexpected condition and cannot process any further data</span>
|
<span class="cm"> * under unexpected condition and cannot process any further data</span>
|
||||||
<span class="cm"> * reliably (e.g., out of memory).</span>
|
<span class="cm"> * reliably (e.g., out of memory).</span>
|
||||||
|
@ -883,8 +887,19 @@
|
||||||
<span class="cm"> * argument passed in to the call to `nghttp2_session_client_new()` or</span>
|
<span class="cm"> * argument passed in to the call to `nghttp2_session_client_new()` or</span>
|
||||||
<span class="cm"> * `nghttp2_session_server_new()`.</span>
|
<span class="cm"> * `nghttp2_session_server_new()`.</span>
|
||||||
<span class="cm"> *</span>
|
<span class="cm"> *</span>
|
||||||
|
<span class="cm"> * If the application uses `nghttp2_session_mem_recv()`, it can return</span>
|
||||||
|
<span class="cm"> * :enum:`NGHTTP2_ERR_PAUSE` to make `nghttp2_session_mem_recv()`</span>
|
||||||
|
<span class="cm"> * return without processing further input bytes. The |frame|</span>
|
||||||
|
<span class="cm"> * parameter is retained until `nghttp2_session_continue()` is</span>
|
||||||
|
<span class="cm"> * called. The application must retain the input bytes which was used</span>
|
||||||
|
<span class="cm"> * to produce the |frame| parameter, because it may refer to the</span>
|
||||||
|
<span class="cm"> * memory region included in the input bytes. The application which</span>
|
||||||
|
<span class="cm"> * returns :enum:`NGHTTP2_ERR_PAUSE` must call</span>
|
||||||
|
<span class="cm"> * `nghttp2_session_continue()` before `nghttp2_session_mem_recv()`.</span>
|
||||||
|
<span class="cm"> *</span>
|
||||||
<span class="cm"> * The implementation of this function must return 0 if it</span>
|
<span class="cm"> * The implementation of this function must return 0 if it</span>
|
||||||
<span class="cm"> * succeeds. If nonzero is returned, it is treated as fatal error and</span>
|
<span class="cm"> * succeeds. It may return :enum:`NGHTTP2_ERR_PAUSE`. If the other</span>
|
||||||
|
<span class="cm"> * nonzero value is returned, it is treated as fatal error and</span>
|
||||||
<span class="cm"> * `nghttp2_session_recv()` and `nghttp2_session_send()` functions</span>
|
<span class="cm"> * `nghttp2_session_recv()` and `nghttp2_session_send()` functions</span>
|
||||||
<span class="cm"> * immediately return :enum:`NGHTTP2_ERR_CALLBACK_FAILURE`.</span>
|
<span class="cm"> * immediately return :enum:`NGHTTP2_ERR_CALLBACK_FAILURE`.</span>
|
||||||
<span class="cm"> */</span>
|
<span class="cm"> */</span>
|
||||||
|
@ -924,6 +939,16 @@
|
||||||
<span class="cm"> * third argument passed in to the call to</span>
|
<span class="cm"> * third argument passed in to the call to</span>
|
||||||
<span class="cm"> * `nghttp2_session_client_new()` or `nghttp2_session_server_new()`.</span>
|
<span class="cm"> * `nghttp2_session_client_new()` or `nghttp2_session_server_new()`.</span>
|
||||||
<span class="cm"> *</span>
|
<span class="cm"> *</span>
|
||||||
|
<span class="cm"> * If the application uses `nghttp2_session_mem_recv()`, it can return</span>
|
||||||
|
<span class="cm"> * :enum:`NGHTTP2_ERR_PAUSE` to make `nghttp2_session_mem_recv()`</span>
|
||||||
|
<span class="cm"> * return without processing further input bytes. The |frame|</span>
|
||||||
|
<span class="cm"> * parameter is retained until `nghttp2_session_continue()` is</span>
|
||||||
|
<span class="cm"> * called. The application must retain the input bytes which was used</span>
|
||||||
|
<span class="cm"> * to produce the |frame| parameter, because it may refer to the</span>
|
||||||
|
<span class="cm"> * memory region included in the input bytes. The application which</span>
|
||||||
|
<span class="cm"> * returns :enum:`NGHTTP2_ERR_PAUSE` must call</span>
|
||||||
|
<span class="cm"> * `nghttp2_session_continue()` before `nghttp2_session_mem_recv()`.</span>
|
||||||
|
<span class="cm"> *</span>
|
||||||
<span class="cm"> * The implementation of this function must return 0 if it</span>
|
<span class="cm"> * The implementation of this function must return 0 if it</span>
|
||||||
<span class="cm"> * succeeds. If nonzero is returned, it is treated as fatal error and</span>
|
<span class="cm"> * succeeds. If nonzero is returned, it is treated as fatal error and</span>
|
||||||
<span class="cm"> * `nghttp2_session_recv()` and `nghttp2_session_send()` functions</span>
|
<span class="cm"> * `nghttp2_session_recv()` and `nghttp2_session_send()` functions</span>
|
||||||
|
@ -1440,17 +1465,52 @@
|
||||||
<span class="cm"> * `nghttp2_session_recv()`.</span>
|
<span class="cm"> * `nghttp2_session_recv()`.</span>
|
||||||
<span class="cm"> *</span>
|
<span class="cm"> *</span>
|
||||||
<span class="cm"> * In the current implementation, this function always tries to</span>
|
<span class="cm"> * In the current implementation, this function always tries to</span>
|
||||||
<span class="cm"> * processes all input data unless an error occurs.</span>
|
<span class="cm"> * processes all input data unless either an error occurs or</span>
|
||||||
|
<span class="cm"> * :enum:`NGHTTP2_ERR_PAUSE` is returned from</span>
|
||||||
|
<span class="cm"> * :member:`nghttp2_session_callbacks.on_frame_recv_callback` or</span>
|
||||||
|
<span class="cm"> * :member:`nghttp2_session_callbacks.on_data_chunk_recv_callback`.</span>
|
||||||
|
<span class="cm"> * If :enum:`NGHTTP2_ERR_PAUSE` is used, the return value includes the</span>
|
||||||
|
<span class="cm"> * number of bytes which was used to produce the data or frame for the</span>
|
||||||
|
<span class="cm"> * callback.</span>
|
||||||
<span class="cm"> *</span>
|
<span class="cm"> *</span>
|
||||||
<span class="cm"> * This function returns the number of processed bytes, or one of the</span>
|
<span class="cm"> * This function returns the number of processed bytes, or one of the</span>
|
||||||
<span class="cm"> * following negative error codes:</span>
|
<span class="cm"> * following negative error codes:</span>
|
||||||
<span class="cm"> *</span>
|
<span class="cm"> *</span>
|
||||||
<span class="cm"> * :enum:`NGHTTP2_ERR_NOMEM`</span>
|
<span class="cm"> * :enum:`NGHTTP2_ERR_NOMEM`</span>
|
||||||
<span class="cm"> * Out of memory.</span>
|
<span class="cm"> * Out of memory.</span>
|
||||||
|
<span class="cm"> * :enum:`NGHTTP2_ERR_CALLBACK_FAILURE`</span>
|
||||||
|
<span class="cm"> * The callback function failed.</span>
|
||||||
<span class="cm"> */</span>
|
<span class="cm"> */</span>
|
||||||
<span class="kt">ssize_t</span> <span class="nf">nghttp2_session_mem_recv</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">ssize_t</span> <span class="nf">nghttp2_session_mem_recv</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="k">const</span> <span class="kt">uint8_t</span> <span class="o">*</span><span class="n">in</span><span class="p">,</span> <span class="kt">size_t</span> <span class="n">inlen</span><span class="p">);</span>
|
<span class="k">const</span> <span class="kt">uint8_t</span> <span class="o">*</span><span class="n">in</span><span class="p">,</span> <span class="kt">size_t</span> <span class="n">inlen</span><span class="p">);</span>
|
||||||
|
|
||||||
|
<span class="cm">/**</span>
|
||||||
|
<span class="cm"> * @function</span>
|
||||||
|
<span class="cm"> *</span>
|
||||||
|
<span class="cm"> * Perform post-processing after `nghttp2_session_mem_recv()` was</span>
|
||||||
|
<span class="cm"> * paused by :enum:`NGHTTP2_ERR_PAUSE` from</span>
|
||||||
|
<span class="cm"> * :member:`nghttp2_session_callbacks.on_frame_recv_callback` or</span>
|
||||||
|
<span class="cm"> * :member:`nghttp2_session_callbacks.on_data_chunk_recv_callback`.</span>
|
||||||
|
<span class="cm"> *</span>
|
||||||
|
<span class="cm"> * This function frees resources associated with paused frames. It</span>
|
||||||
|
<span class="cm"> * may also call additional callbacks, such as</span>
|
||||||
|
<span class="cm"> * :member:`nghttp2_session_callbacks.on_stream_close_callback`.</span>
|
||||||
|
<span class="cm"> *</span>
|
||||||
|
<span class="cm"> * If this function succeeds, the application can call</span>
|
||||||
|
<span class="cm"> * `nghttp2_session_mem_recv()` again.</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"> *</span>
|
||||||
|
<span class="cm"> * :enum:`NGHTTP2_ERR_NOMEM`</span>
|
||||||
|
<span class="cm"> * Out of memory.</span>
|
||||||
|
<span class="cm"> * :enum:`NGHTTP2_ERR_CALLBACK_FAILURE`</span>
|
||||||
|
<span class="cm"> * The callback function failed.</span>
|
||||||
|
<span class="cm"> *</span>
|
||||||
|
<span class="cm"> */</span>
|
||||||
|
<span class="kt">int</span> <span class="nf">nghttp2_session_continue</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="cm">/**</span>
|
<span class="cm">/**</span>
|
||||||
<span class="cm"> * @function</span>
|
<span class="cm"> * @function</span>
|
||||||
<span class="cm"> *</span>
|
<span class="cm"> *</span>
|
||||||
|
|
BIN
objects.inv
BIN
objects.inv
Binary file not shown.
|
@ -263,7 +263,7 @@ User-Agent: nghttp2/0.1.0-DEV
|
||||||
[ 0.000] 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-draft-06/2.0
|
||||||
|
|
||||||
|
|
||||||
[ 0.000] HTTP Upgrade success
|
[ 0.000] HTTP Upgrade success
|
||||||
|
|
File diff suppressed because one or more lines are too long
Loading…
Reference in New Issue