Update doc

This commit is contained in:
Tatsuhiro Tsujikawa 2014-08-03 00:53:18 +09:00
parent 6ad91aa46c
commit ecc8bfd097
6 changed files with 13 additions and 15 deletions

View File

@ -3040,8 +3040,7 @@ int <tt class="descname">nghttp2_is_fatal</tt><big>(</big>int<em>&nbsp;lib_error
<dt id="c.nghttp2_check_header_name"> <dt id="c.nghttp2_check_header_name">
int <tt class="descname">nghttp2_check_header_name</tt><big>(</big>const uint8_t<em>&nbsp;*name</em>, size_t<em>&nbsp;len</em><big>)</big><a class="headerlink" href="#c.nghttp2_check_header_name" title="Permalink to this definition"></a></dt> int <tt class="descname">nghttp2_check_header_name</tt><big>(</big>const uint8_t<em>&nbsp;*name</em>, size_t<em>&nbsp;len</em><big>)</big><a class="headerlink" href="#c.nghttp2_check_header_name" title="Permalink to this definition"></a></dt>
<dd><p>Returns nonzero if HTTP header field name <em>name</em> of length <em>len</em> is <dd><p>Returns nonzero if HTTP header field name <em>name</em> of length <em>len</em> is
valid according to valid according to <a class="reference external" href="http://tools.ietf.org/html/rfc7230#section-3.2">http://tools.ietf.org/html/rfc7230#section-3.2</a></p>
<a class="reference external" href="http://tools.ietf.org/html/draft-ietf-httpbis-p1-messaging-25#section-3.2">http://tools.ietf.org/html/draft-ietf-httpbis-p1-messaging-25#section-3.2</a></p>
<p>Because this is a header field name in HTTP2, the upper cased alphabet <p>Because this is a header field name in HTTP2, the upper cased alphabet
is treated as error.</p> is treated as error.</p>
</dd></dl> </dd></dl>
@ -3051,9 +3050,7 @@ is treated as error.</p>
int <tt class="descname">nghttp2_check_header_value</tt><big>(</big>const uint8_t<em>&nbsp;*value</em>, size_t<em>&nbsp;len</em><big>)</big><a class="headerlink" href="#c.nghttp2_check_header_value" title="Permalink to this definition"></a></dt> int <tt class="descname">nghttp2_check_header_value</tt><big>(</big>const uint8_t<em>&nbsp;*value</em>, size_t<em>&nbsp;len</em><big>)</big><a class="headerlink" href="#c.nghttp2_check_header_value" title="Permalink to this definition"></a></dt>
<dd><p>Returns nonzero if HTTP header field value <em>value</em> of length <em>len</em> <dd><p>Returns nonzero if HTTP header field value <em>value</em> of length <em>len</em>
is valid according to is valid according to
<a class="reference external" href="http://tools.ietf.org/html/draft-ietf-httpbis-p1-messaging-25#section-3.2">http://tools.ietf.org/html/draft-ietf-httpbis-p1-messaging-25#section-3.2</a></p> <a class="reference external" href="http://tools.ietf.org/html/rfc7230#section-3.2">http://tools.ietf.org/html/rfc7230#section-3.2</a></p>
<p>Because this is HTTP2 header field value, it can contain NULL
character (0x00).</p>
</dd></dl> </dd></dl>
<dl class="function"> <dl class="function">

View File

@ -2964,8 +2964,7 @@
<span class="cm"> * @function</span> <span class="cm"> * @function</span>
<span class="cm"> *</span> <span class="cm"> *</span>
<span class="cm"> * Returns nonzero if HTTP header field name |name| of length |len| is</span> <span class="cm"> * Returns nonzero if HTTP header field name |name| of length |len| is</span>
<span class="cm"> * valid according to</span> <span class="cm"> * valid according to http://tools.ietf.org/html/rfc7230#section-3.2</span>
<span class="cm"> * http://tools.ietf.org/html/draft-ietf-httpbis-p1-messaging-25#section-3.2</span>
<span class="cm"> *</span> <span class="cm"> *</span>
<span class="cm"> * Because this is a header field name in HTTP2, the upper cased alphabet</span> <span class="cm"> * Because this is a header field name in HTTP2, the upper cased alphabet</span>
<span class="cm"> * is treated as error.</span> <span class="cm"> * is treated as error.</span>
@ -2977,10 +2976,7 @@
<span class="cm"> *</span> <span class="cm"> *</span>
<span class="cm"> * Returns nonzero if HTTP header field value |value| of length |len|</span> <span class="cm"> * Returns nonzero if HTTP header field value |value| of length |len|</span>
<span class="cm"> * is valid according to</span> <span class="cm"> * is valid according to</span>
<span class="cm"> * http://tools.ietf.org/html/draft-ietf-httpbis-p1-messaging-25#section-3.2</span> <span class="cm"> * http://tools.ietf.org/html/rfc7230#section-3.2</span>
<span class="cm"> *</span>
<span class="cm"> * Because this is HTTP2 header field value, it can contain NULL</span>
<span class="cm"> * character (0x00).</span>
<span class="cm"> */</span> <span class="cm"> */</span>
<span class="kt">int</span> <span class="nf">nghttp2_check_header_value</span><span class="p">(</span><span class="k">const</span> <span class="kt">uint8_t</span> <span class="o">*</span><span class="n">value</span><span class="p">,</span> <span class="kt">size_t</span> <span class="n">len</span><span class="p">);</span> <span class="kt">int</span> <span class="nf">nghttp2_check_header_value</span><span class="p">(</span><span class="k">const</span> <span class="kt">uint8_t</span> <span class="o">*</span><span class="n">value</span><span class="p">,</span> <span class="kt">size_t</span> <span class="n">len</span><span class="p">);</span>

View File

@ -237,9 +237,8 @@ and HTTP Alternative Services
<p>The following endpoints are available to try out nghttp2 <p>The following endpoints are available to try out nghttp2
implementation.</p> implementation.</p>
<ul> <ul>
<li><p class="first"><a class="reference external" href="https://nghttp2.org/">https://nghttp2.org/</a> (TLS + NPN)</p> <li><p class="first"><a class="reference external" href="https://nghttp2.org/">https://nghttp2.org/</a> (TLS + ALPN/NPN)</p>
<p>NPN offer <tt class="docutils literal"><span class="pre">h2-14</span></tt>, <tt class="docutils literal"><span class="pre">spdy/3.1</span></tt> and <tt class="docutils literal"><span class="pre">http/1.1</span></tt>. <p>NPN offer <tt class="docutils literal"><span class="pre">h2-14</span></tt>, <tt class="docutils literal"><span class="pre">spdy/3.1</span></tt> and <tt class="docutils literal"><span class="pre">http/1.1</span></tt>.</p>
ALPN is currently disabled.</p>
<p>This endpoint requires TLSv1.2 and DHE or EDCHE with GCM cipher <p>This endpoint requires TLSv1.2 and DHE or EDCHE with GCM cipher
suite for HTTP/2 connection.</p> suite for HTTP/2 connection.</p>
</li> </li>

File diff suppressed because one or more lines are too long

View File

@ -658,6 +658,7 @@ here.</p>
<span class="cp">#include &lt;openssl/ssl.h&gt;</span> <span class="cp">#include &lt;openssl/ssl.h&gt;</span>
<span class="cp">#include &lt;openssl/err.h&gt;</span> <span class="cp">#include &lt;openssl/err.h&gt;</span>
<span class="cp">#include &lt;openssl/conf.h&gt;</span>
<span class="cp">#include &lt;event.h&gt;</span> <span class="cp">#include &lt;event.h&gt;</span>
<span class="cp">#include &lt;event2/event.h&gt;</span> <span class="cp">#include &lt;event2/event.h&gt;</span>
@ -1186,6 +1187,8 @@ here.</p>
<span class="n">act</span><span class="p">.</span><span class="n">sa_handler</span> <span class="o">=</span> <span class="n">SIG_IGN</span><span class="p">;</span> <span class="n">act</span><span class="p">.</span><span class="n">sa_handler</span> <span class="o">=</span> <span class="n">SIG_IGN</span><span class="p">;</span>
<span class="n">sigaction</span><span class="p">(</span><span class="n">SIGPIPE</span><span class="p">,</span> <span class="o">&amp;</span><span class="n">act</span><span class="p">,</span> <span class="nb">NULL</span><span class="p">);</span> <span class="n">sigaction</span><span class="p">(</span><span class="n">SIGPIPE</span><span class="p">,</span> <span class="o">&amp;</span><span class="n">act</span><span class="p">,</span> <span class="nb">NULL</span><span class="p">);</span>
<span class="n">OPENSSL_config</span><span class="p">(</span><span class="nb">NULL</span><span class="p">);</span>
<span class="n">OpenSSL_add_all_algorithms</span><span class="p">();</span>
<span class="n">SSL_load_error_strings</span><span class="p">();</span> <span class="n">SSL_load_error_strings</span><span class="p">();</span>
<span class="n">SSL_library_init</span><span class="p">();</span> <span class="n">SSL_library_init</span><span class="p">();</span>

View File

@ -792,6 +792,7 @@ is about to close and we no longer use that object.</p>
<span class="cp">#include &lt;openssl/ssl.h&gt;</span> <span class="cp">#include &lt;openssl/ssl.h&gt;</span>
<span class="cp">#include &lt;openssl/err.h&gt;</span> <span class="cp">#include &lt;openssl/err.h&gt;</span>
<span class="cp">#include &lt;openssl/conf.h&gt;</span>
<span class="cp">#include &lt;event.h&gt;</span> <span class="cp">#include &lt;event.h&gt;</span>
<span class="cp">#include &lt;event2/event.h&gt;</span> <span class="cp">#include &lt;event2/event.h&gt;</span>
@ -1511,6 +1512,8 @@ is about to close and we no longer use that object.</p>
<span class="n">act</span><span class="p">.</span><span class="n">sa_handler</span> <span class="o">=</span> <span class="n">SIG_IGN</span><span class="p">;</span> <span class="n">act</span><span class="p">.</span><span class="n">sa_handler</span> <span class="o">=</span> <span class="n">SIG_IGN</span><span class="p">;</span>
<span class="n">sigaction</span><span class="p">(</span><span class="n">SIGPIPE</span><span class="p">,</span> <span class="o">&amp;</span><span class="n">act</span><span class="p">,</span> <span class="nb">NULL</span><span class="p">);</span> <span class="n">sigaction</span><span class="p">(</span><span class="n">SIGPIPE</span><span class="p">,</span> <span class="o">&amp;</span><span class="n">act</span><span class="p">,</span> <span class="nb">NULL</span><span class="p">);</span>
<span class="n">OPENSSL_config</span><span class="p">(</span><span class="nb">NULL</span><span class="p">);</span>
<span class="n">OpenSSL_add_all_algorithms</span><span class="p">();</span>
<span class="n">SSL_load_error_strings</span><span class="p">();</span> <span class="n">SSL_load_error_strings</span><span class="p">();</span>
<span class="n">SSL_library_init</span><span class="p">();</span> <span class="n">SSL_library_init</span><span class="p">();</span>