# Sphinx build info version 1

# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.

config:ae3dc7fdd27083cd0960e8fba1dd2084

config:247e8c3d216dc851efe8ee3a759ed678

tags: 645f666f9bcd5a90fca523b33c5a78b7

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. |

+---------------------+----------------------------+--------------------------+

| always_verify_peer | ``bool`` | Boolean to specify |

| | | whether the client |

| | | should always verify |

| | | peers in SSL connections |

+---------------------+----------------------------+--------------------------+

+--------------------------+----------------------------+--------------------------+

| 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 |

+--------------------------+----------------------------+--------------------------+

| openssl_certificate_file | ``string`` | Filename of the |

| | | certificate to use for |

| | | client-side SSL session |

| | | establishment. |

+--------------------------+----------------------------+--------------------------+

| openssl_private_key_file | ``string`` | Filename of the |

| | | private key to use for |

| | | client-side SSL session |

| | | establishment. |

+--------------------------+----------------------------+--------------------------+

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

| linger_timeout | ``int`` | An optional int to define the timeout to wait for socket closes before it is set to linger. |

| | | The default is ``0``. |

+-----------------------+------------------------------------------+--------------------------------------------------------------------------------------------------+

| context | ``shared_ptr<context>`` | An optional shared pointer to an instance of ``boost::asio::ssl::context`` -- this contains the |

| | | settings needed to support SSL. This parameter is only applicable for ``async_server`` instances.|

+-----------------------+------------------------------------------+--------------------------------------------------------------------------------------------------+

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

The function throws an instance of ``std::logic_error`` if you try to set

the headers for a connection more than once.

Adding SSL support to Asynchronous Server

-----------------------------------------

In order to setup SSL support for an Asynchronous Server, it is best to start from

a regular Asynchronous Server (see above). Once this server is setup, SSL can be

enabled by adding a Boost.Asio.Ssl.Context_ to the options. The settings that can be

used are defined in the link.

.. code-block:: c++

boost::shared_ptr<boost::asio::ssl::context> ctx = boost::make_shared<boost::asio::ssl::context>(boost::asio::ssl::context::sslv23);

ctx->set_options(

boost::asio::ssl::context::default_workarounds

| boost::asio::ssl::context::no_sslv2

| boost::asio::ssl::context::single_dh_use);

context_.set_password_callback(boost::bind(&server::get_password, this));

context_.use_certificate_chain_file("server.pem");

context_.use_private_key_file("server.pem", boost::asio::ssl::context::pem);

context_.use_tmp_dh_file("dh512.pem");

handler_type handler;

http_server::options options(handler);

options.thread_pool(boost::make_shared<boost::network::utils::thread_pool>(2));

http_server server(options.address("127.0.0.1").port("8000").context(ctx));

.. code-block:: c++

std::string get_password() const

{

return "test";

}

.. _Boost.Range: http://www.boost.org/libs/range

.. _Boost.Function: http://www.boost.org/libs/function

.. _Boost.Asio.SSL.Context: http://www.boost.org/doc/libs/1_55_0/doc/html/boost_asio/reference/ssl__context.html

``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`_)

* Back-port fix for `#163`_ for improved URI parsing.

* Added support for client-side certificates and private keys (`#361`_).

.. _`#129`: https://github.com/cpp-netlib/cpp-netlib/issues/129

.. _`#163`: https://github.com/cpp-netlib/cpp-netlib/issues/163

.. _`#245`: https://github.com/cpp-netlib/cpp-netlib/issues/245

.. _`#277`: https://github.com/cpp-netlib/cpp-netlib/issues/277

.. _`#279`: https://github.com/cpp-netlib/cpp-netlib/issues/279

.. _`#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

.. _`#361`: https://github.com/cpp-netlib/cpp-netlib/pull/361

:mod:`cpp-netlib` 0.10

----------------------

img {

border:0;

max-width:100%;

}

varterms=(params.highlight) ?params.highlight[0].split(/\s+/) :[];