Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
31 changes: 28 additions & 3 deletions libs/network/doc/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ the ``~/cpp-netlib`` directory exists, and is the top-level directory of the
Building with CMake
===================

To build the tests that come with cpp-netlib, we first need to configure the
To build the tests that come with :mod:`cpp-netlib`, we first need to configure the
build system to use our compiler of choice. This is done by running the
``cmake`` command at the top-level directory of :mod:`cpp-netlib` with
additional parameters::
Expand All @@ -131,6 +131,31 @@ additional parameters::
For the purposes of documentation, we'll assume that all
builds are done in ``~/cpp-netlib-build``.

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

$ cmake -DCMAKE_BUILD_TYPE=Debug \
> -DCMAKE_C_COMPILER=clang \
> -DCMAKE_CXX_COMPILER=clang++ \
> -DOPENSSL_ROOT_DIR=/Users/dberris/homebrew/Cellar/openssl/1.0.1f
> ../cpp-netlib

.. _OpenSSL: http://www.openssl.org/

You can also use a different root directory for the Boost_ project by using the
``-DBOOST_ROOT`` configuration option to CMake. This is useful if you intend to
build the library with a specific version of Boost that you've built in a
separate directory::

$ cmake -DCMAKE_BUILD_TYPE=Debug \
> -DCMAKE_C_COMPILER=clang \
> -DCMAKE_CXX_COMPILER=clang++ \
> -DOPENSSL_ROOT_DIR=/Users/dberris/homebrew/Cellar/openssl/1.0.1f \
> -DBOOST_ROOT=/Users/dberris/Source/boost_1_55_0
> ../cpp-netlib

Building on Linux
~~~~~~~~~~~~~~~~~

Expand Down Expand Up @@ -178,8 +203,8 @@ Building On Windows
~~~~~~~~~~~~~~~~~~~

If you're using the Microsoft Visual C++ compiler or the Microsoft Visual Studio
IDE and you would like to build cpp-netlib from within Visual Studio, you can
look for the solution and project files as the artifacts of the call to
IDE and you would like to build :mod:`cpp-netlib` from within Visual Studio, you
can look for the solution and project files as the artifacts of the call to
``cmake`` -- the file should be named ``CPP-NETLIB.sln`` (the solution) along
with a number of project files for Visual Studio.

Expand Down
31 changes: 28 additions & 3 deletions libs/network/doc/html/_sources/getting_started.txt
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ the ``~/cpp-netlib`` directory exists, and is the top-level directory of the
Building with CMake
===================

To build the tests that come with cpp-netlib, we first need to configure the
To build the tests that come with :mod:`cpp-netlib`, we first need to configure the
build system to use our compiler of choice. This is done by running the
``cmake`` command at the top-level directory of :mod:`cpp-netlib` with
additional parameters::
Expand All @@ -131,6 +131,31 @@ additional parameters::
For the purposes of documentation, we'll assume that all
builds are done in ``~/cpp-netlib-build``.

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

$ cmake -DCMAKE_BUILD_TYPE=Debug \
> -DCMAKE_C_COMPILER=clang \
> -DCMAKE_CXX_COMPILER=clang++ \
> -DOPENSSL_ROOT_DIR=/Users/dberris/homebrew/Cellar/openssl/1.0.1f
> ../cpp-netlib

.. _OpenSSL: http://www.openssl.org/

You can also use a different root directory for the Boost_ project by using the
``-DBOOST_ROOT`` configuration option to CMake. This is useful if you intend to
build the library with a specific version of Boost that you've built in a
separate directory::

$ cmake -DCMAKE_BUILD_TYPE=Debug \
> -DCMAKE_C_COMPILER=clang \
> -DCMAKE_CXX_COMPILER=clang++ \
> -DOPENSSL_ROOT_DIR=/Users/dberris/homebrew/Cellar/openssl/1.0.1f \
> -DBOOST_ROOT=/Users/dberris/Source/boost_1_55_0
> ../cpp-netlib

Building on Linux
~~~~~~~~~~~~~~~~~

Expand Down Expand Up @@ -178,8 +203,8 @@ Building On Windows
~~~~~~~~~~~~~~~~~~~

If you're using the Microsoft Visual C++ compiler or the Microsoft Visual Studio
IDE and you would like to build cpp-netlib from within Visual Studio, you can
look for the solution and project files as the artifacts of the call to
IDE and you would like to build :mod:`cpp-netlib` from within Visual Studio, you
can look for the solution and project files as the artifacts of the call to
``cmake`` -- the file should be named ``CPP-NETLIB.sln`` (the solution) along
with a number of project files for Visual Studio.

Expand Down
2 changes: 1 addition & 1 deletion libs/network/doc/html/_sources/index.txt
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: 2013-12-21
.. :Date: 2014-10-01
.. :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
20 changes: 20 additions & 0 deletions libs/network/doc/html/_sources/reference/http_client.txt
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,23 @@ asynchronous.
As of 0.11 the `Synchronous Clients`_ are now *DEPRECATED* and will be removed
in subsequent releases.

Features
--------

The HTTP client implementation supports requesting secure HTTP (HTTPS) content
only in the following situations:

* **Client libraries are built with ``BOOST_NETWORK_ENABLE_HTTPS``.** This
tells the implementation to use HTTPS-specific code to handle HTTPS-based
content when making connections associated with HTTPS URI's. This requires
a dependency on OpenSSL_.
* **The ``BOOST_NETWORK_ENABLE_HTTPS`` macro is set when compiling user
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/


Implementations
---------------

Expand Down Expand Up @@ -126,6 +143,9 @@ operations on responses. In code, usage should look like the following:

A common mistake is to declare the client inside the try block which invokes
undefined behavior when errors arise from the handling of response objects.
Previous examples cited by the documentation showed the short version of the
code which didn't bother moving the ``http::client`` object outside of the same
``try`` block where the request/response objects are being used.

Member Functions
----------------
Expand Down
3 changes: 2 additions & 1 deletion libs/network/doc/html/contents.html
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,7 @@ <h3>Navigation</h3>
<li class="toctree-l1"><a class="reference internal" href="reference.html">Reference Manual</a><ul>
<li class="toctree-l2"><a class="reference internal" href="reference/http_client.html">HTTP Client API</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/http_client.html#general">General</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/http_client.html#features">Features</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/http_client.html#implementations">Implementations</a><ul>
<li class="toctree-l4"><a class="reference internal" href="reference/http_client.html#synchronous-clients">Synchronous Clients</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/http_client.html#asynchronous-clients">Asynchronous Clients</a></li>
Expand Down Expand Up @@ -281,7 +282,7 @@ <h3>Navigation</h3>
</div>
<div class="footer">
&copy; Copyright 2008-2014, Glyn Matthews, Dean Michael Berris; 2013 Google, Inc..
Last updated on Aug 27, 2014.
Last updated on Sep 01, 2014.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion libs/network/doc/html/examples.html
Original file line number Diff line number Diff line change
Expand Up @@ -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 27, 2014.
Last updated on Sep 01, 2014.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion libs/network/doc/html/examples/http/atom_reader.html
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,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 Sep 01, 2014.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
</div>
</body>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 27, 2014.
Last updated on Sep 01, 2014.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
</div>
</body>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,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 Sep 01, 2014.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion libs/network/doc/html/examples/http/http_client.html
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,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 Sep 01, 2014.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion libs/network/doc/html/examples/http/simple_wget.html
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,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 Sep 01, 2014.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion libs/network/doc/html/examples/http/twitter_search.html
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,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 Sep 01, 2014.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
</div>
</body>
Expand Down
31 changes: 27 additions & 4 deletions libs/network/doc/html/getting_started.html
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ <h2>Getting CMake<a class="headerlink" href="#getting-cmake" title="Permalink to
</div>
<div class="section" id="building-with-cmake">
<h2>Building with CMake<a class="headerlink" href="#building-with-cmake" title="Permalink to this headline">¶</a></h2>
<p>To build the tests that come with cpp-netlib, we first need to configure the
<p>To build the tests that come with <tt class="xref py py-mod docutils literal"><span class="pre">cpp-netlib</span></tt>, we first need to configure the
build system to use our compiler of choice. This is done by running the
<tt class="docutils literal"><span class="pre">cmake</span></tt> command at the top-level directory of <tt class="xref py py-mod docutils literal"><span class="pre">cpp-netlib</span></tt> with
additional parameters:</p>
Expand All @@ -157,6 +157,29 @@ <h2>Building with CMake<a class="headerlink" href="#building-with-cmake" title="
For the purposes of documentation, we&#8217;ll assume that all
builds are done in <tt class="docutils literal"><span class="pre">~/cpp-netlib-build</span></tt>.</p>
</div>
<p>If you intend to use the SSL support when using the HTTP client libraries in
<tt class="xref py py-mod docutils literal"><span class="pre">cpp-netlib</span></tt>, you may need to build it with <a class="reference external" href="http://www.openssl.org/">OpenSSL</a> installed or at least
available to CMake. One example for building the library with <a class="reference external" href="http://www.openssl.org/">OpenSSL</a> support
is by doing the following:</p>
<div class="highlight-python"><div class="highlight"><pre>$ cmake -DCMAKE_BUILD_TYPE=Debug \
&gt; -DCMAKE_C_COMPILER=clang \
&gt; -DCMAKE_CXX_COMPILER=clang++ \
&gt; -DOPENSSL_ROOT_DIR=/Users/dberris/homebrew/Cellar/openssl/1.0.1f
&gt; ../cpp-netlib
</pre></div>
</div>
<p>You can also use a different root directory for the <a class="reference external" href="http://www.boost.org/doc/libs/release/more/getting_started/index.html">Boost</a> project by using the
<tt class="docutils literal"><span class="pre">-DBOOST_ROOT</span></tt> configuration option to CMake. This is useful if you intend to
build the library with a specific version of Boost that you&#8217;ve built in a
separate directory:</p>
<div class="highlight-python"><div class="highlight"><pre>$ cmake -DCMAKE_BUILD_TYPE=Debug \
&gt; -DCMAKE_C_COMPILER=clang \
&gt; -DCMAKE_CXX_COMPILER=clang++ \
&gt; -DOPENSSL_ROOT_DIR=/Users/dberris/homebrew/Cellar/openssl/1.0.1f \
&gt; -DBOOST_ROOT=/Users/dberris/Source/boost_1_55_0
&gt; ../cpp-netlib
</pre></div>
</div>
<div class="section" id="building-on-linux">
<h3>Building on Linux<a class="headerlink" href="#building-on-linux" title="Permalink to this headline">¶</a></h3>
<p>On Linux, this will generate the appropriate Makefiles that will enable you to
Expand Down Expand Up @@ -204,8 +227,8 @@ <h3>Building on Linux<a class="headerlink" href="#building-on-linux" title="Perm
<div class="section" id="building-on-windows">
<h3>Building On Windows<a class="headerlink" href="#building-on-windows" title="Permalink to this headline">¶</a></h3>
<p>If you&#8217;re using the Microsoft Visual C++ compiler or the Microsoft Visual Studio
IDE and you would like to build cpp-netlib from within Visual Studio, you can
look for the solution and project files as the artifacts of the call to
IDE and you would like to build <tt class="xref py py-mod docutils literal"><span class="pre">cpp-netlib</span></tt> from within Visual Studio, you
can look for the solution and project files as the artifacts of the call to
<tt class="docutils literal"><span class="pre">cmake</span></tt> &#8211; the file should be named <tt class="docutils literal"><span class="pre">CPP-NETLIB.sln</span></tt> (the solution) along
with a number of project files for Visual Studio.</p>
<div class="admonition note">
Expand Down Expand Up @@ -323,7 +346,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 Sep 01, 2014.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion libs/network/doc/html/history.html
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,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 Sep 01, 2014.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion libs/network/doc/html/in_depth.html
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,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 Sep 01, 2014.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion libs/network/doc/html/in_depth/http.html
Original file line number Diff line number Diff line change
Expand Up @@ -304,7 +304,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 Sep 01, 2014.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion libs/network/doc/html/in_depth/http_client_tags.html
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,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 Sep 01, 2014.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion libs/network/doc/html/in_depth/message.html
Original file line number Diff line number Diff line change
Expand Up @@ -392,7 +392,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 Sep 01, 2014.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion libs/network/doc/html/in_depth/uri.html
Original file line number Diff line number Diff line change
Expand Up @@ -288,7 +288,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 Sep 01, 2014.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion libs/network/doc/html/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,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 Sep 01, 2014.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
</div>
</body>
Expand Down
Binary file modified libs/network/doc/html/objects.inv
Binary file not shown.
3 changes: 2 additions & 1 deletion libs/network/doc/html/reference.html
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ <h3>Navigation</h3>
<ul>
<li class="toctree-l1"><a class="reference internal" href="reference/http_client.html">HTTP Client API</a><ul>
<li class="toctree-l2"><a class="reference internal" href="reference/http_client.html#general">General</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/http_client.html#features">Features</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/http_client.html#implementations">Implementations</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/http_client.html#member-functions">Member Functions</a></li>
</ul>
Expand Down Expand Up @@ -134,7 +135,7 @@ <h3>Navigation</h3>
</div>
<div class="footer">
&copy; Copyright 2008-2014, Glyn Matthews, Dean Michael Berris; 2013 Google, Inc..
Last updated on Aug 27, 2014.
Last updated on Sep 01, 2014.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
</div>
</body>
Expand Down
Loading