Skip to content

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

Update doc

parent 1834b7dc
Expand all Hide whitespace changes
Inline Side-by-side
Showing with 31 additions and 31 deletions
_sources/apiref.txt
View file @ c0a7e9fb
......@@ -1188,16 +1188,16 @@ Functions
3. If the control frame cannot be sent because some preconditions
are not met (e.g., request HEADERS cannot be sent after
GOAWAY),
:member:`nghttp2_session_callbacks.on_ctrl_not_send_callback` is
:member:`nghttp2_session_callbacks.on_frame_not_send_callback` is
invoked. Abort the following steps.
4. If the frame is request HEADERS, the stream is opened
here.
5. :member:`nghttp2_session_callbacks.before_ctrl_send_callback` is
5. :member:`nghttp2_session_callbacks.before_frame_send_callback` is
invoked.
6. :member:`nghttp2_session_callbacks.send_callback` is invoked one
or more times to send the frame.
7. If the frame is a control frame,
:member:`nghttp2_session_callbacks.on_ctrl_send_callback` is
:member:`nghttp2_session_callbacks.on_frame_send_callback` is
invoked.
8. If the frame is a DATA frame,
:member:`nghttp2_session_callbacks.on_data_send_callback` is
......@@ -1249,7 +1249,7 @@ Functions
3.1. :member:`nghttp2_session_callbacks.recv_callback` is invoked
one or more times to receive whole frame.
3.2. If the received frame is valid,
:member:`nghttp2_session_callbacks.on_ctrl_recv_callback` is
:member:`nghttp2_session_callbacks.on_frame_recv_callback` is
invoked. If the frame is the final frame of the request,
:member:`nghttp2_session_callbacks.on_request_recv_callback`
is invoked. If the reception of the frame triggers the
......@@ -1258,13 +1258,13 @@ Functions
is invoked.
3.3. If the received frame is unpacked but is interpreted as
invalid,
:member:`nghttp2_session_callbacks.on_invalid_ctrl_recv_callback`
:member:`nghttp2_session_callbacks.on_invalid_frame_recv_callback`
is invoked.
3.4. If the received frame could not be unpacked correctly,
:member:`nghttp2_session_callbacks.on_ctrl_recv_parse_error_callback`
:member:`nghttp2_session_callbacks.on_frame_recv_parse_error_callback`
is invoked.
3.5. If the received frame type is unknown,
:member:`nghttp2_session_callbacks.on_unknown_ctrl_recv_callback`
:member:`nghttp2_session_callbacks.on_unknown_frame_recv_callback`
is invoked.
This function returns 0 if it succeeds, or one of the following
......@@ -1371,10 +1371,10 @@ Functions
Returns stream_user_data for the stream *stream_id*. The
stream_user_data is provided by `nghttp2_submit_request()` or
`nghttp2_submit_syn_stream()`. If the stream is initiated by the
`nghttp2_submit_headers()`. If the stream is initiated by the
remote endpoint, stream_user_data is always ``NULL``. If the stream
is initiated by the local endpoint and ``NULL`` is given in
`nghttp2_submit_request()` or `nghttp2_submit_syn_stream()`, then
`nghttp2_submit_request()` or `nghttp2_submit_headers()`, then
this function returns ``NULL``. If the stream does not exist, this
function returns ``NULL``.
......@@ -1561,7 +1561,7 @@ Functions
stream ID must be strictly increasing, the stream ID of this
request cannot be known until it is about to sent. To know the
stream ID of the request, the application can use
:member:`nghttp2_session_callbacks.before_ctrl_send_callback`. This
:member:`nghttp2_session_callbacks.before_frame_send_callback`. This
callback is called just before the frame is sent. For HEADERS
frame, the argument frame has the stream ID assigned. Also since
the stream is already opened,
......
apiref.html
View file @ c0a7e9fb
......@@ -1657,16 +1657,16 @@ which tells when each callback is invoked:</p>
<li>If the control frame cannot be sent because some preconditions
are not met (e.g., request HEADERS cannot be sent after
GOAWAY),
<tt class="xref c c-member docutils literal"><span class="pre">nghttp2_session_callbacks.on_ctrl_not_send_callback</span></tt> is
<a class="reference internal" href="#nghttp2_session_callbacks.on_frame_not_send_callback" title="nghttp2_session_callbacks.on_frame_not_send_callback"><tt class="xref c c-member docutils literal"><span class="pre">nghttp2_session_callbacks.on_frame_not_send_callback</span></tt></a> is
invoked. Abort the following steps.</li>
<li>If the frame is request HEADERS, the stream is opened
here.</li>
<li><tt class="xref c c-member docutils literal"><span class="pre">nghttp2_session_callbacks.before_ctrl_send_callback</span></tt> is
<li><a class="reference internal" href="#nghttp2_session_callbacks.before_frame_send_callback" title="nghttp2_session_callbacks.before_frame_send_callback"><tt class="xref c c-member docutils literal"><span class="pre">nghttp2_session_callbacks.before_frame_send_callback</span></tt></a> is
invoked.</li>
<li><a class="reference internal" href="#nghttp2_session_callbacks.send_callback" title="nghttp2_session_callbacks.send_callback"><tt class="xref c c-member docutils literal"><span class="pre">nghttp2_session_callbacks.send_callback</span></tt></a> is invoked one
or more times to send the frame.</li>
<li>If the frame is a control frame,
<tt class="xref c c-member docutils literal"><span class="pre">nghttp2_session_callbacks.on_ctrl_send_callback</span></tt> is
<a class="reference internal" href="#nghttp2_session_callbacks.on_frame_send_callback" title="nghttp2_session_callbacks.on_frame_send_callback"><tt class="xref c c-member docutils literal"><span class="pre">nghttp2_session_callbacks.on_frame_send_callback</span></tt></a> is
invoked.</li>
<li>If the frame is a DATA frame,
<a class="reference internal" href="#nghttp2_session_callbacks.on_data_send_callback" title="nghttp2_session_callbacks.on_data_send_callback"><tt class="xref c c-member docutils literal"><span class="pre">nghttp2_session_callbacks.on_data_send_callback</span></tt></a> is
......@@ -1725,7 +1725,7 @@ is invoked.</dd>
<dt>3.1. <a class="reference internal" href="#nghttp2_session_callbacks.recv_callback" title="nghttp2_session_callbacks.recv_callback"><tt class="xref c c-member docutils literal"><span class="pre">nghttp2_session_callbacks.recv_callback</span></tt></a> is invoked</dt>
<dd>one or more times to receive whole frame.</dd>
<dt>3.2. If the received frame is valid,</dt>
<dd><tt class="xref c c-member docutils literal"><span class="pre">nghttp2_session_callbacks.on_ctrl_recv_callback</span></tt> is
<dd><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> is
invoked. If the frame is the final frame of the request,
<a class="reference internal" href="#nghttp2_session_callbacks.on_request_recv_callback" title="nghttp2_session_callbacks.on_request_recv_callback"><tt class="xref c c-member docutils literal"><span class="pre">nghttp2_session_callbacks.on_request_recv_callback</span></tt></a>
is invoked. If the reception of the frame triggers the
......@@ -1734,13 +1734,13 @@ closure of the stream,
is invoked.</dd>
<dt>3.3. If the received frame is unpacked but is interpreted as</dt>
<dd>invalid,
<tt class="xref c c-member docutils literal"><span class="pre">nghttp2_session_callbacks.on_invalid_ctrl_recv_callback</span></tt>
<a class="reference internal" href="#nghttp2_session_callbacks.on_invalid_frame_recv_callback" title="nghttp2_session_callbacks.on_invalid_frame_recv_callback"><tt class="xref c c-member docutils literal"><span class="pre">nghttp2_session_callbacks.on_invalid_frame_recv_callback</span></tt></a>
is invoked.</dd>
<dt>3.4. If the received frame could not be unpacked correctly,</dt>
<dd><tt class="xref c c-member docutils literal"><span class="pre">nghttp2_session_callbacks.on_ctrl_recv_parse_error_callback</span></tt>
<dd><tt class="xref c c-member docutils literal"><span class="pre">nghttp2_session_callbacks.on_frame_recv_parse_error_callback</span></tt>
is invoked.</dd>
<dt>3.5. If the received frame type is unknown,</dt>
<dd><tt class="xref c c-member docutils literal"><span class="pre">nghttp2_session_callbacks.on_unknown_ctrl_recv_callback</span></tt>
<dd><a class="reference internal" href="#nghttp2_session_callbacks.on_unknown_frame_recv_callback" title="nghttp2_session_callbacks.on_unknown_frame_recv_callback"><tt class="xref c c-member docutils literal"><span class="pre">nghttp2_session_callbacks.on_unknown_frame_recv_callback</span></tt></a>
is invoked.</dd>
</dl>
</div></blockquote>
......@@ -1847,10 +1847,10 @@ drop the connection.</p>
void* <tt class="descname">nghttp2_session_get_stream_user_data</tt><big>(</big><a class="reference internal" href="#nghttp2_session" title="nghttp2_session">nghttp2_session</a><em>&nbsp;*session</em>, int32_t<em>&nbsp;stream_id</em><big>)</big><a class="headerlink" href="#nghttp2_session_get_stream_user_data" title="Permalink to this definition"></a></dt>
<dd><p>Returns stream_user_data for the stream <em>stream_id</em>. The
stream_user_data is provided by <a class="reference internal" href="#nghttp2_submit_request" title="nghttp2_submit_request"><tt class="xref c c-func docutils literal"><span class="pre">nghttp2_submit_request()</span></tt></a> or
<tt class="xref c c-func docutils literal"><span class="pre">nghttp2_submit_syn_stream()</span></tt>. If the stream is initiated by the
<a class="reference internal" href="#nghttp2_submit_headers" title="nghttp2_submit_headers"><tt class="xref c c-func docutils literal"><span class="pre">nghttp2_submit_headers()</span></tt></a>. If the stream is initiated by the
remote endpoint, stream_user_data is always <tt class="docutils literal"><span class="pre">NULL</span></tt>. If the stream
is initiated by the local endpoint and <tt class="docutils literal"><span class="pre">NULL</span></tt> is given in
<a class="reference internal" href="#nghttp2_submit_request" title="nghttp2_submit_request"><tt class="xref c c-func docutils literal"><span class="pre">nghttp2_submit_request()</span></tt></a> or <tt class="xref c c-func docutils literal"><span class="pre">nghttp2_submit_syn_stream()</span></tt>, then
<a class="reference internal" href="#nghttp2_submit_request" title="nghttp2_submit_request"><tt class="xref c c-func docutils literal"><span class="pre">nghttp2_submit_request()</span></tt></a> or <a class="reference internal" href="#nghttp2_submit_headers" title="nghttp2_submit_headers"><tt class="xref c c-func docutils literal"><span class="pre">nghttp2_submit_headers()</span></tt></a>, then
this function returns <tt class="docutils literal"><span class="pre">NULL</span></tt>. If the stream does not exist, this
function returns <tt class="docutils literal"><span class="pre">NULL</span></tt>.</p>
</dd></dl>
......@@ -2030,7 +2030,7 @@ prioritized one first and the HTTP/2.0 specification requires the
stream ID must be strictly increasing, the stream ID of this
request cannot be known until it is about to sent. To know the
stream ID of the request, the application can use
<tt class="xref c c-member docutils literal"><span class="pre">nghttp2_session_callbacks.before_ctrl_send_callback</span></tt>. This
<a class="reference internal" href="#nghttp2_session_callbacks.before_frame_send_callback" title="nghttp2_session_callbacks.before_frame_send_callback"><tt class="xref c c-member docutils literal"><span class="pre">nghttp2_session_callbacks.before_frame_send_callback</span></tt></a>. This
callback is called just before the frame is sent. For HEADERS
frame, the argument frame has the stream ID assigned. Also since
the stream is already opened,
......
nghttp2.h.html
View file @ c0a7e9fb
......@@ -1433,16 +1433,16 @@
<span class="cm"> * 3. If the control frame cannot be sent because some preconditions</span>
<span class="cm"> * are not met (e.g., request HEADERS cannot be sent after</span>
<span class="cm"> * GOAWAY),</span>
<span class="cm"> * :member:`nghttp2_session_callbacks.on_ctrl_not_send_callback` is</span>
<span class="cm"> * :member:`nghttp2_session_callbacks.on_frame_not_send_callback` is</span>
<span class="cm"> * invoked. Abort the following steps.</span>
<span class="cm"> * 4. If the frame is request HEADERS, the stream is opened</span>
<span class="cm"> * here.</span>
<span class="cm"> * 5. :member:`nghttp2_session_callbacks.before_ctrl_send_callback` is</span>
<span class="cm"> * 5. :member:`nghttp2_session_callbacks.before_frame_send_callback` is</span>
<span class="cm"> * invoked.</span>
<span class="cm"> * 6. :member:`nghttp2_session_callbacks.send_callback` is invoked one</span>
<span class="cm"> * or more times to send the frame.</span>
<span class="cm"> * 7. If the frame is a control frame,</span>
<span class="cm"> * :member:`nghttp2_session_callbacks.on_ctrl_send_callback` is</span>
<span class="cm"> * :member:`nghttp2_session_callbacks.on_frame_send_callback` is</span>
<span class="cm"> * invoked.</span>
<span class="cm"> * 8. If the frame is a DATA frame,</span>
<span class="cm"> * :member:`nghttp2_session_callbacks.on_data_send_callback` is</span>
......@@ -1496,7 +1496,7 @@
<span class="cm"> * 3.1. :member:`nghttp2_session_callbacks.recv_callback` is invoked</span>
<span class="cm"> * one or more times to receive whole frame.</span>
<span class="cm"> * 3.2. If the received frame is valid,</span>
<span class="cm"> * :member:`nghttp2_session_callbacks.on_ctrl_recv_callback` is</span>
<span class="cm"> * :member:`nghttp2_session_callbacks.on_frame_recv_callback` is</span>
<span class="cm"> * invoked. If the frame is the final frame of the request,</span>
<span class="cm"> * :member:`nghttp2_session_callbacks.on_request_recv_callback`</span>
<span class="cm"> * is invoked. If the reception of the frame triggers the</span>
......@@ -1505,13 +1505,13 @@
<span class="cm"> * is invoked.</span>
<span class="cm"> * 3.3. If the received frame is unpacked but is interpreted as</span>
<span class="cm"> * invalid,</span>
<span class="cm"> * :member:`nghttp2_session_callbacks.on_invalid_ctrl_recv_callback`</span>
<span class="cm"> * :member:`nghttp2_session_callbacks.on_invalid_frame_recv_callback`</span>
<span class="cm"> * is invoked.</span>
<span class="cm"> * 3.4. If the received frame could not be unpacked correctly,</span>
<span class="cm"> * :member:`nghttp2_session_callbacks.on_ctrl_recv_parse_error_callback`</span>
<span class="cm"> * :member:`nghttp2_session_callbacks.on_frame_recv_parse_error_callback`</span>
<span class="cm"> * is invoked.</span>
<span class="cm"> * 3.5. If the received frame type is unknown,</span>
<span class="cm"> * :member:`nghttp2_session_callbacks.on_unknown_ctrl_recv_callback`</span>
<span class="cm"> * :member:`nghttp2_session_callbacks.on_unknown_frame_recv_callback`</span>
<span class="cm"> * is invoked.</span>
<span class="cm"> *</span>
<span class="cm"> * This function returns 0 if it succeeds, or one of the following</span>
......@@ -1631,10 +1631,10 @@
<span class="cm"> *</span>
<span class="cm"> * Returns stream_user_data for the stream |stream_id|. The</span>
<span class="cm"> * stream_user_data is provided by `nghttp2_submit_request()` or</span>
<span class="cm"> * `nghttp2_submit_syn_stream()`. If the stream is initiated by the</span>
<span class="cm"> * `nghttp2_submit_headers()`. If the stream is initiated by the</span>
<span class="cm"> * remote endpoint, stream_user_data is always ``NULL``. If the stream</span>
<span class="cm"> * is initiated by the local endpoint and ``NULL`` is given in</span>
<span class="cm"> * `nghttp2_submit_request()` or `nghttp2_submit_syn_stream()`, then</span>
<span class="cm"> * `nghttp2_submit_request()` or `nghttp2_submit_headers()`, then</span>
<span class="cm"> * this function returns ``NULL``. If the stream does not exist, this</span>
<span class="cm"> * function returns ``NULL``.</span>
<span class="cm"> */</span>
......@@ -1853,7 +1853,7 @@
<span class="cm"> * stream ID must be strictly increasing, the stream ID of this</span>
<span class="cm"> * request cannot be known until it is about to sent. To know the</span>
<span class="cm"> * stream ID of the request, the application can use</span>
<span class="cm"> * :member:`nghttp2_session_callbacks.before_ctrl_send_callback`. This</span>
<span class="cm"> * :member:`nghttp2_session_callbacks.before_frame_send_callback`. This</span>
<span class="cm"> * callback is called just before the frame is sent. For HEADERS</span>
<span class="cm"> * frame, the argument frame has the stream ID assigned. Also since</span>
<span class="cm"> * the stream is already opened,</span>
......
objects.inv
View file @ c0a7e9fb
No preview for this file type
searchindex.js
View file @ c0a7e9fb
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