Skip to content

Commit 788edf2

Browse files
glynosglynos
committed
Refactored and improved documentation; added appendices and extra examples.
1 parent af9e5af commit 788edf2

27 files changed

+1233
-1002
lines changed

‎html/c___network_library/acknowledgements.html

+3-2
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
<link rel="home" href="../index.html" title="C++ Network Library 0.5">
88
<link rel="up" href="../index.html" title="C++ Network Library 0.5">
99
<link rel="prev" href="reference.html" title="Reference">
10+
<link rel="next" href="appendices.html" title="Appendices">
1011
</head>
1112
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
1213
<table cellpadding="2" width="100%"><tr>
@@ -19,7 +20,7 @@
1920
</tr></table>
2021
<hr>
2122
<div class="spirit-nav">
22-
<a accesskey="p" href="reference.html"><img src="http://www.boost.org/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="http://www.boost.org/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="http://www.boost.org/doc/html/images/home.png" alt="Home"></a>
23+
<a accesskey="p" href="reference.html"><img src="http://www.boost.org/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="http://www.boost.org/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="http://www.boost.org/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="appendices.html"><img src="http://www.boost.org/doc/html/images/next.png" alt="Next"></a>
2324
</div>
2425
<div class="section" title="Acknowledgements">
2526
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
@@ -40,7 +41,7 @@
4041
</tr></table>
4142
<hr>
4243
<div class="spirit-nav">
43-
<a accesskey="p" href="reference.html"><img src="http://www.boost.org/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="http://www.boost.org/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="http://www.boost.org/doc/html/images/home.png" alt="Home"></a>
44+
<a accesskey="p" href="reference.html"><img src="http://www.boost.org/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="http://www.boost.org/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="http://www.boost.org/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="appendices.html"><img src="http://www.boost.org/doc/html/images/next.png" alt="Next"></a>
4445
</div>
4546
</body>
4647
</html>

‎html/c___network_library/appendices.html

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
<html>
2+
<head>
3+
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4+
<title>Appendices</title>
5+
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
6+
<meta name="generator" content="DocBook XSL Stylesheets V1.75.1">
7+
<link rel="home" href="../index.html" title="C++ Network Library 0.5">
8+
<link rel="up" href="../index.html" title="C++ Network Library 0.5">
9+
<link rel="prev" href="acknowledgements.html" title="Acknowledgements">
10+
<link rel="next" href="appendices/message_concept.html" title="Message Concept">
11+
</head>
12+
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
13+
<table cellpadding="2" width="100%"><tr>
14+
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="http://www.boost.org/boost.png"></td>
15+
<td align="center"><a href="http://www.boost.org/index.html">Home</a></td>
16+
<td align="center"><a href="http://www.boost.org/libs/libraries.htm">Libraries</a></td>
17+
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
18+
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
19+
<td align="center"><a href="http://www.boost.org/more/index.htm">More</a></td>
20+
</tr></table>
21+
<hr>
22+
<div class="spirit-nav">
23+
<a accesskey="p" href="acknowledgements.html"><img src="http://www.boost.org/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="http://www.boost.org/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="http://www.boost.org/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="appendices/message_concept.html"><img src="http://www.boost.org/doc/html/images/next.png" alt="Next"></a>
24+
</div>
25+
<div class="section" title="Appendices">
26+
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
27+
<a name="c___network_library.appendices"></a><a class="link" href="appendices.html" title="Appendices"> Appendices</a>
28+
</h2></div></div></div>
29+
<div class="toc"><dl>
30+
<dt><span class="section"><a href="appendices/message_concept.html"> Message
31+
Concept</a></span></dt>
32+
<dt><span class="section"><a href="appendices/uri_concept.html"> URI Concepts</a></span></dt>
33+
<dt><span class="section"><a href="appendices/http_uri.html"> HTTP URI Concept</a></span></dt>
34+
</dl></div>
35+
</div>
36+
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
37+
<td align="left"></td>
38+
<td align="right"><div class="copyright-footer">Copyright &#169; 2008 , 2009, 2010 Glyn Matthews, Dean Michael Berris<p>
39+
Distributed under the Boost Software License, Version 1.0. (See accompanying
40+
file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
41+
</p>
42+
</div></td>
43+
</tr></table>
44+
<hr>
45+
<div class="spirit-nav">
46+
<a accesskey="p" href="acknowledgements.html"><img src="http://www.boost.org/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="http://www.boost.org/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="http://www.boost.org/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="appendices/message_concept.html"><img src="http://www.boost.org/doc/html/images/next.png" alt="Next"></a>
47+
</div>
48+
</body>
49+
</html>

‎html/c___network_library/appendices/http_uri.html

+204
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,204 @@
1+
<html>
2+
<head>
3+
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4+
<title>HTTP URI Concept</title>
5+
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
6+
<meta name="generator" content="DocBook XSL Stylesheets V1.75.1">
7+
<link rel="home" href="../../index.html" title="C++ Network Library 0.5">
8+
<link rel="up" href="../appendices.html" title="Appendices">
9+
<link rel="prev" href="uri_concept.html" title="URI Concepts">
10+
<link rel="next" href="../contributors.html" title="Contributors">
11+
</head>
12+
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
13+
<table cellpadding="2" width="100%"><tr>
14+
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="http://www.boost.org/boost.png"></td>
15+
<td align="center"><a href="http://www.boost.org/index.html">Home</a></td>
16+
<td align="center"><a href="http://www.boost.org/libs/libraries.htm">Libraries</a></td>
17+
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
18+
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
19+
<td align="center"><a href="http://www.boost.org/more/index.htm">More</a></td>
20+
</tr></table>
21+
<hr>
22+
<div class="spirit-nav">
23+
<a accesskey="p" href="uri_concept.html"><img src="http://www.boost.org/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../appendices.html"><img src="http://www.boost.org/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="http://www.boost.org/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../contributors.html"><img src="http://www.boost.org/doc/html/images/next.png" alt="Next"></a>
24+
</div>
25+
<div class="section" title="HTTP URI Concept">
26+
<div class="titlepage"><div><div><h3 class="title">
27+
<a name="c___network_library.appendices.http_uri"></a><a class="link" href="http_uri.html" title="HTTP URI Concept"> HTTP URI Concept</a>
28+
</h3></div></div></div>
29+
<p>
30+
A type models the HTTP URI Concept if the type adheres to the following usage
31+
semantics, and if the type also models the URI Concept.
32+
</p>
33+
<div class="variablelist" title="Notation">
34+
<p class="title"><b>Notation</b></p>
35+
<dl>
36+
<dt><span class="term"><code class="computeroutput"><span class="identifier">H</span></code></span></dt>
37+
<dd><p>
38+
An HTTP URI Type.
39+
</p></dd>
40+
<dt><span class="term"><code class="computeroutput"><span class="identifier">h</span></code>,<code class="computeroutput"><span class="identifier">h_</span></code></span></dt>
41+
<dd><p>
42+
An HTTP URI Type instance.
43+
</p></dd>
44+
<dt><span class="term"><code class="computeroutput"><span class="identifier">S</span></code></span></dt>
45+
<dd><p>
46+
A String Type.
47+
</p></dd>
48+
<dt><span class="term"><code class="computeroutput"><span class="identifier">s</span></code></span></dt>
49+
<dd><p>
50+
A String Type instance.
51+
</p></dd>
52+
</dl>
53+
</div>
54+
<a name="c___network_library.appendices.http_uri.valid_expressions"></a><h5>
55+
<a name="id3169760"></a>
56+
<a class="link" href="http_uri.html#c___network_library.appendices.http_uri.valid_expressions">Valid
57+
Expressions</a>
58+
</h5>
59+
<p>
60+
For any HTTP URI, the following expressions must be valid:
61+
</p>
62+
<div class="informaltable"><table class="table">
63+
<colgroup>
64+
<col>
65+
<col>
66+
<col>
67+
</colgroup>
68+
<thead><tr>
69+
<th>
70+
<p>
71+
Expression
72+
</p>
73+
</th>
74+
<th>
75+
<p>
76+
Return Type
77+
</p>
78+
</th>
79+
<th>
80+
<p>
81+
Description
82+
</p>
83+
</th>
84+
</tr></thead>
85+
<tbody>
86+
<tr>
87+
<td>
88+
<p>
89+
<code class="computeroutput"><span class="identifier">user_info</span><span class="special">(</span><span class="identifier">h</span><span class="special">)</span></code>
90+
</p>
91+
</td>
92+
<td>
93+
<p>
94+
S
95+
</p>
96+
</td>
97+
<td>
98+
<p>
99+
Retrieve the user-info part of the HTTP URI.
100+
</p>
101+
</td>
102+
</tr>
103+
<tr>
104+
<td>
105+
<p>
106+
<code class="computeroutput"><span class="identifier">host</span><span class="special">(</span><span class="identifier">h</span><span class="special">)</span></code>
107+
</p>
108+
</td>
109+
<td>
110+
<p>
111+
S
112+
</p>
113+
</td>
114+
<td>
115+
<p>
116+
Retrieve the host part of the HTTP URI.
117+
</p>
118+
</td>
119+
</tr>
120+
<tr>
121+
<td>
122+
<p>
123+
<code class="computeroutput"><span class="identifier">port</span><span class="special">(</span><span class="identifier">h</span><span class="special">)</span></code>
124+
</p>
125+
</td>
126+
<td>
127+
<p>
128+
uint16_t
129+
</p>
130+
</td>
131+
<td>
132+
<p>
133+
Retrieve the port part of the HTTP URI.
134+
</p>
135+
</td>
136+
</tr>
137+
<tr>
138+
<td>
139+
<p>
140+
<code class="computeroutput"><span class="identifier">path</span><span class="special">(</span><span class="identifier">h</span><span class="special">)</span></code>
141+
</p>
142+
</td>
143+
<td>
144+
<p>
145+
S
146+
</p>
147+
</td>
148+
<td>
149+
<p>
150+
Retrieve the path part of the HTTP URI.
151+
</p>
152+
</td>
153+
</tr>
154+
<tr>
155+
<td>
156+
<p>
157+
<code class="computeroutput"><span class="identifier">query</span><span class="special">(</span><span class="identifier">h</span><span class="special">)</span></code>
158+
</p>
159+
</td>
160+
<td>
161+
<p>
162+
S
163+
</p>
164+
</td>
165+
<td>
166+
<p>
167+
Retrieve the query part of the HTTP URI.
168+
</p>
169+
</td>
170+
</tr>
171+
<tr>
172+
<td>
173+
<p>
174+
<code class="computeroutput"><span class="identifier">fragment</span><span class="special">(</span><span class="identifier">h</span><span class="special">)</span></code>
175+
</p>
176+
</td>
177+
<td>
178+
<p>
179+
S
180+
</p>
181+
</td>
182+
<td>
183+
<p>
184+
Retrieve the fragment part of the HTTP URI.
185+
</p>
186+
</td>
187+
</tr>
188+
</tbody>
189+
</table></div>
190+
</div>
191+
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
192+
<td align="left"></td>
193+
<td align="right"><div class="copyright-footer">Copyright &#169; 2008 , 2009, 2010 Glyn Matthews, Dean Michael Berris<p>
194+
Distributed under the Boost Software License, Version 1.0. (See accompanying
195+
file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
196+
</p>
197+
</div></td>
198+
</tr></table>
199+
<hr>
200+
<div class="spirit-nav">
201+
<a accesskey="p" href="uri_concept.html"><img src="http://www.boost.org/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../appendices.html"><img src="http://www.boost.org/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="http://www.boost.org/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../contributors.html"><img src="http://www.boost.org/doc/html/images/next.png" alt="Next"></a>
202+
</div>
203+
</body>
204+
</html>

0 commit comments

Comments
 (0)