Update doc
This commit is contained in:
Tatsuhiro Tsujikawa
parent
3248f3e837
commit
7c05525111
|
|
@ -1529,7 +1529,11 @@ Functions
|
|||
value and :macro:`NGHTTP2_PRI_LOWEST` is the lowest value.
|
||||
|
||||
The *nva* is an array of name/value pair :type:`nghttp2_nv` with
|
||||
*nvlen* elements.
|
||||
*nvlen* elements. The value is opaque sequence of bytes and
|
||||
therefore can contain NULL byte (0x0). If the application requires
|
||||
that the ordering of values for a single header field name
|
||||
appearing in different header fields, it has to concatenate them
|
||||
using NULL byte (0x0) before passing them to this function.
|
||||
|
||||
HTTP/2.0 specification has requirement about header fields in the
|
||||
request HEADERS. See the specification for more details.
|
||||
|
|
@ -1577,7 +1581,11 @@ Functions
|
|||
frames against the stream *stream_id*.
|
||||
|
||||
The *nva* is an array of name/value pair :type:`nghttp2_nv` with
|
||||
*nvlen* elements.
|
||||
*nvlen* elements. The value is opaque sequence of bytes and
|
||||
therefore can contain NULL byte (0x0). If the application requires
|
||||
that the ordering of values for a single header field name
|
||||
appearing in different header fields, it has to concatenate them
|
||||
using NULL byte (0x0) before passing them to this function.
|
||||
|
||||
HTTP/2.0 specification has requirement about header fields in the
|
||||
response HEADERS. See the specification for more details.
|
||||
|
|
@ -1630,7 +1638,11 @@ Functions
|
|||
The *pri* is priority of this request.
|
||||
|
||||
The *nva* is an array of name/value pair :type:`nghttp2_nv` with
|
||||
*nvlen* elements.
|
||||
*nvlen* elements. The value is opaque sequence of bytes and
|
||||
therefore can contain NULL byte (0x0). If the application requires
|
||||
that the ordering of values for a single header field name
|
||||
appearing in different header fields, it has to concatenate them
|
||||
using NULL byte (0x0) before passing them to this function.
|
||||
|
||||
This function creates copies of all name/value pairs in *nva*. It
|
||||
also lower-cases all names in *nva*.
|
||||
|
|
@ -1746,7 +1758,11 @@ Functions
|
|||
The *stream_id* must be client initiated stream ID.
|
||||
|
||||
The *nva* is an array of name/value pair :type:`nghttp2_nv` with
|
||||
*nvlen* elements.
|
||||
*nvlen* elements. The value is opaque sequence of bytes and
|
||||
therefore can contain NULL byte (0x0). If the application requires
|
||||
that the ordering of values for a single header field name
|
||||
appearing in different header fields, it has to concatenate them
|
||||
using NULL byte (0x0) before passing them to this function.
|
||||
|
||||
This function creates copies of all name/value pairs in *nva*. It
|
||||
also lower-cases all names in *nva*.
|
||||
|
|
|
|||
24
apiref.html
24
apiref.html
|
|
@ -2070,7 +2070,11 @@ int <tt class="descname">nghttp2_submit_request</tt><big>(</big><a class="refere
|
|||
<p>The <em>pri</em> is priority of this request. 0 is the highest priority
|
||||
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>
|
||||
<p>The <em>nva</em> is an array of name/value pair <a class="reference internal" href="#nghttp2_nv" title="nghttp2_nv"><tt class="xref c c-type docutils literal"><span class="pre">nghttp2_nv</span></tt></a> with
|
||||
<em>nvlen</em> elements.</p>
|
||||
<em>nvlen</em> elements. The value is opaque sequence of bytes and
|
||||
therefore can contain NULL byte (0x0). If the application requires
|
||||
that the ordering of values for a single header field name
|
||||
appearing in different header fields, it has to concatenate them
|
||||
using NULL byte (0x0) before passing them to this function.</p>
|
||||
<p>HTTP/2.0 specification has requirement about header fields in the
|
||||
request HEADERS. See the specification for more details.</p>
|
||||
<p>This function creates copies of all name/value pairs in <em>nva</em>. It
|
||||
|
|
@ -2114,7 +2118,11 @@ int <tt class="descname">nghttp2_submit_response</tt><big>(</big><a class="refer
|
|||
<dd><p>Submits response HEADERS frame and optionally one or more DATA
|
||||
frames against the stream <em>stream_id</em>.</p>
|
||||
<p>The <em>nva</em> is an array of name/value pair <a class="reference internal" href="#nghttp2_nv" title="nghttp2_nv"><tt class="xref c c-type docutils literal"><span class="pre">nghttp2_nv</span></tt></a> with
|
||||
<em>nvlen</em> elements.</p>
|
||||
<em>nvlen</em> elements. The value is opaque sequence of bytes and
|
||||
therefore can contain NULL byte (0x0). If the application requires
|
||||
that the ordering of values for a single header field name
|
||||
appearing in different header fields, it has to concatenate them
|
||||
using NULL byte (0x0) before passing them to this function.</p>
|
||||
<p>HTTP/2.0 specification has requirement about header fields in the
|
||||
response HEADERS. See the specification for more details.</p>
|
||||
<p>This function creates copies of all name/value pairs in <em>nva</em>. It
|
||||
|
|
@ -2161,7 +2169,11 @@ actual stream ID is assigned just before the frame is sent. For
|
|||
response, specify stream ID in <em>stream_id</em>.</p>
|
||||
<p>The <em>pri</em> is priority of this request.</p>
|
||||
<p>The <em>nva</em> is an array of name/value pair <a class="reference internal" href="#nghttp2_nv" title="nghttp2_nv"><tt class="xref c c-type docutils literal"><span class="pre">nghttp2_nv</span></tt></a> with
|
||||
<em>nvlen</em> elements.</p>
|
||||
<em>nvlen</em> elements. The value is opaque sequence of bytes and
|
||||
therefore can contain NULL byte (0x0). If the application requires
|
||||
that the ordering of values for a single header field name
|
||||
appearing in different header fields, it has to concatenate them
|
||||
using NULL byte (0x0) before passing them to this function.</p>
|
||||
<p>This function creates copies of all name/value pairs in <em>nva</em>. It
|
||||
also lower-cases all names in <em>nva</em>.</p>
|
||||
<p>The <em>stream_user_data</em> is a pointer to an arbitrary data which is
|
||||
|
|
@ -2270,7 +2282,11 @@ the resulting PUSH_PROMISE frame always has
|
|||
header continuation support in the library.</p>
|
||||
<p>The <em>stream_id</em> must be client initiated stream ID.</p>
|
||||
<p>The <em>nva</em> is an array of name/value pair <a class="reference internal" href="#nghttp2_nv" title="nghttp2_nv"><tt class="xref c c-type docutils literal"><span class="pre">nghttp2_nv</span></tt></a> with
|
||||
<em>nvlen</em> elements.</p>
|
||||
<em>nvlen</em> elements. The value is opaque sequence of bytes and
|
||||
therefore can contain NULL byte (0x0). If the application requires
|
||||
that the ordering of values for a single header field name
|
||||
appearing in different header fields, it has to concatenate them
|
||||
using NULL byte (0x0) before passing them to this function.</p>
|
||||
<p>This function creates copies of all name/value pairs in <em>nva</em>. It
|
||||
also lower-cases all names in <em>nva</em>.</p>
|
||||
<p>Since the library reorders the frames and tries to send the highest
|
||||
|
|
|
|||
|
|
@ -1894,7 +1894,11 @@
|
|||
<span class="cm"> * value and :macro:`NGHTTP2_PRI_LOWEST` is the lowest value.</span>
|
||||
<span class="cm"> *</span>
|
||||
<span class="cm"> * The |nva| is an array of name/value pair :type:`nghttp2_nv` with</span>
|
||||
<span class="cm"> * |nvlen| elements.</span>
|
||||
<span class="cm"> * |nvlen| elements. The value is opaque sequence of bytes and</span>
|
||||
<span class="cm"> * therefore can contain NULL byte (0x0). If the application requires</span>
|
||||
<span class="cm"> * that the ordering of values for a single header field name</span>
|
||||
<span class="cm"> * appearing in different header fields, it has to concatenate them</span>
|
||||
<span class="cm"> * using NULL byte (0x0) before passing them to this function.</span>
|
||||
<span class="cm"> *</span>
|
||||
<span class="cm"> * HTTP/2.0 specification has requirement about header fields in the</span>
|
||||
<span class="cm"> * request HEADERS. See the specification for more details.</span>
|
||||
|
|
@ -1947,7 +1951,11 @@
|
|||
<span class="cm"> * frames against the stream |stream_id|.</span>
|
||||
<span class="cm"> *</span>
|
||||
<span class="cm"> * The |nva| is an array of name/value pair :type:`nghttp2_nv` with</span>
|
||||
<span class="cm"> * |nvlen| elements.</span>
|
||||
<span class="cm"> * |nvlen| elements. The value is opaque sequence of bytes and</span>
|
||||
<span class="cm"> * therefore can contain NULL byte (0x0). If the application requires</span>
|
||||
<span class="cm"> * that the ordering of values for a single header field name</span>
|
||||
<span class="cm"> * appearing in different header fields, it has to concatenate them</span>
|
||||
<span class="cm"> * using NULL byte (0x0) before passing them to this function.</span>
|
||||
<span class="cm"> *</span>
|
||||
<span class="cm"> * HTTP/2.0 specification has requirement about header fields in the</span>
|
||||
<span class="cm"> * response HEADERS. See the specification for more details.</span>
|
||||
|
|
@ -2005,7 +2013,11 @@
|
|||
<span class="cm"> * The |pri| is priority of this request.</span>
|
||||
<span class="cm"> *</span>
|
||||
<span class="cm"> * The |nva| is an array of name/value pair :type:`nghttp2_nv` with</span>
|
||||
<span class="cm"> * |nvlen| elements.</span>
|
||||
<span class="cm"> * |nvlen| elements. The value is opaque sequence of bytes and</span>
|
||||
<span class="cm"> * therefore can contain NULL byte (0x0). If the application requires</span>
|
||||
<span class="cm"> * that the ordering of values for a single header field name</span>
|
||||
<span class="cm"> * appearing in different header fields, it has to concatenate them</span>
|
||||
<span class="cm"> * using NULL byte (0x0) before passing them to this function.</span>
|
||||
<span class="cm"> *</span>
|
||||
<span class="cm"> * This function creates copies of all name/value pairs in |nva|. It</span>
|
||||
<span class="cm"> * also lower-cases all names in |nva|.</span>
|
||||
|
|
@ -2141,7 +2153,11 @@
|
|||
<span class="cm"> * The |stream_id| must be client initiated stream ID.</span>
|
||||
<span class="cm"> *</span>
|
||||
<span class="cm"> * The |nva| is an array of name/value pair :type:`nghttp2_nv` with</span>
|
||||
<span class="cm"> * |nvlen| elements.</span>
|
||||
<span class="cm"> * |nvlen| elements. The value is opaque sequence of bytes and</span>
|
||||
<span class="cm"> * therefore can contain NULL byte (0x0). If the application requires</span>
|
||||
<span class="cm"> * that the ordering of values for a single header field name</span>
|
||||
<span class="cm"> * appearing in different header fields, it has to concatenate them</span>
|
||||
<span class="cm"> * using NULL byte (0x0) before passing them to this function.</span>
|
||||
<span class="cm"> *</span>
|
||||
<span class="cm"> * This function creates copies of all name/value pairs in |nva|. It</span>
|
||||
<span class="cm"> * also lower-cases all names in |nva|.</span>
|
||||
|
|
|
|||
|
|
@ -500,6 +500,7 @@ SSL/TLS in the backend connection by deafult. To disable SSL/TLS, use
|
|||
<tt class="docutils literal"><span class="pre">--backend-no-tls</span></tt> option.</p>
|
||||
<p>The <tt class="docutils literal"><span class="pre">nghttpx</span></tt> supports configuration file. See <tt class="docutils literal"><span class="pre">--conf</span></tt> option and
|
||||
sample configuration file <tt class="docutils literal"><span class="pre">nghttpx.conf.sample</span></tt>.</p>
|
||||
<p>The <tt class="docutils literal"><span class="pre">nghttpx</span></tt> does not support server push.</p>
|
||||
<p>In the default mode, (without any of <tt class="docutils literal"><span class="pre">--http2-proxy</span></tt>,
|
||||
<tt class="docutils literal"><span class="pre">--http2-bridge</span></tt>, <tt class="docutils literal"><span class="pre">--client-proxy</span></tt> and <tt class="docutils literal"><span class="pre">--client</span></tt> options),
|
||||
<tt class="docutils literal"><span class="pre">nghttpx</span></tt> works as reverse proxy to the backend server:</p>
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
Loading…
Reference in New Issue