Merge pull request #428 from deanberris/0.11-devel-docfix

Documentation fixes & changes are trivial and the tests continue to pass.

Author: glynos

.ycm_extra_conf.py

@@ -26,6 +26,8 @@
     '/usr/include/c++/4.6',
     '-isystem',
     '/usr/include/clang/3.0/include',
+    '-isystem',
+    '/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/lib/c++/v1',
     '-I',
     os.environ['BOOST_ROOT'],
     # Always enable debugging for the project when building for semantic

boost/network/protocol/http/message/wrappers/status_message.hpp

@@ -1,12 +1,15 @@
 #ifndef BOOST_NETWORK_PROTOCOL_HTTP_MESSAGE_WRAPPERS_STATUS_MESSAGE_HPP_20100603
 #define BOOST_NETWORK_PROTOCOL_HTTP_MESSAGE_WRAPPERS_STATUS_MESSAGE_HPP_20100603
 
-// Copyright 2010 (c) Dean Michael Berris
+// Copyright 2010 (c) Dean Michael Berris <[email protected]>
 // Copyright 2010 (c) Sinefunc, Inc.
+// Copyright 2014 (c) Google, Inc.
 // 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)
 
+#include <boost/network/traits/string.hpp>
+
 namespace boost { namespace network { namespace http {
 
     template <class Tag>
@@ -27,12 +30,19 @@ namespace boost { namespace network { namespace http {
             status_message_wrapper(status_message_wrapper const & other)
                 : response_(other.response_) {}
 
-            operator string_type () {
+            operator string_type () const {
                 return response_.status_message();
             }
 
         };
 
+	template <class Tag>
+	inline std::ostream&
+	operator<<(std::ostream& os,
+		   const status_message_wrapper<Tag>& wrapper) {
+	  return os << static_cast<typename string<Tag>::type>(wrapper);
+	}
+
     } // namespace impl
 
     template <class Tag>

libs/network/doc/examples/http/hello_world_client.rst

@@ -87,7 +87,7 @@ perform the request via HTTP:
     http::client client;
     http::client::request request("http://my.webservice.com/");
     http::client::response =
-        client.post(request, "application/xml", some_xml_string);
+        client.post(request, some_xml_string, "application/xml");
     std::data = body(response);
 
 The next set of examples show some more practical applications using

libs/network/doc/html/_sources/examples/http/hello_world_client.txt

@@ -87,7 +87,7 @@ perform the request via HTTP:
     http::client client;
     http::client::request request("http://my.webservice.com/");
     http::client::response =
-        client.post(request, "application/xml", some_xml_string);
+        client.post(request, some_xml_string, "application/xml");
     std::data = body(response);
 
 The next set of examples show some more practical applications using

libs/network/doc/html/_sources/reference/http_client.txt

@@ -71,7 +71,7 @@ behave as a fully synchronous client.
 
 The synchronous client implements all the operations of the client underneath
 the interface all block to wait for I/O to finish. All the member methods are
-synchronous and will block until the response object is ready or throws if erros
+synchronous and will block until the response object is ready or throws if errors
 are encountered in the performance of the HTTP requests.
 
 .. warning:: The synchronous clients are **NOT** thread safe. You will need to do
@@ -137,7 +137,7 @@ In this section we assume that the following typedef is in effect:
     typedef boost::network::http::basic_client<
         boost::network::http::tags::http_default_8bit_udp_resolve
         , 1
-        ,1
+        , 1
         >
         client;
 
@@ -290,6 +290,17 @@ and that there is an appropriately constructed response object named
     body chunks be handled by the ``callback`` parameter. The signature of
     ``callback`` should be the following: ``void(iterator_range<char const *> const
     &, boost::system::error_code const &)``.
+``response_ = client_.post(request_, body, content_type, callback, streaming_callback)``
+    The body and content_type parameters are of type
+    ``boost::network::string<Tag>::type`` where ``Tag`` is the HTTP Client's
+    ``Tag``. This uses the request object's other headers. Have the response
+    body chunks be handled by the ``callback`` parameter. The signature of
+    ``callback`` should be the following: ``void(iterator_range<char const *> const
+    &, boost::system::error_code const &)``. The ``streaming_callback``
+    argument should have a which has a signature of the form:
+    ``bool(string_type&)``. The provided ``string_type&`` will be streamed as
+    soon as the function returns. A return value of ``false`` signals the
+    client that the most recent invocation is the last chunk to be sent.
 ``response_ = client_.post(request_, streaming_callback)``
     Perform and HTTP POST request, and have the request's body chunks be
     generated by the ``streaming_callback`` which has a signature of the form:
@@ -329,13 +340,25 @@ and that there is an appropriately constructed response object named
     The body and content_type parameters are of type
     ``boost::network::string<Tag>::type`` where ``Tag`` is the HTTP Client's
     ``Tag``. This uses the request object's other headers.
-``response_ = client_.put(request_, body, content_type, body_handler=callback)``
+``response_ = client_.put(request_, body, content_type, callback)``
     The body and content_type parameters are of type
     ``boost::network::string<Tag>::type`` where ``Tag`` is the HTTP Client's
     ``Tag``. This uses the request object's other headers. Have the response
     body chunks be handled by the ``callback`` parameter. The signature of
     ``callback`` should be the following: ``void(iterator_range<char const *> const
     &, boost::system::error_code const &)``.
+``response_ = client_.put(request_, body, content_type, callback, streaming_callback)``
+    The body and content_type parameters are of type
+    ``boost::network::string<Tag>::type`` where ``Tag`` is the HTTP Client's
+    ``Tag``. This uses the request object's other headers. Have the response
+    body chunks be handled by the ``callback`` parameter. The signature of
+    ``callback`` should be the following: ``void(iterator_range<char const *> const
+    &, boost::system::error_code const &)``. This form also has the request's body
+    chunks be generated by the ``streaming_callback`` which has a signature of
+    the form: ``bool(string_type&)``. The provided ``string_type&`` will be
+    streamed as soon as the function returns. A return value of ``false``
+    signals the client that the most recent invocation is the last chunk to be
+    sent
 ``response_ = client_.put(request_, streaming_callback)``
     Perform and HTTP PUT request, and have the request's body chunks be
     generated by the ``streaming_callback`` which has a signature of the form:

libs/network/doc/html/contents.html

@@ -281,7 +281,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer">
         &copy; Copyright 2008-2014, Glyn Matthews, Dean Michael Berris; 2013 Google, Inc..
-      Last updated on Aug 12, 2014.
+      Last updated on Aug 27, 2014.
       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
     </div>
   </body>

libs/network/doc/html/examples.html

@@ -129,7 +129,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer">
         &copy; Copyright 2008-2014, Glyn Matthews, Dean Michael Berris; 2013 Google, Inc..
-      Last updated on Aug 12, 2014.
+      Last updated on Aug 27, 2014.
       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
     </div>
   </body>

libs/network/doc/html/examples/http/hello_world_client.html

@@ -129,7 +129,7 @@ <h2>Diving into the code<a class="headerlink" href="#diving-into-the-code" title
 <div class="highlight-c++"><div class="highlight"><pre><span class="n">http</span><span class="o">::</span><span class="n">client</span> <span class="n">client</span><span class="p">;</span>
 <span class="n">http</span><span class="o">::</span><span class="n">client</span><span class="o">::</span><span class="n">request</span> <span class="n">request</span><span class="p">(</span><span class="s">&quot;http://my.webservice.com/&quot;</span><span class="p">);</span>
 <span class="n">http</span><span class="o">::</span><span class="n">client</span><span class="o">::</span><span class="n">response</span> <span class="o">=</span>
-    <span class="n">client</span><span class="p">.</span><span class="n">post</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="s">&quot;application/xml&quot;</span><span class="p">,</span> <span class="n">some_xml_string</span><span class="p">);</span>
+    <span class="n">client</span><span class="p">.</span><span class="n">post</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="n">some_xml_string</span><span class="p">,</span> <span class="s">&quot;application/xml&quot;</span><span class="p">);</span>
 <span class="n">std</span><span class="o">::</span><span class="n">data</span> <span class="o">=</span> <span class="n">body</span><span class="p">(</span><span class="n">response</span><span class="p">);</span>
 </pre></div>
 </div>
@@ -192,7 +192,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer">
         &copy; Copyright 2008-2014, Glyn Matthews, Dean Michael Berris; 2013 Google, Inc..
-      Last updated on Aug 12, 2014.
+      Last updated on Aug 27, 2014.
       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
     </div>
   </body>

libs/network/doc/html/objects.inv

@@ -134,7 +134,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer">
         &copy; Copyright 2008-2014, Glyn Matthews, Dean Michael Berris; 2013 Google, Inc..
-      Last updated on Aug 12, 2014.
+      Last updated on Aug 27, 2014.
       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
     </div>
   </body>