Added a first example (http_client) and intro.

glynos · glynos · commit 8f2785e149a4 · 2010-06-16T17:42:18.000+02:00
diff --git a/libs/network/doc/rst/http.rst b/libs/network/doc/rst/http.rst
@@ -1,2 +1,4 @@
-.. include:: http/hello_world_client.rst
+
+.. include:: http/http_client.rst
 .. include:: http/hello_world_server.rst
+.. include:: http/hello_world_client.rst
diff --git a/libs/network/doc/rst/http/hello_world_server.rst b/libs/network/doc/rst/http/hello_world_server.rst
@@ -1 +1,5 @@
+"Hello world" server
+====================
+
+
 
diff --git a/libs/network/doc/rst/http/http_client.rst b/libs/network/doc/rst/http/http_client.rst
@@ -0,0 +1,75 @@
+HTTP client
+===========
+
+The first code example is the simplest thing you can do with the
+``cpp-netlib``.  The application is a simple HTTP client.  All we are
+doing is creating and sending an HTTP request to a server and printing
+the response body.  Without further ado, the code to do this as
+follows:
+
+::
+    #include <boost/network/protocol/http/client.hpp>
+    #include <iostream>
+
+    int
+    main(int argc, char *argv[]) {
+        using namespace boost::network;
+	
+	if (argc != 2) {
+	    std::cout << "Usage: " << argv[0] << " [url]" << std::endl;
+    	    return 1;
+        }
+	
+        http::client client;
+        http::client::request request(argv[1]);
+	request << header("Connection", "close");
+	http::client::response response = client.get(request);
+	std::cout << body(response) << std::endl;
+	
+  	return 0;
+    }
+
+Since this is the first example, each line will be presented and
+explained in detail.
+
+::
+    #include <boost/network/protocol/http/client.hpp>
+
+All the code needed for the HTTP client resides in this header.
+
+::
+    http::client client;
+
+First we create a ``client`` object.  The ``client`` contains all the
+connection and protocol logic.  The default HTTP client is version
+1.1, as specified in `RFC 2616`_.
+
+::
+    http::client::request request(argv[1]);
+
+Next, we create a ``request`` object, with a URI string passed as a
+constructor argument.
+
+::
+    request << header("Connection", "close");
+
+``cpp-netlib`` makes use of stream syntax and *directives* to allow
+developers to build complex message structures with greater
+flexibility and clarity.  Here, we add the HTTP header "Connection:
+close" to the request in order to signal that the connection will be
+closed after the request has completed.
+
+::
+    http::client::response response = client.get(request);
+
+Once we've built the request, we then make an HTTP GET request
+throught the ``http::client`` from which an ``http::response`` is
+returned.  ``http::client`` supports all common HTTP methods.
+
+::
+    std::cout << body(response) << std::endl;
+
+Finally, though we don't check any error checking, the response body
+is printed to the console using the ``body`` directive.
+
+.. _`RFC 2616`: http://www.w3.org/Protocols/rfc2616/rfc2616.html
diff --git a/libs/network/doc/rst/introduction.rst b/libs/network/doc/rst/introduction.rst
@@ -0,0 +1,4 @@
+.. First a little introduction about what the examples will do, before
+   giving an overview of messages, uris, clients and the general
+   structure of the libraries.  A list of each example could be given
+   here.

-Original file line number
+Diff line change
@@ @@ -1 +1,5 @@ @@
 +"Hello world" server
 +====================
++
++