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-09-04 22:59:13 +09:00
parent 3d50925a5e
commit 452d4134b5
11 changed files with 2467 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
_sources/apiref.txt
View File

@ -8,6 +8,9 @@ To use the public APIs, include ``nghttp2/nghttp2.h``::
#include <nghttp2/nghttp2.h>
The header files are also available online: :doc:`nghttp2.h` and
:doc:`nghttp2ver.h`.
Remarks
-------
@ -24,6 +27,12 @@ Macros
Version number of the nghttp2 library release
.. macro:: NGHTTP2_VERSION_NUM
Numerical representation of the version number of the nghttp2 library
release. This is a 24 bit number with 8 bits for major number, 8 bits
for minor and 8 bits for patch. Version 1.2.3 becomes 0x010203.
.. macro:: NGHTTP2_PROTO_VERSION_ID
@ -32,7 +41,12 @@ Macros
.. macro:: NGHTTP2_PROTO_VERSION_ID_LEN
The length of NGHTTP2_PROTO_VERSION_ID.
The length of :macro:`NGHTTP2_PROTO_VERSION_ID`.
.. macro:: NGHTTP2_VERSION_AGE
The age of :type:`nghttp2_info`
.. macro:: NGHTTP2_PRI_DEFAULT
@ -67,7 +81,7 @@ Macros
.. macro:: NGHTTP2_CLIENT_CONNECTION_HEADER_LEN
The length of NGHTTP2_CLIENT_CONNECTION_HEADER.
The length of :macro:`NGHTTP2_CLIENT_CONNECTION_HEADER`.
.. macro:: NGHTTP2_INITIAL_MAX_CONCURRENT_STREAMS
@ -407,6 +421,29 @@ Types (structs, unions and typedefs)
.. type:: nghttp2_info
This struct is what `nghttp2_version()` returns. It holds
information about the particular nghttp2 version.
.. member:: int age
Age of this struct. This instance of nghttp2 sets it to
:macro:`NGHTTP2_VERSION_AGE` but a future version may bump it and
add more struct fields at the bottom
.. member:: int version_num
the :macro:`NGHTTP2_VERSION_NUM` number (since age ==1)
.. member:: const char *version_str
points to the :macro:`NGHTTP2_VERSION` string (since age ==1)
.. member:: const char *proto_str
points to the :macro:`NGHTTP2_PROTO_VERSION_ID` string this
instance implements (since age ==1)
.. type:: nghttp2_nv
@ -1707,4 +1744,13 @@ Functions
....
}
.. function:: nghttp2_info *nghttp2_version(int least_version)
Returns a pointer to a nghttp2_info struct with version information about
the run-time library in use. The *least_version* argument can be set to a
24 bit numerical value for the least accepted version number and if the
condition is not met, this function will return a NULL. Pass in 0 to skip
the version checking.

2
_sources/index.txt
View File

@ -16,6 +16,8 @@ Contents:
package_README
apiref
nghttp2.h
nghttp2ver.h
Resources
---------

4
_sources/nghttp2.h.txt Normal file
View File

@ -0,0 +1,4 @@
nghttp2.h
=========
.. literalinclude:: ../lib/includes/nghttp2/nghttp2.h

4
_sources/nghttp2ver.h.txt Normal file
View File

@ -0,0 +1,4 @@
nghttp2ver.h
============
.. literalinclude:: ../lib/includes/nghttp2/nghttp2ver.h

74
apiref.html
View File

@ -27,6 +27,7 @@
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="nghttp2 0.1.0-DEV documentation" href="index.html" />
<link rel="next" title="nghttp2.h" href="nghttp2.h.html" />
<link rel="prev" title="nghttp2 - HTTP/2.0 C Library" href="package_README.html" />
</head>
<body>
@ -36,6 +37,9 @@
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="nghttp2.h.html" title="nghttp2.h"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="package_README.html" title="nghttp2 - HTTP/2.0 C Library"
accesskey="P">previous</a> |</li>
@ -56,6 +60,8 @@
<div class="highlight-c"><div class="highlight"><pre><span class="cp">#include &lt;nghttp2/nghttp2.h&gt;</span>
</pre></div>
</div>
<p>The header files are also available online: <a class="reference internal" href="nghttp2.h.html"><em>nghttp2.h</em></a> and
<a class="reference internal" href="nghttp2ver.h.html"><em>nghttp2ver.h</em></a>.</p>
</div>
<div class="section" id="remarks">
<h2>Remarks<a class="headerlink" href="#remarks" title="Permalink to this headline"></a></h2>
@ -74,6 +80,14 @@ callbacks.</p>
<dd><p>Version number of the nghttp2 library release</p>
</dd></dl>
<dl class="macro">
<dt id="NGHTTP2_VERSION_NUM">
<tt class="descname">NGHTTP2_VERSION_NUM</tt><a class="headerlink" href="#NGHTTP2_VERSION_NUM" title="Permalink to this definition"></a></dt>
<dd><p>Numerical representation of the version number of the nghttp2 library
release. This is a 24 bit number with 8 bits for major number, 8 bits
for minor and 8 bits for patch. Version 1.2.3 becomes 0x010203.</p>
</dd></dl>
<dl class="macro">
<dt id="NGHTTP2_PROTO_VERSION_ID">
<tt class="descname">NGHTTP2_PROTO_VERSION_ID</tt><a class="headerlink" href="#NGHTTP2_PROTO_VERSION_ID" title="Permalink to this definition"></a></dt>
@ -83,7 +97,13 @@ callbacks.</p>
<dl class="macro">
<dt id="NGHTTP2_PROTO_VERSION_ID_LEN">
<tt class="descname">NGHTTP2_PROTO_VERSION_ID_LEN</tt><a class="headerlink" href="#NGHTTP2_PROTO_VERSION_ID_LEN" title="Permalink to this definition"></a></dt>
<dd><p>The length of NGHTTP2_PROTO_VERSION_ID.</p>
<dd><p>The length of <a class="reference internal" href="#NGHTTP2_PROTO_VERSION_ID" title="NGHTTP2_PROTO_VERSION_ID"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_PROTO_VERSION_ID</span></tt></a>.</p>
</dd></dl>
<dl class="macro">
<dt id="NGHTTP2_VERSION_AGE">
<tt class="descname">NGHTTP2_VERSION_AGE</tt><a class="headerlink" href="#NGHTTP2_VERSION_AGE" title="Permalink to this definition"></a></dt>
<dd><p>The age of <a class="reference internal" href="#nghttp2_info" title="nghttp2_info"><tt class="xref c c-type docutils literal"><span class="pre">nghttp2_info</span></tt></a></p>
</dd></dl>
<dl class="macro">
@ -125,7 +145,7 @@ callbacks.</p>
<dl class="macro">
<dt id="NGHTTP2_CLIENT_CONNECTION_HEADER_LEN">
<tt class="descname">NGHTTP2_CLIENT_CONNECTION_HEADER_LEN</tt><a class="headerlink" href="#NGHTTP2_CLIENT_CONNECTION_HEADER_LEN" title="Permalink to this definition"></a></dt>
<dd><p>The length of NGHTTP2_CLIENT_CONNECTION_HEADER.</p>
<dd><p>The length of <a class="reference internal" href="#NGHTTP2_CLIENT_CONNECTION_HEADER" title="NGHTTP2_CLIENT_CONNECTION_HEADER"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_CLIENT_CONNECTION_HEADER</span></tt></a>.</p>
</dd></dl>
<dl class="macro">
@ -643,6 +663,40 @@ session. The details of this structure are intentionally hidden
from the public API.</p>
</dd></dl>
<dl class="type">
<dt id="nghttp2_info">
<tt class="descname">nghttp2_info</tt><a class="headerlink" href="#nghttp2_info" title="Permalink to this definition"></a></dt>
<dd><p>This struct is what <a class="reference internal" href="#nghttp2_version" title="nghttp2_version"><tt class="xref c c-func docutils literal"><span class="pre">nghttp2_version()</span></tt></a> returns. It holds
information about the particular nghttp2 version.</p>
<dl class="member">
<dt id="nghttp2_info.age">
int <tt class="descname">age</tt><a class="headerlink" href="#nghttp2_info.age" title="Permalink to this definition"></a></dt>
<dd><p>Age of this struct. This instance of nghttp2 sets it to
<a class="reference internal" href="#NGHTTP2_VERSION_AGE" title="NGHTTP2_VERSION_AGE"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_VERSION_AGE</span></tt></a> but a future version may bump it and
add more struct fields at the bottom</p>
</dd></dl>
<dl class="member">
<dt id="nghttp2_info.version_num">
int <tt class="descname">version_num</tt><a class="headerlink" href="#nghttp2_info.version_num" title="Permalink to this definition"></a></dt>
<dd><p>the <a class="reference internal" href="#NGHTTP2_VERSION_NUM" title="NGHTTP2_VERSION_NUM"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_VERSION_NUM</span></tt></a> number (since age ==1)</p>
</dd></dl>
<dl class="member">
<dt id="nghttp2_info.version_str">
const char *<tt class="descname">version_str</tt><a class="headerlink" href="#nghttp2_info.version_str" title="Permalink to this definition"></a></dt>
<dd><p>points to the <a class="reference internal" href="#NGHTTP2_VERSION" title="NGHTTP2_VERSION"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_VERSION</span></tt></a> string (since age ==1)</p>
</dd></dl>
<dl class="member">
<dt id="nghttp2_info.proto_str">
const char *<tt class="descname">proto_str</tt><a class="headerlink" href="#nghttp2_info.proto_str" title="Permalink to this definition"></a></dt>
<dd><p>points to the <a class="reference internal" href="#NGHTTP2_PROTO_VERSION_ID" title="NGHTTP2_PROTO_VERSION_ID"><tt class="xref c c-macro docutils literal"><span class="pre">NGHTTP2_PROTO_VERSION_ID</span></tt></a> string this
instance implements (since age ==1)</p>
</dd></dl>
</dd></dl>
<dl class="type">
<dt id="nghttp2_nv">
<tt class="descname">nghttp2_nv</tt><a class="headerlink" href="#nghttp2_nv" title="Permalink to this definition"></a></dt>
@ -2120,6 +2174,16 @@ negative error codes:</p>
</div>
</dd></dl>
<dl class="function">
<dt id="nghttp2_version">
<a class="reference internal" href="#nghttp2_info" title="nghttp2_info">nghttp2_info</a> *<tt class="descname">nghttp2_version</tt><big>(</big>int<em>&nbsp;least_version</em><big>)</big><a class="headerlink" href="#nghttp2_version" title="Permalink to this definition"></a></dt>
<dd><p>Returns a pointer to a nghttp2_info struct with version information about
the run-time library in use. The <em>least_version</em> argument can be set to a
24 bit numerical value for the least accepted version number and if the
condition is not met, this function will return a NULL. Pass in 0 to skip
the version checking.</p>
</dd></dl>
</div>
</div>
@ -2149,6 +2213,9 @@ negative error codes:</p>
<h4>Previous topic</h4>
<p class="topless"><a href="package_README.html"
title="previous chapter">nghttp2 - HTTP/2.0 C Library</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="nghttp2.h.html"
title="next chapter">nghttp2.h</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/apiref.txt"
@ -2177,6 +2244,9 @@ negative error codes:</p>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="nghttp2.h.html" title="nghttp2.h"
>next</a> |</li>
<li class="right" >
<a href="package_README.html" title="nghttp2 - HTTP/2.0 C Library"
>previous</a> |</li>

36
genindex.html
View File

@ -409,6 +409,26 @@
</dt>
<dt><a href="apiref.html#nghttp2_info">nghttp2_info (C type)</a>
</dt>
<dt><a href="apiref.html#nghttp2_info.age">nghttp2_info.age (C member)</a>
</dt>
<dt><a href="apiref.html#nghttp2_info.proto_str">nghttp2_info.proto_str (C member)</a>
</dt>
<dt><a href="apiref.html#nghttp2_info.version_num">nghttp2_info.version_num (C member)</a>
</dt>
<dt><a href="apiref.html#nghttp2_info.version_str">nghttp2_info.version_str (C member)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_INITIAL_CONNECTION_WINDOW_SIZE">NGHTTP2_INITIAL_CONNECTION_WINDOW_SIZE (C macro)</a>
</dt>
@ -456,12 +476,12 @@
<dt><a href="apiref.html#nghttp2_nv_compare_name">nghttp2_nv_compare_name (C function)</a>
</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>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="apiref.html#nghttp2_on_data_recv_callback">nghttp2_on_data_recv_callback (C type)</a>
</dt>
@ -847,10 +867,22 @@
</dt>
<dt><a href="apiref.html#nghttp2_version">nghttp2_version (C function)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_VERSION">NGHTTP2_VERSION (C macro)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_VERSION_AGE">NGHTTP2_VERSION_AGE (C macro)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_VERSION_NUM">NGHTTP2_VERSION_NUM (C macro)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_WINDOW_UPDATE">NGHTTP2_WINDOW_UPDATE (C macro)</a>
</dt>

2
index.html
View File

@ -73,6 +73,8 @@ version 2.0.</p>
<li class="toctree-l2"><a class="reference internal" href="apiref.html#functions">Functions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="nghttp2.h.html">nghttp2.h</a></li>
<li class="toctree-l1"><a class="reference internal" href="nghttp2ver.h.html">nghttp2ver.h</a></li>
</ul>
</div>
<div class="section" id="resources">

2149
nghttp2.h.html Normal file
View File

File diff suppressed because it is too large Load Diff

151
nghttp2ver.h.html Normal file
View File

@ -0,0 +1,151 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>nghttp2ver.h &mdash; nghttp2 0.1.0-DEV documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/default2.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '0.1.0-DEV',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="nghttp2 0.1.0-DEV documentation" href="index.html" />
<link rel="prev" title="nghttp2.h" href="nghttp2.h.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="nghttp2.h.html" title="nghttp2.h"
accesskey="P">previous</a> |</li>
<li><a href="index.html">nghttp2 0.1.0-DEV documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="nghttp2ver-h">
<h1>nghttp2ver.h<a class="headerlink" href="#nghttp2ver-h" title="Permalink to this headline"></a></h1>
<div class="highlight-c"><div class="highlight"><pre><span class="cm">/*</span>
<span class="cm"> * nghttp2 - HTTP/2.0 C Library</span>
<span class="cm"> *</span>
<span class="cm"> * Copyright (c) 2012, 2013 Tatsuhiro Tsujikawa</span>
<span class="cm"> *</span>
<span class="cm"> * Permission is hereby granted, free of charge, to any person obtaining</span>
<span class="cm"> * a copy of this software and associated documentation files (the</span>
<span class="cm"> * &quot;Software&quot;), to deal in the Software without restriction, including</span>
<span class="cm"> * without limitation the rights to use, copy, modify, merge, publish,</span>
<span class="cm"> * distribute, sublicense, and/or sell copies of the Software, and to</span>
<span class="cm"> * permit persons to whom the Software is furnished to do so, subject to</span>
<span class="cm"> * the following conditions:</span>
<span class="cm"> *</span>
<span class="cm"> * The above copyright notice and this permission notice shall be</span>
<span class="cm"> * included in all copies or substantial portions of the Software.</span>
<span class="cm"> *</span>
<span class="cm"> * THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND,</span>
<span class="cm"> * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF</span>
<span class="cm"> * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND</span>
<span class="cm"> * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE</span>
<span class="cm"> * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION</span>
<span class="cm"> * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION</span>
<span class="cm"> * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</span>
<span class="cm"> */</span>
<span class="cp">#ifndef NGHTTP2VER_H</span>
<span class="cp">#define NGHTTP2VER_H</span>
<span class="cm">/**</span>
<span class="cm"> * @macro</span>
<span class="cm"> * Version number of the nghttp2 library release</span>
<span class="cm"> */</span>
<span class="cp">#define NGHTTP2_VERSION &quot;0.1.0-DEV&quot;</span>
<span class="cm">/**</span>
<span class="cm"> * @macro</span>
<span class="cm"> * Numerical representation of the version number of the nghttp2 library</span>
<span class="cm"> * release. This is a 24 bit number with 8 bits for major number, 8 bits</span>
<span class="cm"> * for minor and 8 bits for patch. Version 1.2.3 becomes 0x010203.</span>
<span class="cm"> */</span>
<span class="cp">#define NGHTTP2_VERSION_NUM 0x000100</span>
<span class="cp">#endif </span><span class="cm">/* NGHTTP2VER_H */</span><span class="cp"></span>
</pre></div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper"><h3>Menu</h3>
<ul>
<li><a href="https://github.com/tatsuhiro-t/nghttp2/issues">Issues</a></li>
<li><a href="https://github.com/tatsuhiro-t/nghttp2">Source</a></li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="nghttp2.h.html"
title="previous chapter">nghttp2.h</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/nghttp2ver.h.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="nghttp2.h.html" title="nghttp2.h"
>previous</a> |</li>
<li><a href="index.html">nghttp2 0.1.0-DEV documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2012, 2013, Tatsuhiro Tsujikawa.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>

BIN
objects.inv
View File

Binary file not shown.

2
searchindex.js
View File

File diff suppressed because one or more lines are too long