Update doc

This commit is contained in:
Tatsuhiro Tsujikawa 2013-12-12 00:30:48 +09:00
parent 760a522e01
commit 3248f3e837
4 changed files with 18 additions and 1 deletions

View File

@ -1591,6 +1591,12 @@ Functions
*data_prd*. If *data_prd* is ``NULL``, HEADERS will have *data_prd*. If *data_prd* is ``NULL``, HEADERS will have
END_STREAM flag set. END_STREAM flag set.
This method can be used as normal HTTP response and server-push
response. When pushing a resource using this function, the
*session* must be configured using `nghttp2_session_server_new()`
or its variants and the target stream denoted by the *stream_id*
must be reserved using `nghttp2_submit_push_promise()`.
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:

View File

@ -2124,6 +2124,11 @@ in subsequent DATA frames. This function does not take ownership
of the <em>data_prd</em>. The function copies the members of the of the <em>data_prd</em>. The function copies the members of the
<em>data_prd</em>. If <em>data_prd</em> is <tt class="docutils literal"><span class="pre">NULL</span></tt>, HEADERS will have <em>data_prd</em>. If <em>data_prd</em> is <tt class="docutils literal"><span class="pre">NULL</span></tt>, HEADERS will have
END_STREAM flag set.</p> END_STREAM flag set.</p>
<p>This method can be used as normal HTTP response and server-push
response. When pushing a resource using this function, the
<em>session</em> must be configured using <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>
or its variants and the target stream denoted by the <em>stream_id</em>
must be reserved using <a class="reference internal" href="#nghttp2_submit_push_promise" title="nghttp2_submit_push_promise"><tt class="xref c c-func docutils literal"><span class="pre">nghttp2_submit_push_promise()</span></tt></a>.</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">

View File

@ -1961,6 +1961,12 @@
<span class="cm"> * |data_prd|. If |data_prd| is ``NULL``, HEADERS will have</span> <span class="cm"> * |data_prd|. If |data_prd| is ``NULL``, HEADERS will have</span>
<span class="cm"> * END_STREAM flag set.</span> <span class="cm"> * END_STREAM flag set.</span>
<span class="cm"> *</span> <span class="cm"> *</span>
<span class="cm"> * This method can be used as normal HTTP response and server-push</span>
<span class="cm"> * response. When pushing a resource using this function, the</span>
<span class="cm"> * |session| must be configured using `nghttp2_session_server_new()`</span>
<span class="cm"> * or its variants and the target stream denoted by the |stream_id|</span>
<span class="cm"> * must be reserved using `nghttp2_submit_push_promise()`.</span>
<span class="cm"> *</span>
<span class="cm"> * This function returns 0 if it succeeds, or one of the following</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"> * negative error codes:</span>
<span class="cm"> *</span> <span class="cm"> *</span>

File diff suppressed because one or more lines are too long