Forgot to add modified quickbook files.

glynos · glynos · commit 6c603784f8ef · 2010-01-16T09:55:53.000+01:00
diff --git a/libs/network/doc/architecture.qbk b/libs/network/doc/architecture.qbk
@@ -9,9 +9,9 @@
 [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.
 
-The architecture is driven by the requirement to separate requests from the transport mechanism.  Additionally, it's possible to utilise templates and static mechanisms 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.  These underly 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]
diff --git a/libs/network/doc/http.qbk b/libs/network/doc/http.qbk
@@ -1,5 +1,5 @@
 [/
-  (C) Copyright 2008, 2009 Glyn Matthews.
+  (C) Copyright 2008, 2009, 2010 Glyn Matthews.
   Distributed under the Boost Software License, Version 1.0.
   (See accompanying file LICENSE_1_0.txt or copy at
   http://www.boost.org/LICENSE_1_0.txt).
@@ -42,7 +42,7 @@ Before walking through exactly what is happening in this example, the principle
      typedef basic_request<tags::default_> request;
  }}}
 
-The [^request] encapsulates information about the request and the resource.
+The [^request] encapsulates information about the request and the resource.  It models the Message concept.
 
 [heading HTTP Client]
 
@@ -60,7 +60,7 @@ The [^client] encapsulates the connection-mapping logic between the domain and t
      typedef basic_response<tags::default_> response;
  }}}
 
-The [^response] encapsulates the data received from the server.
+The [^response] encapsulates the data received from the server.  It also models the Message concept.
 
 [heading Walkthrough]
 
@@ -117,4 +117,4 @@ This argument enables the caching of resolved endpoints and prevents the client
 [h5 [^http::client::follow_redirect(s)]]
 [^http::client::follow_redirects] / [^http::client::follow_redirect] follow HTTP redirect(s) (300..307) by looking at the "Location" header provided by the response(s); headers present in the original request are preserved in the subsequent request(s).
 
-[endsect]
+[endsect] [/http]
diff --git a/libs/network/doc/intro.qbk b/libs/network/doc/intro.qbk
@@ -1,5 +1,5 @@
 [/
-  (C) Copyright 2009 Glyn Matthews.
+  (C) Copyright 2009, 2010 Glyn Matthews.
   Distributed under the Boost Software License, Version 1.0.
   (See accompanying file LICENSE_1_0.txt or copy at
   http://www.boost.org/LICENSE_1_0.txt).
@@ -9,14 +9,11 @@
 [section:intro Introduction]
 
 [section:motivation Motivation]
-Modern applications that communicate with the web have never been more prevalent, through a range of diverse areas from high performance servers to embedded systems such as smart phones or navigation systems. Such applications often have high performance or small memory footprint requirements for which C++ is the best language option. Currently, there are no network libraries available that use modern object-oriented techniques in C++. __libcurl__ and __mozilla_netlib__ are two widely used libraries in this domain but there are drawbacks to both:
+Modern applications that communicate over the internet have never been more prevalent, ranging through diverse areas such as high performance servers to embedded systems for smart phones or navigation systems.
 
-* __libcurl__ suffers from poor design and inconsistent behavior in a threaded environment
-* __mozilla_netlib__ is too heavily coupled within the Mozilla architecture for practical use as a separate component 
+Currently, there are no open source network libraries available that use modern object-oriented techniques in C++.  With the introduction of __boost_asio__, developing portable network C++ applications has become a very much easier task.  What is still lacking is a set of libraries that utilise __boost_asio__ in order to provide application level support so that C++ developers are able to develop internet and distributed applications more effectively.
 
-With the development of __boost_asio__, developing portable network C++ applications has become a very much easier task.  What is still lacking is a set of libraries that utilise __boost_asio__ in order to provide application level support so that C++ developers are able to develop internet and distributed applications more effectively.
-
-[endsect]
+[endsect] [/motivation]
 
 [section:objectives Objectives]
 The objectives of the __cnl__ are to:
@@ -31,6 +28,11 @@ While many languages provide direct library support for high level network progr
 
 Eventually, __cnl__ will be extended to support many of the application layer protocols such as SMTP, FTP, SOAP, XMPP etc.
 
-[endsect]
+[endsect] [/objectives]
+
+[section:history History]
+The __cnl__ was founded by Dean Michael Berris in 2007.  Initially it consisted of a message template and an HTTP client.  It found a home on [[http://sourceforge.net/projects/cpp-netlib/][sourceforge]] but was recently migrated to [[http://github.com/mikhailberis/cpp-netlib][github]] where development is actively continued by a committed community.
+
+[endsect] [/history]
 
-[endsect]
+[endsect] [/intro]
diff --git a/libs/network/doc/message.cpp b/libs/network/doc/message.cpp
@@ -11,11 +11,11 @@ template <
     >
 class basic_message {
 public:
-    /*<< Defines a container for message headers >>*/
-    typedef typename headers_container<Tag>::type headers_container_type;
     /*<< Defines the underlying string type, so that the message can
          be specialized for different text encodings >>*/
     typedef typename string<Tag>::type string_type;
+    /*<< Defines a container for message headers >>*/
+    typedef typename headers_container<Tag>::type headers_container_type;
 
     /*<< Copy constructor >>*/
     basic_message(const basic_message &);
diff --git a/libs/network/doc/message.qbk b/libs/network/doc/message.qbk
@@ -1,5 +1,5 @@
 [/
-  (C) Copyright 2008, 2009 Glyn Matthews.
+  (C) Copyright 2008, 2009, 2010 Glyn Matthews.
   Distributed under the Boost Software License, Version 1.0.
   (See accompanying file LICENSE_1_0.txt or copy at
   http://www.boost.org/LICENSE_1_0.txt).
@@ -33,13 +33,16 @@ The __cnl__ uses tag dispatching to specialize the message interface at compile
 
  namespace boost {
  namespace network {
- typedef void tag_specialization_is_not_provided;
+ template <
+     class Tag
+     >
+ class unsupported_tag;
 
  template <
      class Tag
      >
  struct string {
-     typedef tag_specialization_is_not_provided type;
+     typedef unsupported_tag<Tag> type;
  };
 
  namespace tags {
@@ -61,24 +64,56 @@ This technique is extended to two more metafunctions that are used by __message_
      class Tag
      >
  struct ostringstream {
-     typedef tag_specialization_is_not_provided type;
+     typedef unsupported_tag<Tag> type;
  };
 
  template <
      class Tag
      >
  struct headers_container {
-     typedef tag_specialization_is_not_provided type;
+     typedef unsupported_tag<Tag> type;
  };
  } // namespace network
  } // namespace boost
 
-[endsect]
+[endsect] [/tag_dispatching]
 
 [section:message_concepts Concepts]
 __message__ is [@http://www.boost.org/doc/html/DefaultConstructible.html DefaultConstructible], [@http://www.boost.org/doc/html/CopyConstructible.html CopyConstructible] and [@http://www.boost.org/doc/html/Assignable.html Assignable].
 
-[endsect]
+[section:message_concept Message]
+
+[heading Description]
+
+A type models the URI Concept if the type adheres to the following
+usage semantics, and is DefaultConstructible and EqualityComparable.
+
+[variablelist Notation
+    [[`M`] [A Message Type.]]
+    [[`m`, `m_`] [A Message Type instance.]]
+    [[`S`] [A String Type.]]
+    [[`s`] [A String Type instance.]]
+    [[`O`] [An Ostringstream Type.]]
+    [[`o`] [An Ostringstream Type instance.]]
+    [[`C`] [A Header Container Type.]]
+    [[`c`] [A Header Container Type instance.]]
+]
+
+[heading Valid Expressions]
+
+[table
+    [[Expression]         [Return Type]   [Description]]
+    [[`M m_(m);`]         []              [M must be Copy constructible.]]
+    [[`M m_; m_ = m;`]    []              [M must be Assignable.]]
+    [[`swap(m, m_);`]     [void]          [Swap should be availabe via ADL.]]
+    [[`M::string_type`]   [S]             [M should have a nested type `string_type` of type `S`.]]
+    [[`M::headers_container_type`] [C]    [M should have a nested type `headers_container_type` of type `C`.]]
+]
+
+
+[endsect] [/message_concept]
+
+[endsect] [/message_concepts]
 
 [section:transformation_layer Transformation layer]
 The transformation layer defines the algorithms that can be applied on messages to transform parts or whole messages into different forms or representations. Transformations should apply to any type that models the Message concept.  Functions in the transform layer take the form:
@@ -88,7 +123,7 @@ The transformation layer defines the algorithms that can be applied on messages
      >
  basic_message<Tag> &transform(basic_message<Tag> &, ...);
 
-[endsect]
+[endsect] [/transformation_layer]
 
 [section:rendering_layer Rendering layer]
 The rendering layer defines the algorithms used to render a message into different formats or types. Rendering functions should apply to any type that models the Message Concept.  Functions in the rendering layer take the form:
@@ -98,6 +133,6 @@ The rendering layer defines the algorithms used to render a message into differe
      >
  unspecified &render(const basic_message<Tag> &, ...);
 
-[endsect]
+[endsect] [/rendering_layer]
 
-[endsect]
+[endsect] [/message]
diff --git a/libs/network/doc/network.qbk b/libs/network/doc/network.qbk
@@ -7,9 +7,9 @@
 
 [article C++ Network Library
     [quickbook 1.4]
-    [version 0.4]
+    [version 0.5]
     [authors [Matthews, Glyn], [Berris, Dean Michael]]
-    [copyright 2008, 2009 Glyn Matthews, Dean Michael Berris]
+    [copyright 2008, 2009, 2010 Glyn Matthews, Dean Michael Berris]
     [purpose C++ library for general network programming]
     [category text]
     [license
@@ -37,7 +37,6 @@
 [def __quick_start__ quick start]
 
 
-
 [include quick_start.qbk]
 [include intro.qbk]
 [include using.qbk]
diff --git a/libs/network/doc/uri.qbk b/libs/network/doc/uri.qbk
@@ -1,5 +1,5 @@
 [/
-  (C) Copyright 2009 Glyn Matthews.
+  (C) Copyright 2009, 2010 Glyn Matthews.
                 2009 Dean Michael Berris.
   Distributed under the Boost Software License, Version 1.0.
   (See accompanying file LICENSE_1_0.txt or copy at
@@ -18,7 +18,7 @@ only parsers the scheme and leaves the scheme specific part as is,
 as well as a very liberal HTTP URI parser. The HTTP URI object only
 supports absolute URIs that start with either 'http' or 'https'.
 
-[section:concepts URI Concepts]
+[section:uri_concepts URI Concepts]
 
 This page describes the URI Concepts implemented within cpp-netlib.
 The following concepts are also implemented as Boost.Concept_check
@@ -35,7 +35,7 @@ usage semantics, and is DefaultConstructible and EqualityComparable.
 
 [variablelist Notation
     [[`U`] [A URI Type.]]
-    [[`u`,`u_`] [A URI Type instance.]]
+    [[`u`, `u_`] [A URI Type instance.]]
     [[`S`] [A String Type.]]
     [[`s`] [A String Type instance.]]
 ]
@@ -45,14 +45,15 @@ usage semantics, and is DefaultConstructible and EqualityComparable.
 For any URI, the following expressions must be valid:
 
 [table
-    [[Expression]   [Return Type]   [Description]]
-    [[`U u_(u)`]      []              [U must be Copy constructible.]]
-    [[`U u_(s)`]      []              [U can be constructed from a string `s`.]]
-    [[`swap(u,u_)`]   [void]          [Swap should be availabe via ADL.]]
-    [[`protocol(u)`]  [S]             [Return the protocol part of the URI.]]
-    [[`rest(u)`]      [S]             [Return the rest of the URI, excluding the protocol part.]]
-    [[`valid(u)`]     [bool]          [Return true whether the URI is a valid URI.]]
-    [[`U::string_type`] [S]           [U should have a nested type `string_type` of type `S`.]]
+    [[Expression]       [Return Type]   [Description]]
+    [[`U u_(u)`;]       []              [U must be Copy constructible.]]
+    [[`U u_; u_ = u;`]  []              [U must be Assignable.]]
+    [[`U u_(s)`;]       []              [U can be constructed from a string `s`.]]
+    [[`swap(u, u_);`]   [void]          [Swap should be availabe via ADL.]]
+    [[`protocol(u);`]   [S]             [Return the protocol part of the URI.]]
+    [[`rest(u);`]       [S]             [Return the rest of the URI, excluding the protocol part.]]
+    [[`valid(u);`]      [bool]          [Return true whether the URI is a valid URI.]]
+    [[`U::string_type`] [S]             [U should have a nested type `string_type` of type `S`.]]
 ]
 
 [endsect] [/uri_concept]
@@ -85,7 +86,7 @@ For any HTTP URI, the following expressions must be valid:
 
 [endsect] [/http_uri]
 
-[endsect] [/concepts]
+[endsect] [/uri_concepts]
 
 [endsect] [/uri]
 
