Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

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.

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

Already on GitHub?Sign in to your account

Merged
deanberris merged 2 commits intocpp-netlib:0.11-develfromdeanberris:0.11-devel
Dec 30, 2013
Merged
Show file tree
Hide file tree
Changes fromall 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
4 changes: 2 additions & 2 deletionslibs/network/doc/html/.buildinfo
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
# 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:1c103949db96c4f9b9fdeaa1bf0d4adc
tags:fbb0d17656682115ca4d033fb2f83ba1
config:ae3dc7fdd27083cd0960e8fba1dd2084
tags:645f666f9bcd5a90fca523b33c5a78b7
Binary file modifiedlibs/network/doc/html/.doctrees/contents.doctree
View file
Open in desktop
Binary file not shown.
Binary file modifiedlibs/network/doc/html/.doctrees/environment.pickle
View file
Open in desktop
Binary file not shown.
Binary file modifiedlibs/network/doc/html/.doctrees/examples.doctree
View file
Open in desktop
Binary file not shown.
View file
Open in desktop
Binary file not shown.
View file
Open in desktop
Binary file not shown.
View file
Open in desktop
Binary file not shown.
View file
Open in desktop
Binary file not shown.
View file
Open in desktop
Binary file not shown.
View file
Open in desktop
Binary file not shown.
Binary file modifiedlibs/network/doc/html/.doctrees/getting_started.doctree
View file
Open in desktop
Binary file not shown.
Binary file modifiedlibs/network/doc/html/.doctrees/history.doctree
View file
Open in desktop
Binary file not shown.
Binary file modifiedlibs/network/doc/html/.doctrees/in_depth.doctree
View file
Open in desktop
Binary file not shown.
Binary file modifiedlibs/network/doc/html/.doctrees/in_depth/http.doctree
View file
Open in desktop
Binary file not shown.
View file
Open in desktop
Binary file not shown.
Binary file modifiedlibs/network/doc/html/.doctrees/in_depth/message.doctree
View file
Open in desktop
Binary file not shown.
Binary file modifiedlibs/network/doc/html/.doctrees/in_depth/uri.doctree
View file
Open in desktop
Binary file not shown.
Binary file modifiedlibs/network/doc/html/.doctrees/index.doctree
View file
Open in desktop
Binary file not shown.
Binary file modifiedlibs/network/doc/html/.doctrees/reference.doctree
View file
Open in desktop
Binary file not shown.
View file
Open in desktop
Binary file not shown.
View file
Open in desktop
Binary file not shown.
View file
Open in desktop
Binary file not shown.
View file
Open in desktop
Binary file not shown.
Binary file modifiedlibs/network/doc/html/.doctrees/references.doctree
View file
Open in desktop
Binary file not shown.
Binary file modifiedlibs/network/doc/html/.doctrees/techniques.doctree
View file
Open in desktop
Binary file not shown.
View file
Open in desktop
Binary file not shown.
View file
Open in desktop
Binary file not shown.
View file
Open in desktop
Binary file not shown.
Binary file modifiedlibs/network/doc/html/.doctrees/whats_new.doctree
View file
Open in desktop
Binary file not shown.
49 changes: 40 additions & 9 deletionslibs/network/doc/html/_sources/getting_started.txt
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -159,6 +159,21 @@ Once the build has completed, you can now run the test suite by issuing::

$ make test

You can install :mod:`cpp-netlib` by issuing::

$ sudo make install

By default this installs :mod:`cpp-netlib` into ``/usr/local``.

.. note:: As of version 0.9.3, :mod:`cpp-netlib` produces three static
libraries. Using GCC on Linux these are::

libcppnetlib-client-connections.a
libcppnetlib-server-parsers.a
libcppnetlib-uri.a

Users can find them in ``~/cpp-netlib-build/libs/network/src``.

Building On Windows
~~~~~~~~~~~~~~~~~~~

Expand All@@ -169,19 +184,35 @@ look for the solution and project files as the artifacts of the call to
with a number of project files for Visual Studio.

.. note:: As of version 0.9.3, :mod:`cpp-netlib` produces three static
libraries. Using GCC on Linux these are::
libraries. Using Visual C++ on Windows they are::

cppnetlib-client-connections.lib
cppnetlib-server-parsers.lib
cppnetlib-uri.lib

Users can find them in ``~/cpp-netlib-build/libs/network/src``.

Using :mod:`cpp-netlib`
=======================

CMake projects
~~~~~~~~~~~~~~

libcppnetlib-client-connections.a
libcppnetlib-server-parsers.a
libcppnetlib-uri.a
Projects using CMake can add the following lines in their ``CMakeLists.txt`` to
be able to use :mod:`cpp-netlib`::

set ( CMAKE_PREFIX_PATH ${CMAKE_PREFIX_PATH} ~/cpp-netlib-build )
find_package ( cppnetlib 0.11.0 REQUIRED )
include_directories ( ${CPPNETLIB_INCLUDE_DIRS} )
target_link_libraries ( MyApplication ${CPPNETLIB_LIBRARIES} )

And using Visual C++ on Windows they are::
.. note:: Setting ``CMAKE_PREFIX_PATH`` is only required when :mod:`cpp-netlib`
is not installed to a location that CMake searches. When :mod:`cpp-netlib`
is installed to the default location (``/usr/local``), ``CMake`` can find it.

cppnetlib-client-connections.lib
cppnetlib-server-parsers.lib
cppnetlib-uri.lib
.. note:: We assume that ``MyApplication`` is the application that you are
building and which depends on :mod:`cpp-netlib`.

Users can find them in ``~/cpp-netlib-build/libs/network/src``.

Reporting Issues, Getting Support
=================================
Expand Down
6 changes: 3 additions & 3 deletionslibs/network/doc/html/_sources/index.txt
View file
Open in desktop
Original file line numberDiff line numberDiff 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 DownExpand 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 deletionslibs/network/doc/html/_sources/reference/http_client.txt
View file
Open in desktop
Original file line numberDiff line numberDiff 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
10 changes: 7 additions & 3 deletionslibs/network/doc/html/_sources/whats_new.txt
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,10 +8,10 @@
----------------------

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@@ -25,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
6 changes: 1 addition & 5 deletionslibs/network/doc/html/_static/basic.css
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@
*
* Sphinx stylesheet -- basic theme.
*
* :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2013 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
Expand DownExpand Up@@ -401,10 +401,6 @@ dl.glossary dt {
margin:0;
}

.refcount {
color:#060;
}

.optional {
font-size:1.3em;
}
Expand Down
16 changes: 2 additions & 14 deletionslibs/network/doc/html/_static/doctools.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@
*
* Sphinx JavaScript utilities for all documentation.
*
* :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2013 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
Expand DownExpand Up@@ -32,7 +32,7 @@ if (!window.console || !console.firebug) {
*/
jQuery.urldecode = function(x) {
return decodeURIComponent(x).replace(/\+/g, ' ');
}
};

/**
* small helper function to urlencode strings
Expand DownExpand Up@@ -61,18 +61,6 @@ jQuery.getQueryParameters = function(s) {
return result;
};

/**
* small function to check if an array contains
* a given item.
*/
jQuery.contains = function(arr, item) {
for (var i = 0; i < arr.length; i++) {
if (arr[i] == item)
return true;
}
return false;
};

/**
* highlight a given string on a jquery object by wrapping it in
* span elements with the given class name.
Expand Down
2 changes: 1 addition & 1 deletionlibs/network/doc/html/_static/epub.css
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@
*
* Sphinx stylesheet -- default theme.
*
* :copyright: Copyright 2007-2010 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2013 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
Expand Down
Loading
[8]ページ先頭
©2009-2025 Movatter.jp