Skip to content

Documentation updates for 0.11.0 release. #353

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 30, 2013
Merged

Documentation updates for 0.11.0 release. #353

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4799363
Update documentation for release.
deanberris Dec 20, 2013
d31462f
Generated docs for 0.11.0 release
deanberris Dec 20, 2013
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Update documentation for release. 
Update raw files with most recent changes.
  • Loading branch information
@deanberris
deanberris committed Dec 20, 2013
commit 47993634c0d7ec6066d270fda78791347b1b6de7
6 changes: 3 additions & 3 deletions libs/network/doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

.. :Authors: Glyn Matthews <glyn.matthews@gmail.com>
.. Dean Michael Berris <dberris@google.com>
.. :Date: Nov 24, 2013
.. :Date: 2013-12-21
.. :Version: 0.11.0
.. :Description: Complete user documentation, with examples, for the :mod:`cpp-netlib`.
.. :Copyright: Copyright Glyn Matthews, Dean Michael Berris 2008-2013.
Expand Down Expand Up @@ -61,7 +61,7 @@ network applications with the minimum of fuss.
An HTTP server-client example can be written in tens of lines of code.
The client is as simple as this:

.. code-block:: c++
.. code-block:: cpp

using namespace boost::network;
using namespace boost::network::http;
Expand All @@ -74,7 +74,7 @@ The client is as simple as this:

And the corresponding server code is listed below:

.. code-block:: c++
.. code-block:: cpp

namespace http = boost::network::http;

Expand Down
63 changes: 34 additions & 29 deletions libs/network/doc/reference/http_client.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,35 +168,40 @@ initialization.
Constructor taking a ``client_options<Tag>`` object. The following table
shows the options you can set on a ``client_options<Tag>`` instance.

+----------------------+-------------------------------+-------------------------+
| Parameter Name | Type | Description |
+======================+===============================+=========================+
| follow_redirects | ``bool`` | Boolean to specify |
| | | whether the client |
| | | should follow HTTP |
| | | redirects. Default is |
| | | ``false``. |
+----------------------+-------------------------------+-------------------------+
| cache_resolved | ``bool`` | Boolean to specify |
| | | whether the client |
| | | should cache resolved |
| | | endpoints. The default |
| | | is ``false``. |
+----------------------+-------------------------------+-------------------------+
| io_service | ``shared_ptr<io_service>`` | Shared pointer to a |
| | | Boost.Asio |
| | | ``io_service``. |
+----------------------+-------------------------------+-------------------------+
| openssl_certificate | string | The filename of the |
| | | certificate to load for |
| | | the SSL connection for |
| | | verification. |
+----------------------+-------------------------------+-------------------------+
| openssl_verify_path | string | The directory from |
| | | which the certificate |
| | | authority files are |
| | | located. |
+----------------------+-------------------------------+-------------------------+
+---------------------+----------------------------+--------------------------+
| Parameter Name | Type | Description |
+=====================+============================+==========================+
| follow_redirects | ``bool`` | Boolean to specify |
| | | whether the client |
| | | should follow HTTP |
| | | redirects. Default is |
| | | ``false``. |
+---------------------+----------------------------+--------------------------+
| cache_resolved | ``bool`` | Boolean to specify |
| | | whether the client |
| | | should cache resolved |
| | | endpoints. The default |
| | | is ``false``. |
+---------------------+----------------------------+--------------------------+
| io_service | ``shared_ptr<io_service>`` | Shared pointer to a |
| | | Boost.Asio |
| | | ``io_service``. |
+---------------------+----------------------------+--------------------------+
| openssl_certificate | ``string`` | The filename of the |
| | | certificate to load for |
| | | the SSL connection for |
| | | verification. |
+---------------------+----------------------------+--------------------------+
| openssl_verify_path | ``string`` | The directory from |
| | | which the certificate |
| | | authority files are |
| | | located. |
+---------------------+----------------------------+--------------------------+
| always_verify_peer | ``bool`` | Boolean to specify |
| | | whether the client |
| | | should always verify |
| | | peers in SSL connections |
+---------------------+----------------------------+--------------------------+


To use the above supported named parameters, you'll have code that looks like
Expand Down
9 changes: 6 additions & 3 deletions libs/network/doc/whats_new.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,7 @@ v0.11.0
~~~~~~~
* Fix thread leak in DNS resolution failure (`#245`_)
* Remove unsupported `client_fwd.hpp` header (`#277`_)
* Remove support for header-only usage (`#129`_) -- this means that the
BOOST_NETWORK_NO_LIB option is no longer actually supported.
* Remove support for header-only usage (`#129`_) -- this means that the BOOST_NETWORK_NO_LIB option is no longer actually supported.
* Deprecate Synchronous Client implementations (`#279`_)
* Support streaming body chunks for PUT/POST client requests (`#27`_)
* Fix non-case-sensitive header parsing for some client tags (`#313`_)
Expand All @@ -26,17 +25,21 @@ v0.11.0
* *Known test failure:* OS X Xcode Clang 5.0 + Boost 1.54.0 + libc++ don't play
well with Boost.Serialization issues, mitigate test breakage but
``cpp-netlib-utils_base64_test`` still fails in this platform. (`#287`_)
* Provide a client option to always validate peers for HTTPS requests made by
the client. (`#349`_)

.. _`#129`: https://github.com/cpp-netlib/cpp-netlib/issues/129
.. _`#245`: https://github.com/cpp-netlib/cpp-netlib/issues/245
.. _`#277`: https://github.com/cpp-netlib/cpp-netlib/issues/277
.. _`#287`: https://github.com/cpp-netlib/cpp-netlib/issues/287
.. _`#279`: https://github.com/cpp-netlib/cpp-netlib/issues/279
.. _`#27`: https://github.com/cpp-netlib/cpp-netlib/issues/27
.. _`#285`: https://github.com/cpp-netlib/cpp-netlib/issues/285
.. _`#287`: https://github.com/cpp-netlib/cpp-netlib/issues/287
.. _`#313`: https://github.com/cpp-netlib/cpp-netlib/issues/313
.. _`#316`: https://github.com/cpp-netlib/cpp-netlib/issues/316
.. _`#349`: https://github.com/cpp-netlib/cpp-netlib/issues/349
.. _`#69`: https://github.com/cpp-netlib/cpp-netlib/issues/69
.. _`#86`: https://github.com/cpp-netlib/cpp-netlib/issues/86

:mod:`cpp-netlib` 0.10
----------------------
Expand Down