| <html> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> |
| <title>ssl::stream_service</title> |
| <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> |
| <meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> |
| <link rel="home" href="../../boost_asio.html" title="Boost.Asio"> |
| <link rel="up" href="../reference.html" title="Reference"> |
| <link rel="prev" href="ssl__stream_base/_stream_base.html" title="ssl::stream_base::~stream_base"> |
| <link rel="next" href="ssl__stream_service/async_handshake.html" title="ssl::stream_service::async_handshake"> |
| </head> |
| <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> |
| <table cellpadding="2" width="100%"><tr> |
| <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> |
| <td align="center"><a href="../../../../index.html">Home</a></td> |
| <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> |
| <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> |
| <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> |
| <td align="center"><a href="../../../../more/index.htm">More</a></td> |
| </tr></table> |
| <hr> |
| <div class="spirit-nav"> |
| <a accesskey="p" href="ssl__stream_base/_stream_base.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../boost_asio.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="ssl__stream_service/async_handshake.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> |
| </div> |
| <div class="section"> |
| <div class="titlepage"><div><div><h3 class="title"> |
| <a name="boost_asio.reference.ssl__stream_service"></a><a class="link" href="ssl__stream_service.html" title="ssl::stream_service">ssl::stream_service</a> |
| </h3></div></div></div> |
| <p> |
| Default service implementation for an SSL stream. |
| </p> |
| <pre class="programlisting"><span class="keyword">class</span> <span class="identifier">stream_service</span> <span class="special">:</span> |
| <span class="keyword">public</span> <span class="identifier">io_service</span><span class="special">::</span><span class="identifier">service</span> |
| </pre> |
| <a name="boost_asio.reference.ssl__stream_service.types"></a><h5> |
| <a name="id1348898"></a> |
| <a class="link" href="ssl__stream_service.html#boost_asio.reference.ssl__stream_service.types">Types</a> |
| </h5> |
| <div class="informaltable"><table class="table"> |
| <colgroup> |
| <col> |
| <col> |
| </colgroup> |
| <thead><tr> |
| <th> |
| <p> |
| Name |
| </p> |
| </th> |
| <th> |
| <p> |
| Description |
| </p> |
| </th> |
| </tr></thead> |
| <tbody><tr> |
| <td> |
| <p> |
| <a class="link" href="ssl__stream_service/impl_type.html" title="ssl::stream_service::impl_type"><span class="bold"><strong>impl_type</strong></span></a> |
| </p> |
| </td> |
| <td> |
| <p> |
| The type of a stream implementation. |
| </p> |
| </td> |
| </tr></tbody> |
| </table></div> |
| <a name="boost_asio.reference.ssl__stream_service.member_functions"></a><h5> |
| <a name="id1348983"></a> |
| <a class="link" href="ssl__stream_service.html#boost_asio.reference.ssl__stream_service.member_functions">Member |
| Functions</a> |
| </h5> |
| <div class="informaltable"><table class="table"> |
| <colgroup> |
| <col> |
| <col> |
| </colgroup> |
| <thead><tr> |
| <th> |
| <p> |
| Name |
| </p> |
| </th> |
| <th> |
| <p> |
| Description |
| </p> |
| </th> |
| </tr></thead> |
| <tbody> |
| <tr> |
| <td> |
| <p> |
| <a class="link" href="ssl__stream_service/async_handshake.html" title="ssl::stream_service::async_handshake"><span class="bold"><strong>async_handshake</strong></span></a> |
| </p> |
| </td> |
| <td> |
| <p> |
| Start an asynchronous SSL handshake. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| <a class="link" href="ssl__stream_service/async_read_some.html" title="ssl::stream_service::async_read_some"><span class="bold"><strong>async_read_some</strong></span></a> |
| </p> |
| </td> |
| <td> |
| <p> |
| Start an asynchronous read. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| <a class="link" href="ssl__stream_service/async_shutdown.html" title="ssl::stream_service::async_shutdown"><span class="bold"><strong>async_shutdown</strong></span></a> |
| </p> |
| </td> |
| <td> |
| <p> |
| Asynchronously shut down SSL on the stream. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| <a class="link" href="ssl__stream_service/async_write_some.html" title="ssl::stream_service::async_write_some"><span class="bold"><strong>async_write_some</strong></span></a> |
| </p> |
| </td> |
| <td> |
| <p> |
| Start an asynchronous write. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| <a class="link" href="ssl__stream_service/create.html" title="ssl::stream_service::create"><span class="bold"><strong>create</strong></span></a> |
| </p> |
| </td> |
| <td> |
| <p> |
| Create a new stream implementation. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| <a class="link" href="ssl__stream_service/destroy.html" title="ssl::stream_service::destroy"><span class="bold"><strong>destroy</strong></span></a> |
| </p> |
| </td> |
| <td> |
| <p> |
| Destroy a stream implementation. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| <a class="link" href="ssl__stream_service/get_io_service.html" title="ssl::stream_service::get_io_service"><span class="bold"><strong>get_io_service</strong></span></a> |
| </p> |
| </td> |
| <td> |
| <p> |
| Get the io_service object that owns the service. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| <a class="link" href="ssl__stream_service/handshake.html" title="ssl::stream_service::handshake"><span class="bold"><strong>handshake</strong></span></a> |
| </p> |
| </td> |
| <td> |
| <p> |
| Perform SSL handshaking. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| <a class="link" href="ssl__stream_service/in_avail.html" title="ssl::stream_service::in_avail"><span class="bold"><strong>in_avail</strong></span></a> |
| </p> |
| </td> |
| <td> |
| <p> |
| Determine the amount of data that may be read without blocking. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| <a class="link" href="ssl__stream_service/io_service.html" title="ssl::stream_service::io_service"><span class="bold"><strong>io_service</strong></span></a> |
| </p> |
| </td> |
| <td> |
| <p> |
| (Deprecated: use get_io_service().) Get the io_service object that |
| owns the service. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| <a class="link" href="ssl__stream_service/null.html" title="ssl::stream_service::null"><span class="bold"><strong>null</strong></span></a> |
| </p> |
| </td> |
| <td> |
| <p> |
| Return a null stream implementation. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| <a class="link" href="ssl__stream_service/peek.html" title="ssl::stream_service::peek"><span class="bold"><strong>peek</strong></span></a> |
| </p> |
| </td> |
| <td> |
| <p> |
| Peek at the incoming data on the stream. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| <a class="link" href="ssl__stream_service/read_some.html" title="ssl::stream_service::read_some"><span class="bold"><strong>read_some</strong></span></a> |
| </p> |
| </td> |
| <td> |
| <p> |
| Read some data from the stream. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| <a class="link" href="ssl__stream_service/shutdown.html" title="ssl::stream_service::shutdown"><span class="bold"><strong>shutdown</strong></span></a> |
| </p> |
| </td> |
| <td> |
| <p> |
| Shut down SSL on the stream. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| <a class="link" href="ssl__stream_service/shutdown_service.html" title="ssl::stream_service::shutdown_service"><span class="bold"><strong>shutdown_service</strong></span></a> |
| </p> |
| </td> |
| <td> |
| <p> |
| Destroy all user-defined handler objects owned by the service. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| <a class="link" href="ssl__stream_service/stream_service.html" title="ssl::stream_service::stream_service"><span class="bold"><strong>stream_service</strong></span></a> |
| </p> |
| </td> |
| <td> |
| <p> |
| Construct a new stream service for the specified io_service. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| <a class="link" href="ssl__stream_service/write_some.html" title="ssl::stream_service::write_some"><span class="bold"><strong>write_some</strong></span></a> |
| </p> |
| </td> |
| <td> |
| <p> |
| Write some data to the stream. |
| </p> |
| </td> |
| </tr> |
| </tbody> |
| </table></div> |
| <a name="boost_asio.reference.ssl__stream_service.data_members"></a><h5> |
| <a name="id1349555"></a> |
| <a class="link" href="ssl__stream_service.html#boost_asio.reference.ssl__stream_service.data_members">Data |
| Members</a> |
| </h5> |
| <div class="informaltable"><table class="table"> |
| <colgroup> |
| <col> |
| <col> |
| </colgroup> |
| <thead><tr> |
| <th> |
| <p> |
| Name |
| </p> |
| </th> |
| <th> |
| <p> |
| Description |
| </p> |
| </th> |
| </tr></thead> |
| <tbody><tr> |
| <td> |
| <p> |
| <a class="link" href="ssl__stream_service/id.html" title="ssl::stream_service::id"><span class="bold"><strong>id</strong></span></a> |
| </p> |
| </td> |
| <td> |
| <p> |
| The unique service identifier. |
| </p> |
| </td> |
| </tr></tbody> |
| </table></div> |
| <a name="boost_asio.reference.ssl__stream_service.requirements"></a><h5> |
| <a name="id1349641"></a> |
| <a class="link" href="ssl__stream_service.html#boost_asio.reference.ssl__stream_service.requirements">Requirements</a> |
| </h5> |
| <p> |
| <span class="bold"><strong>Header: </strong></span><code class="literal">boost/asio/ssl/stream_service.hpp</code> |
| </p> |
| <p> |
| <span class="bold"><strong>Convenience header: </strong></span><code class="literal">boost/asio/ssl.hpp</code> |
| </p> |
| </div> |
| <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> |
| <td align="left"></td> |
| <td align="right"><div class="copyright-footer">Copyright © 2003 - 2010 Christopher M. Kohlhoff<p> |
| Distributed under the Boost Software License, Version 1.0. (See accompanying |
| file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) |
| </p> |
| </div></td> |
| </tr></table> |
| <hr> |
| <div class="spirit-nav"> |
| <a accesskey="p" href="ssl__stream_base/_stream_base.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../boost_asio.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="ssl__stream_service/async_handshake.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> |
| </div> |
| </body> |
| </html> |
