Skip to content

Commit

Permalink
Minor restructuring of docs; added html docs so that it can be viewed…
Browse files Browse the repository at this point in the history 
… on-line.
  • Loading branch information
@glynos
glynos committed Jan 20, 2010
1 parent 6c60378 commit d63abbe
Show file tree
Hide file tree
Showing 34 changed files with 3,012 additions and 50 deletions.
25 changes: 25 additions & 0 deletions index.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="refresh" content="0; URL=libs/network/doc/html/index.html" />

<title></title>
<link rel="stylesheet" href="libs/network/doc/boostbook.css" type="text/css" />
</head>

<body>
Automatic redirection failed, please go to <a href=
"libs/network/doc/html/index.html">index.html</a>.

<div class="copyright-footer">
<p>Copyright 2010 Glyn Matthews</p>

<p>Distributed under the Boost Software License, Version 1.0. (See
accompanying file <a href="LICENSE_1_0.txt">LICENSE_1_0.txt</a> or copy
at <a href=
"http://www.boost.org/LICENSE_1_0.txt">http://www.boost.org/LICENSE_1_0.txt</a>)</p>
</div>
</body>
</html>
14 changes: 11 additions & 3 deletions libs/network/doc/architecture.qbk
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,19 @@


[section:architecture Architecture]
__cnl__ is built upon __boost_asio__, a high-quality, portable asynchronous I/O library that provides a solid interface for C++ network programming.
__cnl__ is built upon __boost_asio__, a high-quality, portable
asynchronous I/O library that provides a solid interface for C++
network programming.

The architecture is driven by the requirement to separate requests and responses from the transport mechanism. Additionally, it utilises generic programming techniques to make decisions at compile-time, resulting in more efficient and stable client code.
The architecture is driven by the requirement to separate requests and
responses from the transport mechanism. Additionally, it utilises
generic programming techniques to make decisions at compile-time,
resulting in more efficient and stable client code.

There are two main features of the architecture which use modern C++ techniques to allow extensibility without comprimising efficiency: tags and directives. It is these techniques that underpin the design of the message.
There are two main features of the architecture which use modern C++
techniques to allow extensibility without comprimising efficiency:
tags and directives. It is these techniques that underpin the design
of the message.

[include message.qbk]
[include uri.qbk]
Expand Down
46 changes: 46 additions & 0 deletions libs/network/doc/html/c___network_library/acknowledgements.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Acknowledgements</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.1">
<link rel="home" href="../index.html" title="C++ Network Library 0.5">
<link rel="up" href="../index.html" title="C++ Network Library 0.5">
<link rel="prev" href="reference.html" title="Reference">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="http://www.boost.org/boost.png"></td>
<td align="center"><a href="http://www.boost.org/index.html">Home</a></td>
<td align="center"><a href="http://www.boost.org/libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="http://www.boost.org/more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<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>
</div>
<div class="section" title="Acknowledgements">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="c___network_library.acknowledgements"></a><a class="link" href="acknowledgements.html" title="Acknowledgements"> Acknowledgements</a>
</h2></div></div></div>
<p>
Much of the implementation of the HTTP package was ported from <a href="http://www.pion.org/projects/pion-network-library" target="_top">the
Pion Network Library</a>.
</p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2008 , 2009, 2010 Glyn Matthews, Dean Michael Berris<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
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>)
</p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<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>
</div>
</body>
</html>
85 changes: 85 additions & 0 deletions libs/network/doc/html/c___network_library/architecture.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Architecture</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.1">
<link rel="home" href="../index.html" title="C++ Network Library 0.5">
<link rel="up" href="../index.html" title="C++ Network Library 0.5">
<link rel="prev" href="using.html" title="Using The C++ Network Library">
<link rel="next" href="architecture/message.html" title="The Message">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="http://www.boost.org/boost.png"></td>
<td align="center"><a href="http://www.boost.org/index.html">Home</a></td>
<td align="center"><a href="http://www.boost.org/libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="http://www.boost.org/more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="using.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="architecture/message.html"><img src="http://www.boost.org/doc/html/images/next.png" alt="Next"></a>
</div>
<div class="section" title="Architecture">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="c___network_library.architecture"></a><a class="link" href="architecture.html" title="Architecture"> Architecture</a>
</h2></div></div></div>
<div class="toc"><dl>
<dt><span class="section"><a href="architecture/message.html"> The Message</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="architecture/message/tag_dispatching.html">
Tag Dispatching</a></span></dt>
<dt><span class="section"><a href="architecture/message/message_concepts.html">
Concepts</a></span></dt>
<dd><dl><dt><span class="section"><a href="architecture/message/message_concepts.html#c___network_library.architecture.message.message_concepts.message_concept">
Message</a></span></dt></dl></dd>
<dt><span class="section"><a href="architecture/message/transformation_layer.html">
Transformation layer</a></span></dt>
<dt><span class="section"><a href="architecture/message/rendering_layer.html">
Rendering layer</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="architecture/uri.html"> The URI</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="architecture/uri/uri_concepts.html">
URI Concepts</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="architecture/uri/uri_concepts.html#c___network_library.architecture.uri.uri_concepts.uri_concept">
URI</a></span></dt>
<dt><span class="section"><a href="architecture/uri/uri_concepts.html#c___network_library.architecture.uri.uri_concepts.http_uri">
HTTP URI</a></span></dt>
</dl></dd>
</dl></dd>
</dl></div>
<p>
C++ Network Library is built upon <a href="http://www.boost.org/libs/asio/index.html" target="_top">Boost.Asio</a>,
a high-quality, portable asynchronous I/O library that provides a solid interface
for C++ network programming.
</p>
<p>
The architecture is driven by the requirement to separate requests and responses
from the transport mechanism. Additionally, it utilises generic programming
techniques to make decisions at compile-time, resulting in more efficient and
stable client code.
</p>
<p>
There are two main features of the architecture which use modern C++ techniques
to allow extensibility without comprimising efficiency: tags and directives.
It is these techniques that underpin the design of the message.
</p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2008 , 2009, 2010 Glyn Matthews, Dean Michael Berris<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
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>)
</p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="using.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="architecture/message.html"><img src="http://www.boost.org/doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>
Loading

0 comments on commit d63abbe

Please sign in to comment.