blob: a0e2ea4940c4d03cd6cc99649e86c2467098bfaf [file] [log] [blame]
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>ssl::context_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__context_base/_context_base.html" title="ssl::context_base::~context_base">
<link rel="next" href="ssl__context_service/add_verify_path.html" title="ssl::context_service::add_verify_path">
</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__context_base/_context_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__context_service/add_verify_path.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__context_service"></a><a class="link" href="ssl__context_service.html" title="ssl::context_service">ssl::context_service</a>
</h3></div></div></div>
<p>
Default service implementation for a context.
</p>
<pre class="programlisting"><span class="keyword">class</span> <span class="identifier">context_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__context_service.types"></a><h5>
<a name="id1336985"></a>
<a class="link" href="ssl__context_service.html#boost_asio.reference.ssl__context_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__context_service/impl_type.html" title="ssl::context_service::impl_type"><span class="bold"><strong>impl_type</strong></span></a>
</p>
</td>
<td>
<p>
The type of the context.
</p>
</td>
</tr></tbody>
</table></div>
<a name="boost_asio.reference.ssl__context_service.member_functions"></a><h5>
<a name="id1337069"></a>
<a class="link" href="ssl__context_service.html#boost_asio.reference.ssl__context_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__context_service/add_verify_path.html" title="ssl::context_service::add_verify_path"><span class="bold"><strong>add_verify_path</strong></span></a>
</p>
</td>
<td>
<p>
Add a directory containing certification authority files to be
used for performing verification.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ssl__context_service/context_service.html" title="ssl::context_service::context_service"><span class="bold"><strong>context_service</strong></span></a>
</p>
</td>
<td>
<p>
Constructor.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ssl__context_service/create.html" title="ssl::context_service::create"><span class="bold"><strong>create</strong></span></a>
</p>
</td>
<td>
<p>
Create a new context implementation.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ssl__context_service/destroy.html" title="ssl::context_service::destroy"><span class="bold"><strong>destroy</strong></span></a>
</p>
</td>
<td>
<p>
Destroy a context implementation.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ssl__context_service/get_io_service.html" title="ssl::context_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__context_service/io_service.html" title="ssl::context_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__context_service/load_verify_file.html" title="ssl::context_service::load_verify_file"><span class="bold"><strong>load_verify_file</strong></span></a>
</p>
</td>
<td>
<p>
Load a certification authority file for performing verification.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ssl__context_service/null.html" title="ssl::context_service::null"><span class="bold"><strong>null</strong></span></a>
</p>
</td>
<td>
<p>
Return a null context implementation.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ssl__context_service/set_options.html" title="ssl::context_service::set_options"><span class="bold"><strong>set_options</strong></span></a>
</p>
</td>
<td>
<p>
Set options on the context.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ssl__context_service/set_password_callback.html" title="ssl::context_service::set_password_callback"><span class="bold"><strong>set_password_callback</strong></span></a>
</p>
</td>
<td>
<p>
Set the password callback.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ssl__context_service/set_verify_mode.html" title="ssl::context_service::set_verify_mode"><span class="bold"><strong>set_verify_mode</strong></span></a>
</p>
</td>
<td>
<p>
Set peer verification mode.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ssl__context_service/shutdown_service.html" title="ssl::context_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__context_service/use_certificate_chain_file.html" title="ssl::context_service::use_certificate_chain_file"><span class="bold"><strong>use_certificate_chain_file</strong></span></a>
</p>
</td>
<td>
<p>
Use a certificate chain from a file.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ssl__context_service/use_certificate_file.html" title="ssl::context_service::use_certificate_file"><span class="bold"><strong>use_certificate_file</strong></span></a>
</p>
</td>
<td>
<p>
Use a certificate from a file.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ssl__context_service/use_private_key_file.html" title="ssl::context_service::use_private_key_file"><span class="bold"><strong>use_private_key_file</strong></span></a>
</p>
</td>
<td>
<p>
Use a private key from a file.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ssl__context_service/use_rsa_private_key_file.html" title="ssl::context_service::use_rsa_private_key_file"><span class="bold"><strong>use_rsa_private_key_file</strong></span></a>
</p>
</td>
<td>
<p>
Use an RSA private key from a file.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="ssl__context_service/use_tmp_dh_file.html" title="ssl::context_service::use_tmp_dh_file"><span class="bold"><strong>use_tmp_dh_file</strong></span></a>
</p>
</td>
<td>
<p>
Use the specified file to obtain the temporary Diffie-Hellman parameters.
</p>
</td>
</tr>
</tbody>
</table></div>
<a name="boost_asio.reference.ssl__context_service.data_members"></a><h5>
<a name="id1337646"></a>
<a class="link" href="ssl__context_service.html#boost_asio.reference.ssl__context_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__context_service/id.html" title="ssl::context_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__context_service.requirements"></a><h5>
<a name="id1337732"></a>
<a class="link" href="ssl__context_service.html#boost_asio.reference.ssl__context_service.requirements">Requirements</a>
</h5>
<p>
<span class="bold"><strong>Header: </strong></span><code class="literal">boost/asio/ssl/context_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 &#169; 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__context_base/_context_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__context_service/add_verify_path.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>