Skip to content

Commit 4799363

Browse files
deanberrisdeanberris
committed
Update documentation for release.
Update raw files with most recent changes.
1 parent 64d7419 commit 4799363

File tree

3 files changed

+43
-35
lines changed

3 files changed

+43
-35
lines changed

‎libs/network/doc/index.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

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

64-
.. code-block:: c++
64+
.. code-block:: cpp
6565
6666
using namespace boost::network;
6767
using namespace boost::network::http;
@@ -74,7 +74,7 @@ The client is as simple as this:
7474
7575
And the corresponding server code is listed below:
7676

77-
.. code-block:: c++
77+
.. code-block:: cpp
7878
7979
namespace http = boost::network::http;
8080

‎libs/network/doc/reference/http_client.rst

Lines changed: 34 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -168,35 +168,40 @@ initialization.
168168
Constructor taking a ``client_options<Tag>`` object. The following table
169169
shows the options you can set on a ``client_options<Tag>`` instance.
170170

171-
+----------------------+-------------------------------+-------------------------+
172-
| Parameter Name | Type | Description |
173-
+======================+===============================+=========================+
174-
| follow_redirects | ``bool`` | Boolean to specify |
175-
| | | whether the client |
176-
| | | should follow HTTP |
177-
| | | redirects. Default is |
178-
| | | ``false``. |
179-
+----------------------+-------------------------------+-------------------------+
180-
| cache_resolved | ``bool`` | Boolean to specify |
181-
| | | whether the client |
182-
| | | should cache resolved |
183-
| | | endpoints. The default |
184-
| | | is ``false``. |
185-
+----------------------+-------------------------------+-------------------------+
186-
| io_service | ``shared_ptr<io_service>`` | Shared pointer to a |
187-
| | | Boost.Asio |
188-
| | | ``io_service``. |
189-
+----------------------+-------------------------------+-------------------------+
190-
| openssl_certificate | string | The filename of the |
191-
| | | certificate to load for |
192-
| | | the SSL connection for |
193-
| | | verification. |
194-
+----------------------+-------------------------------+-------------------------+
195-
| openssl_verify_path | string | The directory from |
196-
| | | which the certificate |
197-
| | | authority files are |
198-
| | | located. |
199-
+----------------------+-------------------------------+-------------------------+
171+
+---------------------+----------------------------+--------------------------+
172+
| Parameter Name | Type | Description |
173+
+=====================+============================+==========================+
174+
| follow_redirects | ``bool`` | Boolean to specify |
175+
| | | whether the client |
176+
| | | should follow HTTP |
177+
| | | redirects. Default is |
178+
| | | ``false``. |
179+
+---------------------+----------------------------+--------------------------+
180+
| cache_resolved | ``bool`` | Boolean to specify |
181+
| | | whether the client |
182+
| | | should cache resolved |
183+
| | | endpoints. The default |
184+
| | | is ``false``. |
185+
+---------------------+----------------------------+--------------------------+
186+
| io_service | ``shared_ptr<io_service>`` | Shared pointer to a |
187+
| | | Boost.Asio |
188+
| | | ``io_service``. |
189+
+---------------------+----------------------------+--------------------------+
190+
| openssl_certificate | ``string`` | The filename of the |
191+
| | | certificate to load for |
192+
| | | the SSL connection for |
193+
| | | verification. |
194+
+---------------------+----------------------------+--------------------------+
195+
| openssl_verify_path | ``string`` | The directory from |
196+
| | | which the certificate |
197+
| | | authority files are |
198+
| | | located. |
199+
+---------------------+----------------------------+--------------------------+
200+
| always_verify_peer | ``bool`` | Boolean to specify |
201+
| | | whether the client |
202+
| | | should always verify |
203+
| | | peers in SSL connections |
204+
+---------------------+----------------------------+--------------------------+
200205

201206

202207
To use the above supported named parameters, you'll have code that looks like

‎libs/network/doc/whats_new.rst

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,7 @@ v0.11.0
1111
~~~~~~~
1212
* Fix thread leak in DNS resolution failure (`#245`_)
1313
* Remove unsupported `client_fwd.hpp` header (`#277`_)
14-
* Remove support for header-only usage (`#129`_) -- this means that the
15-
BOOST_NETWORK_NO_LIB option is no longer actually supported.
14+
* Remove support for header-only usage (`#129`_) -- this means that the BOOST_NETWORK_NO_LIB option is no longer actually supported.
1615
* Deprecate Synchronous Client implementations (`#279`_)
1716
* Support streaming body chunks for PUT/POST client requests (`#27`_)
1817
* Fix non-case-sensitive header parsing for some client tags (`#313`_)
@@ -26,17 +25,21 @@ v0.11.0
2625
* *Known test failure:* OS X Xcode Clang 5.0 + Boost 1.54.0 + libc++ don't play
2726
well with Boost.Serialization issues, mitigate test breakage but
2827
``cpp-netlib-utils_base64_test`` still fails in this platform. (`#287`_)
28+
* Provide a client option to always validate peers for HTTPS requests made by
29+
the client. (`#349`_)
2930

3031
.. _`#129`: https://github.com/cpp-netlib/cpp-netlib/issues/129
3132
.. _`#245`: https://github.com/cpp-netlib/cpp-netlib/issues/245
3233
.. _`#277`: https://github.com/cpp-netlib/cpp-netlib/issues/277
33-
.. _`#287`: https://github.com/cpp-netlib/cpp-netlib/issues/287
3434
.. _`#279`: https://github.com/cpp-netlib/cpp-netlib/issues/279
3535
.. _`#27`: https://github.com/cpp-netlib/cpp-netlib/issues/27
3636
.. _`#285`: https://github.com/cpp-netlib/cpp-netlib/issues/285
37+
.. _`#287`: https://github.com/cpp-netlib/cpp-netlib/issues/287
3738
.. _`#313`: https://github.com/cpp-netlib/cpp-netlib/issues/313
3839
.. _`#316`: https://github.com/cpp-netlib/cpp-netlib/issues/316
40+
.. _`#349`: https://github.com/cpp-netlib/cpp-netlib/issues/349
3941
.. _`#69`: https://github.com/cpp-netlib/cpp-netlib/issues/69
42+
.. _`#86`: https://github.com/cpp-netlib/cpp-netlib/issues/86
4043

4144
:mod:`cpp-netlib` 0.10
4245
----------------------

0 commit comments

Comments
 (0)