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-04 18:30:37 +09:00
parent 35a2e8fff7
commit edd7420898
8 changed files with 113 additions and 146 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

115
_sources/apiref.txt
View File

@ -402,10 +402,11 @@ Types (structs, unions and typedefs)
.. member:: uint8_t *name .. member:: uint8_t *name
The *name* byte string, which is not necessarily NULL terminated. The *name* byte string, which is not necessarily ``NULL``
terminated.
.. member:: uint8_t *value .. member:: uint8_t *value
The *value* byte string, which is not necessarily NULL The *value* byte string, which is not necessarily ``NULL``
terminated. terminated.
.. member:: uint16_t namelen .. member:: uint16_t namelen
@ -614,21 +615,6 @@ Types (structs, unions and typedefs)
The window size increment. The window size increment.
.. type:: nghttp2_mem_chunk
The structure to hold chunk of memory.
TODO Drop this if it is not used anymore.
.. member:: uint8_t *data
The pointer to the data.
.. member:: size_t length
The length of the data.
.. type:: nghttp2_frame .. type:: nghttp2_frame
@ -1134,24 +1120,24 @@ Functions
different in each other. different in each other.
If called from client side, the *settings_payload* must be the If called from client side, the *settings_payload* must be the
value sent in HTTP2-Settings header field and must be decoded by value sent in ``HTTP2-Settings`` header field and must be decoded
base64url decoder. The *settings_payloadlen* is the length of by base64url decoder. The *settings_payloadlen* is the length of
*settings_payload*. The *settings_payload* is unpacked and its *settings_payload*. The *settings_payload* is unpacked and its
setting values will be submitted using setting values will be submitted using
nghttp2_submit_settings(). This means that the client application `nghttp2_submit_settings()`. This means that the client application
code does not need to submit SETTINGS by itself. The stream with code does not need to submit SETTINGS by itself. The stream with
stream ID=1 is opened and the *stream_user_data* is used for its stream ID=1 is opened and the *stream_user_data* is used for its
stream_user_data. The opened stream becomes half-closed (local) stream_user_data. The opened stream becomes half-closed (local)
state. state.
If called from server side, the *settings_payload* must be the If called from server side, the *settings_payload* must be the
value received in HTTP2-Settings header field and must be decoded value received in ``HTTP2-Settings`` header field and must be
by base64url decoder. The *settings_payloadlen* is the length of decoded by base64url decoder. The *settings_payloadlen* is the
*settings_payload*. It is treated as if the SETTINGS frame with length of *settings_payload*. It is treated as if the SETTINGS
that payload is received. Thus, callback functions for the frame with that payload is received. Thus, callback functions for
reception of SETTINGS frame will be invoked. The stream with stream the reception of SETTINGS frame will be invoked. The stream with
ID=1 is opened. The *stream_user_data* is ignored. The opened stream ID=1 is opened. The *stream_user_data* is ignored. The
stream becomes half-closed (remote). opened stream becomes half-closed (remote).
This function returns 0 if it succeeds, or one of the following This function returns 0 if it succeeds, or one of the following
negative error codes: negative error codes:
@ -1163,8 +1149,8 @@ Functions
:macro:`NGHTTP2_ERR_PROTO` :macro:`NGHTTP2_ERR_PROTO`
The stream ID 1 is already used or closed; or is not available; The stream ID 1 is already used or closed; or is not available;
or the *settings_payload* does not include both or the *settings_payload* does not include both
NGHTTP2_SETTINGS_MAX_CONCURRENT_STREAMS and :macro:`NGHTTP2_SETTINGS_MAX_CONCURRENT_STREAMS` and
NGHTTP2_SETTINGS_INITIAL_WINDOW_SIZE. :macro:`NGHTTP2_SETTINGS_INITIAL_WINDOW_SIZE`.
.. function:: ssize_t nghttp2_pack_settings_payload(uint8_t *buf, nghttp2_settings_entry *iv, size_t niv) .. function:: ssize_t nghttp2_pack_settings_payload(uint8_t *buf, nghttp2_settings_entry *iv, size_t niv)
@ -1173,10 +1159,10 @@ Functions
entry pointed by *iv* array is given by the *niv*. This function entry pointed by *iv* array is given by the *niv*. This function
may reorder the pointers in *iv*. The *buf* must have enough region may reorder the pointers in *iv*. The *buf* must have enough region
to hold serialized data. The required space for the *niv* entries to hold serialized data. The required space for the *niv* entries
are 8**niv* bytes. This function is used mainly for creating are ``8*niv`` bytes. This function is used mainly for creating
SETTINGS payload to be sent with HTTP2-Settings header field in SETTINGS payload to be sent with ``HTTP2-Settings`` header field in
HTTP Upgrade request. The data written in *buf* is not still HTTP Upgrade request. The data written in *buf* is not still
base64url encoded and the application is responsible to do that. base64url encoded and the application is responsible for encoding.
This function returns the number of bytes written in *buf*, or one This function returns the number of bytes written in *buf*, or one
of the following negative error codes: of the following negative error codes:
@ -1196,8 +1182,7 @@ Functions
Submits HEADERS frame and optionally one or more DATA frames. Submits HEADERS frame and optionally one or more DATA frames.
The *pri* is priority of this request. 0 is the highest priority The *pri* is priority of this request. 0 is the highest priority
value. Use `nghttp2_session_get_pri_lowest()` to know the lowest value and :macro:`NGHTTP2_PRI_LOWEST` is the lowest value.
priority value for this *session*.
The *nv* contains the name/value pairs. For i >= 0, ``nv[2*i]`` The *nv* contains the name/value pairs. For i >= 0, ``nv[2*i]``
contains a pointer to the name string and ``nv[2*i+1]`` contains a contains a pointer to the name string and ``nv[2*i+1]`` contains a
@ -1250,8 +1235,8 @@ Functions
negative error codes: negative error codes:
:macro:`NGHTTP2_ERR_INVALID_ARGUMENT` :macro:`NGHTTP2_ERR_INVALID_ARGUMENT`
The *pri* is invalid; or the *nv* includes empty name or NULL The *pri* is invalid; or the *nv* includes empty name or
value. ``NULL`` value.
:macro:`NGHTTP2_ERR_NOMEM` :macro:`NGHTTP2_ERR_NOMEM`
Out of memory. Out of memory.
@ -1285,7 +1270,7 @@ Functions
negative error codes: negative error codes:
:macro:`NGHTTP2_ERR_INVALID_ARGUMENT` :macro:`NGHTTP2_ERR_INVALID_ARGUMENT`
The *nv* includes empty name or NULL value. The *nv* includes empty name or ``NULL`` value.
:macro:`NGHTTP2_ERR_NOMEM` :macro:`NGHTTP2_ERR_NOMEM`
Out of memory. Out of memory.
@ -1296,13 +1281,17 @@ Functions
following values: following values:
* :macro:`NGHTTP2_FLAG_END_STREAM` * :macro:`NGHTTP2_FLAG_END_STREAM`
* :macro:`NGHTTP2_FLAG_END_HEADERS`
* :macro:`NGHTTP2_FLAG_PRIORITY` * :macro:`NGHTTP2_FLAG_PRIORITY`
If *flags* includes :macro:`NGHTTP2_FLAG_END_STREAM`, this frame has If *flags* includes :macro:`NGHTTP2_FLAG_END_STREAM`, this frame has
END_STREAM flag set. END_STREAM flag set. The library does not support header
continuation and the HEADERS frame always has
:macro:`NGHTTP2_FLAG_END_HEADERS` flag set regardless of the *flags*
value.
If the *stream_id* is -1, this frame is assumed as request (i.e., If the *stream_id* is -1, this frame is assumed as request (i.e.,
first HEADERS frame which opens new stream). In this case, the request HEADERS frame which opens new stream). In this case, the
actual stream ID is assigned just before the frame is sent. For actual stream ID is assigned just before the frame is sent. For
response, specify stream ID in *stream_id*. response, specify stream ID in *stream_id*.
@ -1323,15 +1312,15 @@ Functions
state from idle or reserved to open. state from idle or reserved to open.
This function is low-level in a sense that the application code can This function is low-level in a sense that the application code can
specify flags and the Associated-To-Stream-ID directly. For usual specify flags directly. For usual HTTP request,
HTTP request, `nghttp2_submit_request()` is useful. `nghttp2_submit_request()` is useful.
This function returns 0 if it succeeds, or one of the following This function returns 0 if it succeeds, or one of the following
negative error codes: negative error codes:
:macro:`NGHTTP2_ERR_INVALID_ARGUMENT` :macro:`NGHTTP2_ERR_INVALID_ARGUMENT`
The *pri* is invalid; or the *assoc_stream_id* is invalid; or The *pri* is invalid; or the *nv* includes empty name or
the *nv* includes empty name or NULL value. ``NULL`` value.
:macro:`NGHTTP2_ERR_NOMEM` :macro:`NGHTTP2_ERR_NOMEM`
Out of memory. Out of memory.
@ -1383,9 +1372,7 @@ Functions
Stores local settings and submits SETTINGS frame. The *iv* is the Stores local settings and submits SETTINGS frame. The *iv* is the
pointer to the array of :type:`nghttp2_settings_entry`. The *niv* pointer to the array of :type:`nghttp2_settings_entry`. The *niv*
indicates the number of :type:`nghttp2_settings_entry`. The *flags* indicates the number of :type:`nghttp2_settings_entry`.
is bitwise-OR of one or more values from
:type:`nghttp2_settings_flag`.
This function does not take ownership of the *iv*. This function This function does not take ownership of the *iv*. This function
copies all the elements in the *iv*. copies all the elements in the *iv*.
@ -1401,7 +1388,10 @@ Functions
.. function:: int nghttp2_submit_push_promise(nghttp2_session *session, uint8_t flags, int32_t stream_id, const char **nv) .. function:: int nghttp2_submit_push_promise(nghttp2_session *session, uint8_t flags, int32_t stream_id, const char **nv)
Submits PUSH_PROMISE frame. The *flags* is currently ignored. Submits PUSH_PROMISE frame. The *flags* is currently ignored and
the resulting PUSH_PROMISE frame always has
:macro:`NGHTTP2_FLAG_END_PUSH_PROMISE` flag set due to the lack of
header continuation support in the library.
The *stream_id* must be client initiated stream ID. The *stream_id* must be client initiated stream ID.
@ -1419,7 +1409,7 @@ Functions
stream ID must be strictly increasing, the promised stream ID stream ID must be strictly increasing, the promised stream ID
cannot be known until it is about to sent. To know the promised cannot be known until it is about to sent. To know the promised
stream ID, the application can use stream ID, 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 PUSH_PROMISE callback is called just before the frame is sent. For PUSH_PROMISE
frame, the argument frame has the promised stream ID assigned. frame, the argument frame has the promised stream ID assigned.
@ -1427,7 +1417,7 @@ Functions
negative error codes: negative error codes:
:macro:`NGHTTP2_ERR_INVALID_ARGUMENT` :macro:`NGHTTP2_ERR_INVALID_ARGUMENT`
The *nv* includes empty name or NULL value. The *nv* includes empty name or ``NULL`` value.
:macro:`NGHTTP2_ERR_NOMEM` :macro:`NGHTTP2_ERR_NOMEM`
Out of memory. Out of memory.
@ -1438,10 +1428,10 @@ Functions
received PING frame. The library automatically submits PING frame received PING frame. The library automatically submits PING frame
in this case. in this case.
If the *opaque_data* is non NULL, then it should point to the 8 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 bytes array of memory to specify opaque data to send with PING
frame. If the *opaque_data* is NULL, 8 zero bytes will be sent as frame. If the *opaque_data* is ``NULL``, zero-cleared 8 bytes will
opaque data. be sent as opaque data.
This function returns 0 if it succeeds, or one of the following This function returns 0 if it succeeds, or one of the following
negative error codes: negative error codes:
@ -1454,12 +1444,12 @@ Functions
Submits GOAWAY frame with the error code *error_code*. Submits GOAWAY frame with the error code *error_code*.
If the *opaque_data* is not NULL and opaque_data_len is not zero, If the *opaque_data* is not ``NULL`` and *opaque_data_len* is not
those data will be sent as additional debug data. The library zero, those data will be sent as additional debug data. The
makes a copy of the memory region pointed by *opaque_data* with the library makes a copy of the memory region pointed by *opaque_data*
length *opaque_data_len*, so the caller does not need to keep this with the length *opaque_data_len*, so the caller does not need to
memory after the return of this function. If the *opaque_data_len* keep this memory after the return of this function. If the
is 0, the *opaque_data* could be NULL. *opaque_data_len* is 0, the *opaque_data* could be ``NULL``.
This function returns 0 if it succeeds, or one of the following This function returns 0 if it succeeds, or one of the following
negative error codes: negative error codes:
@ -1473,8 +1463,8 @@ Functions
Submits WINDOW_UPDATE frame. The effective range of the Submits WINDOW_UPDATE frame. The effective range of the
*window_size_increment* is [1, (1 << 31)-1], inclusive. But the *window_size_increment* is [1, (1 << 31)-1], inclusive. But the
application must be responsible to keep the resulting window size application must be responsible to keep the resulting window size
<= (1 << 31)-1. If NGHTTP2_FLAG_END_FLOW_CONTROL bit set in the <= (1 << 31)-1. If :macro:`NGHTTP2_FLAG_END_FLOW_CONTROL` bit set in
*flags*, 0 can be specified in the *window_size_increment*. In the *flags*, 0 can be specified in the *window_size_increment*. In
fact, if this flag is set, the value specified in the fact, if this flag is set, the value specified in the
*window_size_increment* is ignored. *window_size_increment* is ignored.
@ -1482,8 +1472,9 @@ Functions
negative error codes: negative error codes:
:macro:`NGHTTP2_ERR_INVALID_ARGUMENT` :macro:`NGHTTP2_ERR_INVALID_ARGUMENT`
The *delta_window_size* is 0 or negative if The *delta_window_size* is 0 or negative and
NGHTTP2_FLAG_END_FLOW_CONTROL bit is not set in *flags*. :macro:`NGHTTP2_FLAG_END_FLOW_CONTROL` bit is not set in
*flags*.
:macro:`NGHTTP2_ERR_STREAM_CLOSED` :macro:`NGHTTP2_ERR_STREAM_CLOSED`
The stream is already closed or does not exist. The stream is already closed or does not exist.
:macro:`NGHTTP2_ERR_NOMEM` :macro:`NGHTTP2_ERR_NOMEM`

1
_sources/index.txt
View File

@ -21,3 +21,4 @@ Resources
--------- ---------
* http://tools.ietf.org/html/draft-ietf-httpbis-http2-04 * http://tools.ietf.org/html/draft-ietf-httpbis-http2-04
* http://tools.ietf.org/html/draft-ietf-httpbis-header-compression-01

119
apiref.html
View File

@ -634,13 +634,14 @@ from the public API.</p>
<dl class="member"> <dl class="member">
<dt id="nghttp2_nv.name"> <dt id="nghttp2_nv.name">
uint8_t *<tt class="descname">name</tt><a class="headerlink" href="#nghttp2_nv.name" title="Permalink to this definition"></a></dt> uint8_t *<tt class="descname">name</tt><a class="headerlink" href="#nghttp2_nv.name" title="Permalink to this definition"></a></dt>
<dd><p>The <em>name</em> byte string, which is not necessarily NULL terminated.</p> <dd><p>The <em>name</em> byte string, which is not necessarily <tt class="docutils literal"><span class="pre">NULL</span></tt>
terminated.</p>
</dd></dl> </dd></dl>
<dl class="member"> <dl class="member">
<dt id="nghttp2_nv.value"> <dt id="nghttp2_nv.value">
uint8_t *<tt class="descname">value</tt><a class="headerlink" href="#nghttp2_nv.value" title="Permalink to this definition"></a></dt> uint8_t *<tt class="descname">value</tt><a class="headerlink" href="#nghttp2_nv.value" title="Permalink to this definition"></a></dt>
<dd><p>The <em>value</em> byte string, which is not necessarily NULL <dd><p>The <em>value</em> byte string, which is not necessarily <tt class="docutils literal"><span class="pre">NULL</span></tt>
terminated.</p> terminated.</p>
</dd></dl> </dd></dl>
@ -957,25 +958,6 @@ int32_t <tt class="descname">window_size_increment</tt><a class="headerlink" hre
</dd></dl> </dd></dl>
<dl class="type">
<dt id="nghttp2_mem_chunk">
<tt class="descname">nghttp2_mem_chunk</tt><a class="headerlink" href="#nghttp2_mem_chunk" title="Permalink to this definition"></a></dt>
<dd><p>The structure to hold chunk of memory.</p>
<p>TODO Drop this if it is not used anymore.</p>
<dl class="member">
<dt id="nghttp2_mem_chunk.data">
uint8_t *<tt class="descname">data</tt><a class="headerlink" href="#nghttp2_mem_chunk.data" title="Permalink to this definition"></a></dt>
<dd><p>The pointer to the data.</p>
</dd></dl>
<dl class="member">
<dt id="nghttp2_mem_chunk.length">
size_t <tt class="descname">length</tt><a class="headerlink" href="#nghttp2_mem_chunk.length" title="Permalink to this definition"></a></dt>
<dd><p>The length of the data.</p>
</dd></dl>
</dd></dl>
<dl class="type"> <dl class="type">
<dt id="nghttp2_frame"> <dt id="nghttp2_frame">
<tt class="descname">nghttp2_frame</tt><a class="headerlink" href="#nghttp2_frame" title="Permalink to this definition"></a></dt> <tt class="descname">nghttp2_frame</tt><a class="headerlink" href="#nghttp2_frame" title="Permalink to this definition"></a></dt>
@ -1573,23 +1555,23 @@ int <tt class="descname">nghttp2_session_upgrade</tt><big>(</big><a class="refer
called from both client and server, but the behavior is very called from both client and server, but the behavior is very
different in each other.</p> different in each other.</p>
<p>If called from client side, the <em>settings_payload</em> must be the <p>If called from client side, the <em>settings_payload</em> must be the
value sent in HTTP2-Settings header field and must be decoded by value sent in <tt class="docutils literal"><span class="pre">HTTP2-Settings</span></tt> header field and must be decoded
base64url decoder. The <em>settings_payloadlen</em> is the length of by base64url decoder. The <em>settings_payloadlen</em> is the length of
<em>settings_payload</em>. The <em>settings_payload</em> is unpacked and its <em>settings_payload</em>. The <em>settings_payload</em> is unpacked and its
setting values will be submitted using setting values will be submitted using
nghttp2_submit_settings(). This means that the client application <a class="reference internal" href="#nghttp2_submit_settings" title="nghttp2_submit_settings"><tt class="xref c c-func docutils literal"><span class="pre">nghttp2_submit_settings()</span></tt></a>. This means that the client application
code does not need to submit SETTINGS by itself. The stream with code does not need to submit SETTINGS by itself. The stream with
stream ID=1 is opened and the <em>stream_user_data</em> is used for its stream ID=1 is opened and the <em>stream_user_data</em> is used for its
stream_user_data. The opened stream becomes half-closed (local) stream_user_data. The opened stream becomes half-closed (local)
state.</p> state.</p>
<p>If called from server side, the <em>settings_payload</em> must be the <p>If called from server side, the <em>settings_payload</em> must be the
value received in HTTP2-Settings header field and must be decoded value received in <tt class="docutils literal"><span class="pre">HTTP2-Settings</span></tt> header field and must be
by base64url decoder. The <em>settings_payloadlen</em> is the length of decoded by base64url decoder. The <em>settings_payloadlen</em> is the
<em>settings_payload</em>. It is treated as if the SETTINGS frame with length of <em>settings_payload</em>. It is treated as if the SETTINGS
that payload is received. Thus, callback functions for the frame with that payload is received. Thus, callback functions for
reception of SETTINGS frame will be invoked. The stream with stream the reception of SETTINGS frame will be invoked. The stream with
ID=1 is opened. The <em>stream_user_data</em> is ignored. The opened stream ID=1 is opened. The <em>stream_user_data</em> is ignored. The
stream becomes half-closed (remote).</p> opened stream becomes half-closed (remote).</p>
<p>This function returns 0 if it succeeds, or one of the following <p>This function returns 0 if it succeeds, or one of the following
negative error codes:</p> negative error codes:</p>
<dl class="docutils"> <dl class="docutils">
@ -1600,8 +1582,8 @@ negative error codes:</p>
<dt><a class="reference internal" href="#NGHTTP2_ERR_PROTO" title="NGHTTP2_ERR_PROTO"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_ERR_PROTO</span></tt></a></dt> <dt><a class="reference internal" href="#NGHTTP2_ERR_PROTO" title="NGHTTP2_ERR_PROTO"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_ERR_PROTO</span></tt></a></dt>
<dd>The stream ID 1 is already used or closed; or is not available; <dd>The stream ID 1 is already used or closed; or is not available;
or the <em>settings_payload</em> does not include both or the <em>settings_payload</em> does not include both
NGHTTP2_SETTINGS_MAX_CONCURRENT_STREAMS and <a class="reference internal" href="#NGHTTP2_SETTINGS_MAX_CONCURRENT_STREAMS" title="NGHTTP2_SETTINGS_MAX_CONCURRENT_STREAMS"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_SETTINGS_MAX_CONCURRENT_STREAMS</span></tt></a> and
NGHTTP2_SETTINGS_INITIAL_WINDOW_SIZE.</dd> <a class="reference internal" href="#NGHTTP2_SETTINGS_INITIAL_WINDOW_SIZE" title="NGHTTP2_SETTINGS_INITIAL_WINDOW_SIZE"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_SETTINGS_INITIAL_WINDOW_SIZE</span></tt></a>.</dd>
</dl> </dl>
</dd></dl> </dd></dl>
@ -1612,10 +1594,10 @@ ssize_t <tt class="descname">nghttp2_pack_settings_payload</tt><big>(</big>uint8
entry pointed by <em>iv</em> array is given by the <em>niv</em>. This function entry pointed by <em>iv</em> array is given by the <em>niv</em>. This function
may reorder the pointers in <em>iv</em>. The <em>buf</em> must have enough region may reorder the pointers in <em>iv</em>. The <em>buf</em> must have enough region
to hold serialized data. The required space for the <em>niv</em> entries to hold serialized data. The required space for the <em>niv</em> entries
are 8**niv* bytes. This function is used mainly for creating are <tt class="docutils literal"><span class="pre">8*niv</span></tt> bytes. This function is used mainly for creating
SETTINGS payload to be sent with HTTP2-Settings header field in SETTINGS payload to be sent with <tt class="docutils literal"><span class="pre">HTTP2-Settings</span></tt> header field in
HTTP Upgrade request. The data written in <em>buf</em> is not still HTTP Upgrade request. The data written in <em>buf</em> is not still
base64url encoded and the application is responsible to do that.</p> base64url encoded and the application is responsible for encoding.</p>
<p>This function returns the number of bytes written in <em>buf</em>, or one <p>This function returns the number of bytes written in <em>buf</em>, or one
of the following negative error codes:</p> of the following negative error codes:</p>
<dl class="docutils"> <dl class="docutils">
@ -1636,8 +1618,7 @@ const char* <tt class="descname">nghttp2_strerror</tt><big>(</big>int<em>&nbsp;l
int <tt class="descname">nghttp2_submit_request</tt><big>(</big><a class="reference internal" href="#nghttp2_session" title="nghttp2_session">nghttp2_session</a><em>&nbsp;*session</em>, int32_t<em>&nbsp;pri</em>, const char<em>&nbsp;**nv</em>, const <a class="reference internal" href="#nghttp2_data_provider" title="nghttp2_data_provider">nghttp2_data_provider</a><em>&nbsp;*data_prd</em>, void<em>&nbsp;*stream_user_data</em><big>)</big><a class="headerlink" href="#nghttp2_submit_request" title="Permalink to this definition"></a></dt> int <tt class="descname">nghttp2_submit_request</tt><big>(</big><a class="reference internal" href="#nghttp2_session" title="nghttp2_session">nghttp2_session</a><em>&nbsp;*session</em>, int32_t<em>&nbsp;pri</em>, const char<em>&nbsp;**nv</em>, const <a class="reference internal" href="#nghttp2_data_provider" title="nghttp2_data_provider">nghttp2_data_provider</a><em>&nbsp;*data_prd</em>, void<em>&nbsp;*stream_user_data</em><big>)</big><a class="headerlink" href="#nghttp2_submit_request" title="Permalink to this definition"></a></dt>
<dd><p>Submits HEADERS frame and optionally one or more DATA frames.</p> <dd><p>Submits HEADERS frame and optionally one or more DATA frames.</p>
<p>The <em>pri</em> is priority of this request. 0 is the highest priority <p>The <em>pri</em> is priority of this request. 0 is the highest priority
value. Use <tt class="xref c c-func docutils literal"><span class="pre">nghttp2_session_get_pri_lowest()</span></tt> to know the lowest value and <a class="reference internal" href="#NGHTTP2_PRI_LOWEST" title="NGHTTP2_PRI_LOWEST"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_PRI_LOWEST</span></tt></a> is the lowest value.</p>
priority value for this <em>session</em>.</p>
<p>The <em>nv</em> contains the name/value pairs. For i &gt;= 0, <tt class="docutils literal"><span class="pre">nv[2*i]</span></tt> <p>The <em>nv</em> contains the name/value pairs. For i &gt;= 0, <tt class="docutils literal"><span class="pre">nv[2*i]</span></tt>
contains a pointer to the name string and <tt class="docutils literal"><span class="pre">nv[2*i+1]</span></tt> contains a contains a pointer to the name string and <tt class="docutils literal"><span class="pre">nv[2*i+1]</span></tt> contains a
pointer to the value string. The one beyond last value must be pointer to the value string. The one beyond last value must be
@ -1685,8 +1666,8 @@ the stream is already opened,
negative error codes:</p> negative error codes:</p>
<dl class="docutils"> <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> <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>pri</em> is invalid; or the <em>nv</em> includes empty name or NULL <dd>The <em>pri</em> is invalid; or the <em>nv</em> includes empty name or
value.</dd> <tt class="docutils literal"><span class="pre">NULL</span></tt> value.</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> <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>
</dl> </dl>
@ -1718,7 +1699,7 @@ END_STREAM flag set.</p>
negative error codes:</p> negative error codes:</p>
<dl class="docutils"> <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> <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>nv</em> includes empty name or NULL value.</dd> <dd>The <em>nv</em> includes empty name or <tt class="docutils literal"><span class="pre">NULL</span></tt> value.</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> <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>
</dl> </dl>
@ -1731,12 +1712,16 @@ int <tt class="descname">nghttp2_submit_headers</tt><big>(</big><a class="refere
following values:</p> following values:</p>
<ul class="simple"> <ul class="simple">
<li><a class="reference internal" href="#NGHTTP2_FLAG_END_STREAM" title="NGHTTP2_FLAG_END_STREAM"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_FLAG_END_STREAM</span></tt></a></li> <li><a class="reference internal" href="#NGHTTP2_FLAG_END_STREAM" title="NGHTTP2_FLAG_END_STREAM"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_FLAG_END_STREAM</span></tt></a></li>
<li><a class="reference internal" href="#NGHTTP2_FLAG_END_HEADERS" title="NGHTTP2_FLAG_END_HEADERS"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_FLAG_END_HEADERS</span></tt></a></li>
<li><a class="reference internal" href="#NGHTTP2_FLAG_PRIORITY" title="NGHTTP2_FLAG_PRIORITY"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_FLAG_PRIORITY</span></tt></a></li> <li><a class="reference internal" href="#NGHTTP2_FLAG_PRIORITY" title="NGHTTP2_FLAG_PRIORITY"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_FLAG_PRIORITY</span></tt></a></li>
</ul> </ul>
<p>If <em>flags</em> includes <a class="reference internal" href="#NGHTTP2_FLAG_END_STREAM" title="NGHTTP2_FLAG_END_STREAM"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_FLAG_END_STREAM</span></tt></a>, this frame has <p>If <em>flags</em> includes <a class="reference internal" href="#NGHTTP2_FLAG_END_STREAM" title="NGHTTP2_FLAG_END_STREAM"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_FLAG_END_STREAM</span></tt></a>, this frame has
END_STREAM flag set.</p> END_STREAM flag set. The library does not support header
continuation and the HEADERS frame always has
<a class="reference internal" href="#NGHTTP2_FLAG_END_HEADERS" title="NGHTTP2_FLAG_END_HEADERS"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_FLAG_END_HEADERS</span></tt></a> flag set regardless of the <em>flags</em>
value.</p>
<p>If the <em>stream_id</em> is -1, this frame is assumed as request (i.e., <p>If the <em>stream_id</em> is -1, this frame is assumed as request (i.e.,
first HEADERS frame which opens new stream). In this case, the request HEADERS frame which opens new stream). In this case, the
actual stream ID is assigned just before the frame is sent. For actual stream ID is assigned just before the frame is sent. For
response, specify stream ID in <em>stream_id</em>.</p> response, specify stream ID in <em>stream_id</em>.</p>
<p>The <em>pri</em> is priority of this request.</p> <p>The <em>pri</em> is priority of this request.</p>
@ -1752,14 +1737,14 @@ associated to the stream this frame will open. Therefore it is only
used if this frame opens streams, in other words, it changes stream used if this frame opens streams, in other words, it changes stream
state from idle or reserved to open.</p> state from idle or reserved to open.</p>
<p>This function is low-level in a sense that the application code can <p>This function is low-level in a sense that the application code can
specify flags and the Associated-To-Stream-ID directly. For usual specify flags directly. For usual HTTP request,
HTTP request, <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> is useful.</p> <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> is useful.</p>
<p>This function returns 0 if it succeeds, or one of the following <p>This function returns 0 if it succeeds, or one of the following
negative error codes:</p> negative error codes:</p>
<dl class="docutils"> <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> <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>pri</em> is invalid; or the <em>assoc_stream_id</em> is invalid; or <dd>The <em>pri</em> is invalid; or the <em>nv</em> includes empty name or
the <em>nv</em> includes empty name or NULL value.</dd> <tt class="docutils literal"><span class="pre">NULL</span></tt> value.</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> <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>
</dl> </dl>
@ -1815,9 +1800,7 @@ negative error codes:</p>
int <tt class="descname">nghttp2_submit_settings</tt><big>(</big><a class="reference internal" href="#nghttp2_session" title="nghttp2_session">nghttp2_session</a><em>&nbsp;*session</em>, const <a class="reference internal" href="#nghttp2_settings_entry" title="nghttp2_settings_entry">nghttp2_settings_entry</a><em>&nbsp;*iv</em>, size_t<em>&nbsp;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>&nbsp;*session</em>, const <a class="reference internal" href="#nghttp2_settings_entry" title="nghttp2_settings_entry">nghttp2_settings_entry</a><em>&nbsp;*iv</em>, size_t<em>&nbsp;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 <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> 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>. The <em>flags</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>
is bitwise-OR of one or more values from
<tt class="xref c c-type docutils literal"><span class="pre">nghttp2_settings_flag</span></tt>.</p>
<p>This function does not take ownership of the <em>iv</em>. This function <p>This function does not take ownership of the <em>iv</em>. This function
copies all the elements in the <em>iv</em>.</p> copies all the elements in the <em>iv</em>.</p>
<p>This function returns 0 if it succeeds, or one of the following <p>This function returns 0 if it succeeds, or one of the following
@ -1833,7 +1816,10 @@ negative error codes:</p>
<dl class="function"> <dl class="function">
<dt id="nghttp2_submit_push_promise"> <dt id="nghttp2_submit_push_promise">
int <tt class="descname">nghttp2_submit_push_promise</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>, const char<em>&nbsp;**nv</em><big>)</big><a class="headerlink" href="#nghttp2_submit_push_promise" title="Permalink to this definition"></a></dt> int <tt class="descname">nghttp2_submit_push_promise</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>, const char<em>&nbsp;**nv</em><big>)</big><a class="headerlink" href="#nghttp2_submit_push_promise" title="Permalink to this definition"></a></dt>
<dd><p>Submits PUSH_PROMISE frame. The <em>flags</em> is currently ignored.</p> <dd><p>Submits PUSH_PROMISE frame. The <em>flags</em> is currently ignored and
the resulting PUSH_PROMISE frame always has
<a class="reference internal" href="#NGHTTP2_FLAG_END_PUSH_PROMISE" title="NGHTTP2_FLAG_END_PUSH_PROMISE"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_FLAG_END_PUSH_PROMISE</span></tt></a> flag set due to the lack of
header continuation support in the library.</p>
<p>The <em>stream_id</em> must be client initiated stream ID.</p> <p>The <em>stream_id</em> must be client initiated stream ID.</p>
<p>The <em>nv</em> contains the name/value pairs. For i &gt;= 0, <tt class="docutils literal"><span class="pre">nv[2*i]</span></tt> <p>The <em>nv</em> contains the name/value pairs. For i &gt;= 0, <tt class="docutils literal"><span class="pre">nv[2*i]</span></tt>
contains a pointer to the name string and <tt class="docutils literal"><span class="pre">nv[2*i+1]</span></tt> contains a contains a pointer to the name string and <tt class="docutils literal"><span class="pre">nv[2*i+1]</span></tt> contains a
@ -1847,14 +1833,14 @@ prioritized one first and the HTTP/2.0 specification requires the
stream ID must be strictly increasing, the promised stream ID stream ID must be strictly increasing, the promised stream ID
cannot be known until it is about to sent. To know the promised cannot be known until it is about to sent. To know the promised
stream ID, the application can use stream ID, 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 PUSH_PROMISE callback is called just before the frame is sent. For PUSH_PROMISE
frame, the argument frame has the promised stream ID assigned.</p> frame, the argument frame has the promised stream ID assigned.</p>
<p>This function returns 0 if it succeeds, or one of the following <p>This function returns 0 if it succeeds, or one of the following
negative error codes:</p> negative error codes:</p>
<dl class="docutils"> <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> <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>nv</em> includes empty name or NULL value.</dd> <dd>The <em>nv</em> includes empty name or <tt class="docutils literal"><span class="pre">NULL</span></tt> value.</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> <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>
</dl> </dl>
@ -1866,10 +1852,10 @@ int <tt class="descname">nghttp2_submit_ping</tt><big>(</big><a class="reference
<dd><p>Submits PING frame. You don&#8217;t have to send PING back when you <dd><p>Submits PING frame. You don&#8217;t have to send PING back when you
received PING frame. The library automatically submits PING frame received PING frame. The library automatically submits PING frame
in this case.</p> in this case.</p>
<p>If the <em>opaque_data</em> is non NULL, then it should point to the 8 <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 bytes array of memory to specify opaque data to send with PING
frame. If the <em>opaque_data</em> is NULL, 8 zero bytes will be sent as frame. If the <em>opaque_data</em> is <tt class="docutils literal"><span class="pre">NULL</span></tt>, zero-cleared 8 bytes will
opaque data.</p> be sent as opaque data.</p>
<p>This function returns 0 if it succeeds, or one of the following <p>This function returns 0 if it succeeds, or one of the following
negative error codes:</p> negative error codes:</p>
<dl class="docutils"> <dl class="docutils">
@ -1882,12 +1868,12 @@ negative error codes:</p>
<dt id="nghttp2_submit_goaway"> <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>&nbsp;*session</em>, <a class="reference internal" href="#nghttp2_error_code" title="nghttp2_error_code">nghttp2_error_code</a><em>&nbsp;error_code</em>, uint8_t<em>&nbsp;*opaque_data</em>, size_t<em>&nbsp;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>&nbsp;*session</em>, <a class="reference internal" href="#nghttp2_error_code" title="nghttp2_error_code">nghttp2_error_code</a><em>&nbsp;error_code</em>, uint8_t<em>&nbsp;*opaque_data</em>, size_t<em>&nbsp;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> <dd><p>Submits GOAWAY frame with the error code <em>error_code</em>.</p>
<p>If the <em>opaque_data</em> is not NULL and opaque_data_len is not zero, <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
those data will be sent as additional debug data. The library zero, those data will be sent as additional debug data. The
makes a copy of the memory region pointed by <em>opaque_data</em> with the library makes a copy of the memory region pointed by <em>opaque_data</em>
length <em>opaque_data_len</em>, so the caller does not need to keep this with the length <em>opaque_data_len</em>, so the caller does not need to
memory after the return of this function. If the <em>opaque_data_len</em> keep this memory after the return of this function. If the
is 0, the <em>opaque_data</em> could be NULL.</p> <em>opaque_data_len</em> is 0, the <em>opaque_data</em> could be <tt class="docutils literal"><span class="pre">NULL</span></tt>.</p>
<p>This function returns 0 if it succeeds, or one of the following <p>This function returns 0 if it succeeds, or one of the following
negative error codes:</p> negative error codes:</p>
<dl class="docutils"> <dl class="docutils">
@ -1902,16 +1888,17 @@ int <tt class="descname">nghttp2_submit_window_update</tt><big>(</big><a class="
<dd><p>Submits WINDOW_UPDATE frame. The effective range of the <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 <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 application must be responsible to keep the resulting window size
&lt;= (1 &lt;&lt; 31)-1. If NGHTTP2_FLAG_END_FLOW_CONTROL bit set in the &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
<em>flags</em>, 0 can be specified in the <em>window_size_increment</em>. 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 fact, if this flag is set, the value specified in the
<em>window_size_increment</em> is ignored.</p> <em>window_size_increment</em> is ignored.</p>
<p>This function returns 0 if it succeeds, or one of the following <p>This function returns 0 if it succeeds, or one of the following
negative error codes:</p> negative error codes:</p>
<dl class="docutils"> <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> <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 if <dd>The <em>delta_window_size</em> is 0 or negative and
NGHTTP2_FLAG_END_FLOW_CONTROL bit is not set in <em>flags</em>.</dd> <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_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> <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> <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> <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>

16
genindex.html
View File

@ -425,18 +425,6 @@
</dt> </dt>
<dt><a href="apiref.html#nghttp2_mem_chunk">nghttp2_mem_chunk (C type)</a>
</dt>
<dt><a href="apiref.html#nghttp2_mem_chunk.data">nghttp2_mem_chunk.data (C member)</a>
</dt>
<dt><a href="apiref.html#nghttp2_mem_chunk.length">nghttp2_mem_chunk.length (C member)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_NO_ERROR">NGHTTP2_NO_ERROR (C macro)</a> <dt><a href="apiref.html#NGHTTP2_NO_ERROR">NGHTTP2_NO_ERROR (C macro)</a>
</dt> </dt>
@ -460,8 +448,6 @@
<dt><a href="apiref.html#nghttp2_nv.valuelen">nghttp2_nv.valuelen (C member)</a> <dt><a href="apiref.html#nghttp2_nv.valuelen">nghttp2_nv.valuelen (C member)</a>
</dt> </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><a href="apiref.html#nghttp2_on_data_chunk_recv_callback">nghttp2_on_data_chunk_recv_callback (C type)</a>
</dt> </dt>
@ -470,6 +456,8 @@
<dt><a href="apiref.html#nghttp2_on_data_recv_callback">nghttp2_on_data_recv_callback (C type)</a> <dt><a href="apiref.html#nghttp2_on_data_recv_callback">nghttp2_on_data_recv_callback (C type)</a>
</dt> </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><a href="apiref.html#nghttp2_on_data_send_callback">nghttp2_on_data_send_callback (C type)</a>
</dt> </dt>

1
index.html
View File

@ -78,6 +78,7 @@ version 2.0.</p>
<h2>Resources<a class="headerlink" href="#resources" title="Permalink to this headline"></a></h2> <h2>Resources<a class="headerlink" href="#resources" title="Permalink to this headline"></a></h2>
<ul class="simple"> <ul class="simple">
<li><a class="reference external" href="http://tools.ietf.org/html/draft-ietf-httpbis-http2-04">http://tools.ietf.org/html/draft-ietf-httpbis-http2-04</a></li> <li><a class="reference external" href="http://tools.ietf.org/html/draft-ietf-httpbis-http2-04">http://tools.ietf.org/html/draft-ietf-httpbis-http2-04</a></li>
<li><a class="reference external" href="http://tools.ietf.org/html/draft-ietf-httpbis-header-compression-01">http://tools.ietf.org/html/draft-ietf-httpbis-header-compression-01</a></li>
</ul> </ul>
</div> </div>
</div> </div>

BIN
objects.inv
View File

Binary file not shown.

5
package_README.html
View File

@ -145,9 +145,8 @@ $ make</pre>
<p>The src directory contains HTTP/2.0 client, server and proxy programs.</p> <p>The src directory contains HTTP/2.0 client, server and proxy programs.</p>
<div class="section" id="nghttp-client"> <div class="section" id="nghttp-client">
<h3>nghttp - client<a class="headerlink" href="#nghttp-client" title="Permalink to this headline"></a></h3> <h3>nghttp - client<a class="headerlink" href="#nghttp-client" title="Permalink to this headline"></a></h3>
<p><tt class="docutils literal"><span class="pre">nghttp</span></tt> is HTTP-default04/2.0 client. It can connect to the <p><tt class="docutils literal"><span class="pre">nghttp</span></tt> is a HTTP/2.0 client. It can connect to the HTTP/2.0 server
HTTP/2.0 server with prior knowledge, HTTP Upgrade and NPN TLS with prior knowledge, HTTP Upgrade and NPN TLS extension.</p>
extension.</p>
<p>By default, it uses SSL/TLS connection. Use <tt class="docutils literal"><span class="pre">--no-tls</span></tt> option to <p>By default, it uses SSL/TLS connection. Use <tt class="docutils literal"><span class="pre">--no-tls</span></tt> option to
disable it.</p> disable it.</p>
<p>It has verbose output mode for framing information. Here is sample <p>It has verbose output mode for framing information. Here is sample

2
searchindex.js
View File

File diff suppressed because one or more lines are too long