Skip to content

0.11 devel docfix https refinement #434

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
Sep 2, 2014
Merged

0.11 devel docfix https refinement #434

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
3482012
Fix documentation of BOOST_NETWORK_ENABLE_HTTPS
deanberris Sep 2, 2014
0746859
Regenerate updated documentation
deanberris Sep 2, 2014
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
Fix documentation of BOOST_NETWORK_ENABLE_HTTPS 
Fixes #429

Addresses comments by @povilasb on improvements to previous PR that
documents the circumstances where BOOST_NETWORK_ENABLE_HTTPS would be
set and be useful.
  • Loading branch information
@deanberris
deanberris committed Sep 2, 2014
commit 34820129581f5c0e6604225945b4998da4a6a767
9 changes: 7 additions & 2 deletions libs/network/doc/getting_started.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,8 +133,13 @@ additional parameters::

If you intend to use the SSL support when using the HTTP client libraries in
:mod:`cpp-netlib`, you may need to build it with OpenSSL_ installed or at least
available to CMake. One example for building the library with OpenSSL_ support
is by doing the following::
available to CMake. If you have the development headers for OpenSSL_ installed
on your system when you build :mod:`cpp-netlib`, CMake will be able to detect it
and set the ``BOOST_NETWORK_ENABLE_HTTPS`` macro when building the library to
support HTTPS URIs.

One example for building the library with OpenSSL_ support with a custom
(non-installed) version of OpenSSL_ is by doing the following::

$ cmake -DCMAKE_BUILD_TYPE=Debug \
> -DCMAKE_C_COMPILER=clang \
Expand Down
13 changes: 12 additions & 1 deletion libs/network/doc/reference/http_client.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,19 @@ only in the following situations:
code.** It is best to define this either at compile-time of all code using
the library, or before including any of the client headers.

.. _OpenSSL: http://www.openssl.org/
To use the client implementations that support HTTPS URIs, you may explicitly
do the following:

.. code-block:: c++

#define BOOST_NETWORK_ENABLE_HTTPS
#include <boost/network/include/http/client.hpp>

This forces HTTPS support to be enabled and forces a dependency on OpenSSL_.
This dependency is imposed by `Boost.Asio`_

.. _OpenSSL: http://www.openssl.org/
.. _`Boost.Asio`: http://www.boost.org/libs/asio

Implementations
---------------
Expand Down