walkero
/
nghttp2
1
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity

Update doc

This commit is contained in:
Tatsuhiro Tsujikawa 2014-08-17 21:29:24 +09:00
parent 418b05aded
commit 66368e9bc5
2 changed files with 28 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
apiref.html
View File

@ -2609,13 +2609,11 @@ reached.</dd>
</dl> </dl>
<div class="admonition warning"> <div class="admonition warning">
<p class="first admonition-title">Warning</p> <p class="first admonition-title">Warning</p>
<p class="last">This function returns assigned stream ID if it succeeds and <p class="last">This function returns assigned stream ID if it succeeds. But
<em>stream_id</em> is -1. But that stream is not opened yet. The that stream is not opened yet. The application must not submit
application must not submit WINDOW_UPDATE frame using frame to that stream ID before
<a class="reference internal" href="#c.nghttp2_submit_window_update" title="nghttp2_submit_window_update"><tt class="xref c c-func docutils literal"><span class="pre">nghttp2_submit_window_update()</span></tt></a> to that stream ID before
<a class="reference internal" href="#c.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 <a class="reference internal" href="#c.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
called for this frame. Other types of frames can be submitted to called for this frame.</p>
the returned stream ID.</p>
</div> </div>
</dd></dl> </dd></dl>
@ -2715,11 +2713,9 @@ reached.</dd>
<p class="first admonition-title">Warning</p> <p class="first admonition-title">Warning</p>
<p class="last">This function returns assigned stream ID if it succeeds and <p class="last">This function returns assigned stream ID if it succeeds and
<em>stream_id</em> is -1. But that stream is not opened yet. The <em>stream_id</em> is -1. But that stream is not opened yet. The
application must not submit WINDOW_UPDATE frame using application must not submit frame to that stream ID before
<a class="reference internal" href="#c.nghttp2_submit_window_update" title="nghttp2_submit_window_update"><tt class="xref c c-func docutils literal"><span class="pre">nghttp2_submit_window_update()</span></tt></a> to that stream ID before
<a class="reference internal" href="#c.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 <a class="reference internal" href="#c.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
called for this frame. Other types of frames can be submitted to called for this frame.</p>
the returned stream ID.</p>
</div> </div>
</dd></dl> </dd></dl>
@ -2855,6 +2851,14 @@ reached.</dd>
<dt><a class="reference internal" href="#c.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="#c.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>stream_id</em> is 0.</dd> <dd>The <em>stream_id</em> is 0.</dd>
</dl> </dl>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">This function returns assigned promised stream ID if it succeeds.
But that stream is not opened yet. The application must not
submit frame to that stream ID before
<a class="reference internal" href="#c.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
called for this frame.</p>
</div>
</dd></dl> </dd></dl>
<dl class="function"> <dl class="function">

24
nghttp2.h.html
View File

@ -2433,13 +2433,11 @@
<span class="cm"> *</span> <span class="cm"> *</span>
<span class="cm"> * .. warning::</span> <span class="cm"> * .. warning::</span>
<span class="cm"> *</span> <span class="cm"> *</span>
<span class="cm"> * This function returns assigned stream ID if it succeeds and</span> <span class="cm"> * This function returns assigned stream ID if it succeeds. But</span>
<span class="cm"> * |stream_id| is -1. But that stream is not opened yet. The</span> <span class="cm"> * that stream is not opened yet. The application must not submit</span>
<span class="cm"> * application must not submit WINDOW_UPDATE frame using</span> <span class="cm"> * frame to that stream ID before</span>
<span class="cm"> * `nghttp2_submit_window_update()` to that stream ID before</span>
<span class="cm"> * :member:`nghttp2_session_callbacks.before_frame_send_callback` is</span> <span class="cm"> * :member:`nghttp2_session_callbacks.before_frame_send_callback` is</span>
<span class="cm"> * called for this frame. Other types of frames can be submitted to</span> <span class="cm"> * called for this frame.</span>
<span class="cm"> * the returned stream ID.</span>
<span class="cm"> *</span> <span class="cm"> *</span>
<span class="cm"> */</span> <span class="cm"> */</span>
<span class="kt">int32_t</span> <span class="nf">nghttp2_submit_request</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">int32_t</span> <span class="nf">nghttp2_submit_request</span><span class="p">(</span><span class="n">nghttp2_session</span> <span class="o">*</span><span class="n">session</span><span class="p">,</span>
@ -2563,11 +2561,9 @@
<span class="cm"> *</span> <span class="cm"> *</span>
<span class="cm"> * This function returns assigned stream ID if it succeeds and</span> <span class="cm"> * This function returns assigned stream ID if it succeeds and</span>
<span class="cm"> * |stream_id| is -1. But that stream is not opened yet. The</span> <span class="cm"> * |stream_id| is -1. But that stream is not opened yet. The</span>
<span class="cm"> * application must not submit WINDOW_UPDATE frame using</span> <span class="cm"> * application must not submit frame to that stream ID before</span>
<span class="cm"> * `nghttp2_submit_window_update()` to that stream ID before</span>
<span class="cm"> * :member:`nghttp2_session_callbacks.before_frame_send_callback` is</span> <span class="cm"> * :member:`nghttp2_session_callbacks.before_frame_send_callback` is</span>
<span class="cm"> * called for this frame. Other types of frames can be submitted to</span> <span class="cm"> * called for this frame.</span>
<span class="cm"> * the returned stream ID.</span>
<span class="cm"> *</span> <span class="cm"> *</span>
<span class="cm"> */</span> <span class="cm"> */</span>
<span class="kt">int32_t</span> <span class="nf">nghttp2_submit_headers</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">uint8_t</span> <span class="n">flags</span><span class="p">,</span> <span class="kt">int32_t</span> <span class="nf">nghttp2_submit_headers</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">uint8_t</span> <span class="n">flags</span><span class="p">,</span>
@ -2736,6 +2732,14 @@
<span class="cm"> * :enum:`NGHTTP2_ERR_INVALID_ARGUMENT`</span> <span class="cm"> * :enum:`NGHTTP2_ERR_INVALID_ARGUMENT`</span>
<span class="cm"> * The |stream_id| is 0.</span> <span class="cm"> * The |stream_id| is 0.</span>
<span class="cm"> *</span> <span class="cm"> *</span>
<span class="cm"> * .. warning::</span>
<span class="cm"> *</span>
<span class="cm"> * This function returns assigned promised stream ID if it succeeds.</span>
<span class="cm"> * But that stream is not opened yet. The application must not</span>
<span class="cm"> * submit frame to that stream ID before</span>
<span class="cm"> * :member:`nghttp2_session_callbacks.before_frame_send_callback` is</span>
<span class="cm"> * called for this frame.</span>
<span class="cm"> *</span>
<span class="cm"> */</span> <span class="cm"> */</span>
<span class="kt">int32_t</span> <span class="nf">nghttp2_submit_push_promise</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">uint8_t</span> <span class="n">flags</span><span class="p">,</span> <span class="kt">int32_t</span> <span class="nf">nghttp2_submit_push_promise</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">uint8_t</span> <span class="n">flags</span><span class="p">,</span>
<span class="kt">int32_t</span> <span class="n">stream_id</span><span class="p">,</span> <span class="kt">int32_t</span> <span class="n">stream_id</span><span class="p">,</span>