Subject: [Boost-commit] svn:boost r50950 - trunk/libs/asio/doc/overview
From: chris_at_[hidden]
Date: 2009-02-01 08:42:33
Author: chris_kohlhoff
Date: 2009-02-01 08:42:33 EST (Sun, 01 Feb 2009)
New Revision: 50950
URL: http://svn.boost.org/trac/boost/changeset/50950
Log:
Fix errors in SSL overview and add a note about handshaking. Fixes #2617 and #2619.
Text files modified:
trunk/libs/asio/doc/overview/ssl.qbk | 10 ++++++++--
1 files changed, 8 insertions(+), 2 deletions(-)
Modified: trunk/libs/asio/doc/overview/ssl.qbk
==============================================================================
--- trunk/libs/asio/doc/overview/ssl.qbk (original)
+++ trunk/libs/asio/doc/overview/ssl.qbk 2009-02-01 08:42:33 EST (Sun, 01 Feb 2009)
@@ -16,7 +16,7 @@
mode, certificate files, and so on. As an illustration, client-side
initialisation may look something like:
- ssl::context ctx(io_service, ssl::context::sslv23);
+ ssl::context ctx(my_io_service, ssl::context::sslv23);
ctx.set_verify_mode(ssl::context::verify_peer);
ctx.load_verify_file("ca.pem");
@@ -29,7 +29,7 @@
obtained using the `ssl::stream` template's [link
boost_asio.reference.ssl__stream.lowest_layer `lowest_layer()`] member function:
- ip::tcp::socket& sock = ssl_sock.lowest_layer();
+ ip::tcp::socket::lowest_layer_type& sock = ssl_sock.lowest_layer();
sock.connect(my_endpoint);
In some use cases the underlying stream object will need to have a longer
@@ -39,6 +39,12 @@
ip::tcp::socket sock(my_io_service);
ssl::stream<ip::tcp::socket&> ssl_sock(sock, ctx);
+SSL handshaking must be performed prior to transmitting or receiving data over
+an encrypted connection. This is accomplished using the `ssl::stream`
+template's [link boost_asio.reference.ssl__stream.handshake handshake()] or
+[link boost_asio.reference.ssl__stream.async_handshake async_handshake()] member
+functions.
+
Once connected, SSL stream objects are used as synchronous or asynchronous read
and write streams. This means the objects can be used with any of the [link
boost_asio.reference.read read()], [link boost_asio.reference.async_read async_read()],