Adds asio library and Storage Module

This commit is contained in:
Suraxius committed 2020-12-01 22:41:04 +01:00
1 parent 79a6ee5779
commit 30439acd43
4869 files changed
+618801 -903

No files matched your search

@@ -0,0 +1,51 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ssl::stream::~stream</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../index.html" title="Asio">
<link rel="up" href="../ssl__stream.html" title="ssl::stream">
<link rel="prev" href="write_some/overload2.html" title="ssl::stream::write_some (2 of 2 overloads)">
<link rel="next" href="../ssl__stream__impl_struct.html" title="ssl::stream::impl_struct">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="write_some/overload2.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../ssl__stream.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="../ssl__stream__impl_struct.html"><img src="../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="asio.reference.ssl__stream._stream"></a><a class="link" href="_stream.html" title="ssl::stream::~stream">ssl::stream::~stream</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.ssl__stream._stream"></a>
Destructor.
</p>
<pre class="programlisting">~stream();
</pre>
<h6>
<a name="asio.reference.ssl__stream._stream.h0"></a>
<span><a name="asio.reference.ssl__stream._stream.remarks"></a></span><a class="link" href="_stream.html#asio.reference.ssl__stream._stream.remarks">Remarks</a>
</h6>
<p>
A <code class="computeroutput">stream</code> object must not be destroyed while there are pending
asynchronous operations associated with it.
</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-2020 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="write_some/overload2.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../ssl__stream.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="../ssl__stream__impl_struct.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,58 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ssl::stream::async_handshake</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../index.html" title="Asio">
<link rel="up" href="../ssl__stream.html" title="ssl::stream">
<link rel="prev" href="../ssl__stream.html" title="ssl::stream">
<link rel="next" href="async_handshake/overload1.html" title="ssl::stream::async_handshake (1 of 2 overloads)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../ssl__stream.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../ssl__stream.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="async_handshake/overload1.html"><img src="../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="asio.reference.ssl__stream.async_handshake"></a><a class="link" href="async_handshake.html" title="ssl::stream::async_handshake">ssl::stream::async_handshake</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.ssl__stream.async_handshake"></a>
Start
an asynchronous SSL handshake.
</p>
<pre class="programlisting">template&lt;
typename <a class="link" href="../HandshakeHandler.html" title="SSL handshake handler requirements">HandshakeHandler</a> = <a class="link" href="../asynchronous_operations.html#asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>&gt;
<a class="link" href="../asynchronous_operations.html#asio.reference.asynchronous_operations.automatic_deduction_of_initiating_function_return_type"><span class="emphasis"><em>DEDUCED</em></span></a> <a class="link" href="async_handshake/overload1.html" title="ssl::stream::async_handshake (1 of 2 overloads)">async_handshake</a>(
handshake_type type,
HandshakeHandler &amp;&amp; handler = <a class="link" href="../asynchronous_operations.html#asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>);
<span class="emphasis"><em>» <a class="link" href="async_handshake/overload1.html" title="ssl::stream::async_handshake (1 of 2 overloads)">more...</a></em></span>
template&lt;
typename <a class="link" href="../ConstBufferSequence.html" title="Constant buffer sequence requirements">ConstBufferSequence</a>,
typename <a class="link" href="../BufferedHandshakeHandler.html" title="Buffered handshake handler requirements">BufferedHandshakeHandler</a> = <a class="link" href="../asynchronous_operations.html#asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>&gt;
<a class="link" href="../asynchronous_operations.html#asio.reference.asynchronous_operations.automatic_deduction_of_initiating_function_return_type"><span class="emphasis"><em>DEDUCED</em></span></a> <a class="link" href="async_handshake/overload2.html" title="ssl::stream::async_handshake (2 of 2 overloads)">async_handshake</a>(
handshake_type type,
const ConstBufferSequence &amp; buffers,
BufferedHandshakeHandler &amp;&amp; handler = <a class="link" href="../asynchronous_operations.html#asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>);
<span class="emphasis"><em>» <a class="link" href="async_handshake/overload2.html" title="ssl::stream::async_handshake (2 of 2 overloads)">more...</a></em></span>
</pre>
</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-2020 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.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../ssl__stream.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="async_handshake/overload1.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,79 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ssl::stream::async_handshake (1 of 2 overloads)</title>
<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../../index.html" title="Asio">
<link rel="up" href="../async_handshake.html" title="ssl::stream::async_handshake">
<link rel="prev" href="../async_handshake.html" title="ssl::stream::async_handshake">
<link rel="next" href="overload2.html" title="ssl::stream::async_handshake (2 of 2 overloads)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../async_handshake.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../async_handshake.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.ssl__stream.async_handshake.overload1"></a><a class="link" href="overload1.html" title="ssl::stream::async_handshake (1 of 2 overloads)">ssl::stream::async_handshake
(1 of 2 overloads)</a>
</h5></div></div></div>
<p>
Start an asynchronous SSL handshake.
</p>
<pre class="programlisting">template&lt;
typename <a class="link" href="../../HandshakeHandler.html" title="SSL handshake handler requirements">HandshakeHandler</a> = <a class="link" href="../../asynchronous_operations.html#asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>&gt;
<a class="link" href="../../asynchronous_operations.html#asio.reference.asynchronous_operations.automatic_deduction_of_initiating_function_return_type"><span class="emphasis"><em>DEDUCED</em></span></a> async_handshake(
handshake_type type,
HandshakeHandler &amp;&amp; handler = <a class="link" href="../../asynchronous_operations.html#asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>);
</pre>
<p>
This function is used to asynchronously perform an SSL handshake on the
stream. This function call always returns immediately.
</p>
<h6>
<a name="asio.reference.ssl__stream.async_handshake.overload1.h0"></a>
<span><a name="asio.reference.ssl__stream.async_handshake.overload1.parameters"></a></span><a class="link" href="overload1.html#asio.reference.ssl__stream.async_handshake.overload1.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">type</span></dt>
<dd><p>
The type of handshaking to be performed, i.e. as a client or as
a server.
</p></dd>
<dt><span class="term">handler</span></dt>
<dd>
<p>
The handler to be called when the handshake operation completes.
Copies will be made of the handler as required. The equivalent
function signature of the handler must be:
</p>
<pre class="programlisting">void handler(
const asio::error_code&amp; error // Result of operation.
);
</pre>
<p>
</p>
</dd>
</dl>
</div>
</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-2020 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="../async_handshake.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../async_handshake.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,89 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ssl::stream::async_handshake (2 of 2 overloads)</title>
<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../../index.html" title="Asio">
<link rel="up" href="../async_handshake.html" title="ssl::stream::async_handshake">
<link rel="prev" href="overload1.html" title="ssl::stream::async_handshake (1 of 2 overloads)">
<link rel="next" href="../async_read_some.html" title="ssl::stream::async_read_some">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="overload1.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../async_handshake.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="../async_read_some.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.ssl__stream.async_handshake.overload2"></a><a class="link" href="overload2.html" title="ssl::stream::async_handshake (2 of 2 overloads)">ssl::stream::async_handshake
(2 of 2 overloads)</a>
</h5></div></div></div>
<p>
Start an asynchronous SSL handshake.
</p>
<pre class="programlisting">template&lt;
typename <a class="link" href="../../ConstBufferSequence.html" title="Constant buffer sequence requirements">ConstBufferSequence</a>,
typename <a class="link" href="../../BufferedHandshakeHandler.html" title="Buffered handshake handler requirements">BufferedHandshakeHandler</a> = <a class="link" href="../../asynchronous_operations.html#asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>&gt;
<a class="link" href="../../asynchronous_operations.html#asio.reference.asynchronous_operations.automatic_deduction_of_initiating_function_return_type"><span class="emphasis"><em>DEDUCED</em></span></a> async_handshake(
handshake_type type,
const ConstBufferSequence &amp; buffers,
BufferedHandshakeHandler &amp;&amp; handler = <a class="link" href="../../asynchronous_operations.html#asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>);
</pre>
<p>
This function is used to asynchronously perform an SSL handshake on the
stream. This function call always returns immediately.
</p>
<h6>
<a name="asio.reference.ssl__stream.async_handshake.overload2.h0"></a>
<span><a name="asio.reference.ssl__stream.async_handshake.overload2.parameters"></a></span><a class="link" href="overload2.html#asio.reference.ssl__stream.async_handshake.overload2.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">type</span></dt>
<dd><p>
The type of handshaking to be performed, i.e. as a client or as
a server.
</p></dd>
<dt><span class="term">buffers</span></dt>
<dd><p>
The buffered data to be reused for the handshake. Although the
buffers object may be copied as necessary, ownership of the underlying
buffers is retained by the caller, which must guarantee that they
remain valid until the handler is called.
</p></dd>
<dt><span class="term">handler</span></dt>
<dd>
<p>
The handler to be called when the handshake operation completes.
Copies will be made of the handler as required. The equivalent
function signature of the handler must be:
</p>
<pre class="programlisting">void handler(
const asio::error_code&amp; error, // Result of operation.
std::size_t bytes_transferred // Amount of buffers used in handshake.
);
</pre>
<p>
</p>
</dd>
</dl>
</div>
</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-2020 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="overload1.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../async_handshake.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="../async_read_some.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,94 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ssl::stream::async_read_some</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../index.html" title="Asio">
<link rel="up" href="../ssl__stream.html" title="ssl::stream">
<link rel="prev" href="async_handshake/overload2.html" title="ssl::stream::async_handshake (2 of 2 overloads)">
<link rel="next" href="async_shutdown.html" title="ssl::stream::async_shutdown">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="async_handshake/overload2.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../ssl__stream.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="async_shutdown.html"><img src="../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="asio.reference.ssl__stream.async_read_some"></a><a class="link" href="async_read_some.html" title="ssl::stream::async_read_some">ssl::stream::async_read_some</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.ssl__stream.async_read_some"></a>
Start
an asynchronous read.
</p>
<pre class="programlisting">template&lt;
typename <a class="link" href="../MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a>,
typename <a class="link" href="../ReadHandler.html" title="Read handler requirements">ReadHandler</a> = <a class="link" href="../asynchronous_operations.html#asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>&gt;
<a class="link" href="../asynchronous_operations.html#asio.reference.asynchronous_operations.automatic_deduction_of_initiating_function_return_type"><span class="emphasis"><em>DEDUCED</em></span></a> async_read_some(
const MutableBufferSequence &amp; buffers,
ReadHandler &amp;&amp; handler = <a class="link" href="../asynchronous_operations.html#asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>);
</pre>
<p>
This function is used to asynchronously read one or more bytes of data
from the stream. The function call always returns immediately.
</p>
<h6>
<a name="asio.reference.ssl__stream.async_read_some.h0"></a>
<span><a name="asio.reference.ssl__stream.async_read_some.parameters"></a></span><a class="link" href="async_read_some.html#asio.reference.ssl__stream.async_read_some.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">buffers</span></dt>
<dd><p>
The buffers into which the data will be read. Although the buffers
object may be copied as necessary, ownership of the underlying buffers
is retained by the caller, which must guarantee that they remain
valid until the handler is called.
</p></dd>
<dt><span class="term">handler</span></dt>
<dd>
<p>
The handler to be called when the read operation completes. Copies
will be made of the handler as required. The equivalent function
signature of the handler must be:
</p>
<pre class="programlisting">void handler(
const asio::error_code&amp; error, // Result of operation.
std::size_t bytes_transferred // Number of bytes read.
);
</pre>
<p>
</p>
</dd>
</dl>
</div>
<h6>
<a name="asio.reference.ssl__stream.async_read_some.h1"></a>
<span><a name="asio.reference.ssl__stream.async_read_some.remarks"></a></span><a class="link" href="async_read_some.html#asio.reference.ssl__stream.async_read_some.remarks">Remarks</a>
</h6>
<p>
The async_read_some operation may not read all of the requested number
of bytes. Consider using the <a class="link" href="../async_read.html" title="async_read"><code class="computeroutput">async_read</code></a>
function if you need to ensure that the requested amount of data is read
before the asynchronous operation completes.
</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-2020 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="async_handshake/overload2.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../ssl__stream.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="async_shutdown.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,74 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ssl::stream::async_shutdown</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../index.html" title="Asio">
<link rel="up" href="../ssl__stream.html" title="ssl::stream">
<link rel="prev" href="async_read_some.html" title="ssl::stream::async_read_some">
<link rel="next" href="async_write_some.html" title="ssl::stream::async_write_some">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="async_read_some.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../ssl__stream.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="async_write_some.html"><img src="../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="asio.reference.ssl__stream.async_shutdown"></a><a class="link" href="async_shutdown.html" title="ssl::stream::async_shutdown">ssl::stream::async_shutdown</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.ssl__stream.async_shutdown"></a>
Asynchronously
shut down SSL on the stream.
</p>
<pre class="programlisting">template&lt;
typename <a class="link" href="../ShutdownHandler.html" title="SSL shutdown handler requirements">ShutdownHandler</a> = <a class="link" href="../asynchronous_operations.html#asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>&gt;
<a class="link" href="../asynchronous_operations.html#asio.reference.asynchronous_operations.automatic_deduction_of_initiating_function_return_type"><span class="emphasis"><em>DEDUCED</em></span></a> async_shutdown(
ShutdownHandler &amp;&amp; handler = <a class="link" href="../asynchronous_operations.html#asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>);
</pre>
<p>
This function is used to asynchronously shut down SSL on the stream. This
function call always returns immediately.
</p>
<h6>
<a name="asio.reference.ssl__stream.async_shutdown.h0"></a>
<span><a name="asio.reference.ssl__stream.async_shutdown.parameters"></a></span><a class="link" href="async_shutdown.html#asio.reference.ssl__stream.async_shutdown.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">handler</span></dt>
<dd>
<p>
The handler to be called when the handshake operation completes.
Copies will be made of the handler as required. The equivalent function
signature of the handler must be:
</p>
<pre class="programlisting">void handler(
const asio::error_code&amp; error // Result of operation.
);
</pre>
<p>
</p>
</dd>
</dl>
</div>
</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-2020 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="async_read_some.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../ssl__stream.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="async_write_some.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,94 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ssl::stream::async_write_some</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../index.html" title="Asio">
<link rel="up" href="../ssl__stream.html" title="ssl::stream">
<link rel="prev" href="async_shutdown.html" title="ssl::stream::async_shutdown">
<link rel="next" href="executor_type.html" title="ssl::stream::executor_type">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="async_shutdown.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../ssl__stream.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="executor_type.html"><img src="../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="asio.reference.ssl__stream.async_write_some"></a><a class="link" href="async_write_some.html" title="ssl::stream::async_write_some">ssl::stream::async_write_some</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.ssl__stream.async_write_some"></a>
Start
an asynchronous write.
</p>
<pre class="programlisting">template&lt;
typename <a class="link" href="../ConstBufferSequence.html" title="Constant buffer sequence requirements">ConstBufferSequence</a>,
typename <a class="link" href="../WriteHandler.html" title="Write handler requirements">WriteHandler</a> = <a class="link" href="../asynchronous_operations.html#asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>&gt;
<a class="link" href="../asynchronous_operations.html#asio.reference.asynchronous_operations.automatic_deduction_of_initiating_function_return_type"><span class="emphasis"><em>DEDUCED</em></span></a> async_write_some(
const ConstBufferSequence &amp; buffers,
WriteHandler &amp;&amp; handler = <a class="link" href="../asynchronous_operations.html#asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>);
</pre>
<p>
This function is used to asynchronously write one or more bytes of data
to the stream. The function call always returns immediately.
</p>
<h6>
<a name="asio.reference.ssl__stream.async_write_some.h0"></a>
<span><a name="asio.reference.ssl__stream.async_write_some.parameters"></a></span><a class="link" href="async_write_some.html#asio.reference.ssl__stream.async_write_some.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">buffers</span></dt>
<dd><p>
The data to be written to the stream. Although the buffers object
may be copied as necessary, ownership of the underlying buffers is
retained by the caller, which must guarantee that they remain valid
until the handler is called.
</p></dd>
<dt><span class="term">handler</span></dt>
<dd>
<p>
The handler to be called when the write operation completes. Copies
will be made of the handler as required. The equivalent function
signature of the handler must be:
</p>
<pre class="programlisting">void handler(
const asio::error_code&amp; error, // Result of operation.
std::size_t bytes_transferred // Number of bytes written.
);
</pre>
<p>
</p>
</dd>
</dl>
</div>
<h6>
<a name="asio.reference.ssl__stream.async_write_some.h1"></a>
<span><a name="asio.reference.ssl__stream.async_write_some.remarks"></a></span><a class="link" href="async_write_some.html#asio.reference.ssl__stream.async_write_some.remarks">Remarks</a>
</h6>
<p>
The async_write_some operation may not transmit all of the data to the
peer. Consider using the <a class="link" href="../async_write.html" title="async_write"><code class="computeroutput">async_write</code></a>
function if you need to ensure that all data is written before the asynchronous
operation completes.
</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-2020 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="async_shutdown.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../ssl__stream.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="executor_type.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,54 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ssl::stream::executor_type</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../index.html" title="Asio">
<link rel="up" href="../ssl__stream.html" title="ssl::stream">
<link rel="prev" href="async_write_some.html" title="ssl::stream::async_write_some">
<link rel="next" href="get_executor.html" title="ssl::stream::get_executor">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="async_write_some.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../ssl__stream.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="get_executor.html"><img src="../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="asio.reference.ssl__stream.executor_type"></a><a class="link" href="executor_type.html" title="ssl::stream::executor_type">ssl::stream::executor_type</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.ssl__stream.executor_type"></a>
The type
of the executor associated with the object.
</p>
<pre class="programlisting">typedef lowest_layer_type::executor_type executor_type;
</pre>
<h6>
<a name="asio.reference.ssl__stream.executor_type.h0"></a>
<span><a name="asio.reference.ssl__stream.executor_type.requirements"></a></span><a class="link" href="executor_type.html#asio.reference.ssl__stream.executor_type.requirements">Requirements</a>
</h6>
<p>
<span class="emphasis"><em>Header: </em></span><code class="literal">asio/ssl/stream.hpp</code>
</p>
<p>
<span class="emphasis"><em>Convenience header: </em></span><code class="literal">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-2020 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="async_write_some.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../ssl__stream.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="get_executor.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,55 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ssl::stream::get_executor</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../index.html" title="Asio">
<link rel="up" href="../ssl__stream.html" title="ssl::stream">
<link rel="prev" href="executor_type.html" title="ssl::stream::executor_type">
<link rel="next" href="handshake.html" title="ssl::stream::handshake">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="executor_type.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../ssl__stream.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="handshake.html"><img src="../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="asio.reference.ssl__stream.get_executor"></a><a class="link" href="get_executor.html" title="ssl::stream::get_executor">ssl::stream::get_executor</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.ssl__stream.get_executor"></a>
Get the executor
associated with the object.
</p>
<pre class="programlisting">executor_type get_executor();
</pre>
<p>
This function may be used to obtain the executor object that the stream
uses to dispatch handlers for asynchronous operations.
</p>
<h6>
<a name="asio.reference.ssl__stream.get_executor.h0"></a>
<span><a name="asio.reference.ssl__stream.get_executor.return_value"></a></span><a class="link" href="get_executor.html#asio.reference.ssl__stream.get_executor.return_value">Return Value</a>
</h6>
<p>
A copy of the executor that stream will use to dispatch handlers.
</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-2020 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="executor_type.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../ssl__stream.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="handshake.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,65 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ssl::stream::handshake</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../index.html" title="Asio">
<link rel="up" href="../ssl__stream.html" title="ssl::stream">
<link rel="prev" href="get_executor.html" title="ssl::stream::get_executor">
<link rel="next" href="handshake/overload1.html" title="ssl::stream::handshake (1 of 4 overloads)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="get_executor.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../ssl__stream.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="handshake/overload1.html"><img src="../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="asio.reference.ssl__stream.handshake"></a><a class="link" href="handshake.html" title="ssl::stream::handshake">ssl::stream::handshake</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.ssl__stream.handshake"></a>
Perform SSL handshaking.
</p>
<pre class="programlisting">void <a class="link" href="handshake/overload1.html" title="ssl::stream::handshake (1 of 4 overloads)">handshake</a>(
handshake_type type);
<span class="emphasis"><em>» <a class="link" href="handshake/overload1.html" title="ssl::stream::handshake (1 of 4 overloads)">more...</a></em></span>
void <a class="link" href="handshake/overload2.html" title="ssl::stream::handshake (2 of 4 overloads)">handshake</a>(
handshake_type type,
asio::error_code &amp; ec);
<span class="emphasis"><em>» <a class="link" href="handshake/overload2.html" title="ssl::stream::handshake (2 of 4 overloads)">more...</a></em></span>
template&lt;
typename <a class="link" href="../ConstBufferSequence.html" title="Constant buffer sequence requirements">ConstBufferSequence</a>&gt;
void <a class="link" href="handshake/overload3.html" title="ssl::stream::handshake (3 of 4 overloads)">handshake</a>(
handshake_type type,
const ConstBufferSequence &amp; buffers);
<span class="emphasis"><em>» <a class="link" href="handshake/overload3.html" title="ssl::stream::handshake (3 of 4 overloads)">more...</a></em></span>
template&lt;
typename <a class="link" href="../ConstBufferSequence.html" title="Constant buffer sequence requirements">ConstBufferSequence</a>&gt;
void <a class="link" href="handshake/overload4.html" title="ssl::stream::handshake (4 of 4 overloads)">handshake</a>(
handshake_type type,
const ConstBufferSequence &amp; buffers,
asio::error_code &amp; ec);
<span class="emphasis"><em>» <a class="link" href="handshake/overload4.html" title="ssl::stream::handshake (4 of 4 overloads)">more...</a></em></span>
</pre>
</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-2020 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="get_executor.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../ssl__stream.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="handshake/overload1.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,75 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ssl::stream::handshake (1 of 4 overloads)</title>
<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../../index.html" title="Asio">
<link rel="up" href="../handshake.html" title="ssl::stream::handshake">
<link rel="prev" href="../handshake.html" title="ssl::stream::handshake">
<link rel="next" href="overload2.html" title="ssl::stream::handshake (2 of 4 overloads)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../handshake.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../handshake.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.ssl__stream.handshake.overload1"></a><a class="link" href="overload1.html" title="ssl::stream::handshake (1 of 4 overloads)">ssl::stream::handshake
(1 of 4 overloads)</a>
</h5></div></div></div>
<p>
Perform SSL handshaking.
</p>
<pre class="programlisting">void handshake(
handshake_type type);
</pre>
<p>
This function is used to perform SSL handshaking on the stream. The function
call will block until handshaking is complete or an error occurs.
</p>
<h6>
<a name="asio.reference.ssl__stream.handshake.overload1.h0"></a>
<span><a name="asio.reference.ssl__stream.handshake.overload1.parameters"></a></span><a class="link" href="overload1.html#asio.reference.ssl__stream.handshake.overload1.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">type</span></dt>
<dd><p>
The type of handshaking to be performed, i.e. as a client or as
a server.
</p></dd>
</dl>
</div>
<h6>
<a name="asio.reference.ssl__stream.handshake.overload1.h1"></a>
<span><a name="asio.reference.ssl__stream.handshake.overload1.exceptions"></a></span><a class="link" href="overload1.html#asio.reference.ssl__stream.handshake.overload1.exceptions">Exceptions</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">asio::system_error</span></dt>
<dd><p>
Thrown on failure.
</p></dd>
</dl>
</div>
</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-2020 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="../handshake.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../handshake.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,67 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ssl::stream::handshake (2 of 4 overloads)</title>
<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../../index.html" title="Asio">
<link rel="up" href="../handshake.html" title="ssl::stream::handshake">
<link rel="prev" href="overload1.html" title="ssl::stream::handshake (1 of 4 overloads)">
<link rel="next" href="overload3.html" title="ssl::stream::handshake (3 of 4 overloads)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="overload1.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../handshake.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="overload3.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.ssl__stream.handshake.overload2"></a><a class="link" href="overload2.html" title="ssl::stream::handshake (2 of 4 overloads)">ssl::stream::handshake
(2 of 4 overloads)</a>
</h5></div></div></div>
<p>
Perform SSL handshaking.
</p>
<pre class="programlisting">void handshake(
handshake_type type,
asio::error_code &amp; ec);
</pre>
<p>
This function is used to perform SSL handshaking on the stream. The function
call will block until handshaking is complete or an error occurs.
</p>
<h6>
<a name="asio.reference.ssl__stream.handshake.overload2.h0"></a>
<span><a name="asio.reference.ssl__stream.handshake.overload2.parameters"></a></span><a class="link" href="overload2.html#asio.reference.ssl__stream.handshake.overload2.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">type</span></dt>
<dd><p>
The type of handshaking to be performed, i.e. as a client or as
a server.
</p></dd>
<dt><span class="term">ec</span></dt>
<dd><p>
Set to indicate what error occurred, if any.
</p></dd>
</dl>
</div>
</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-2020 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="overload1.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../handshake.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="overload3.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,82 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ssl::stream::handshake (3 of 4 overloads)</title>
<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../../index.html" title="Asio">
<link rel="up" href="../handshake.html" title="ssl::stream::handshake">
<link rel="prev" href="overload2.html" title="ssl::stream::handshake (2 of 4 overloads)">
<link rel="next" href="overload4.html" title="ssl::stream::handshake (4 of 4 overloads)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="overload2.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../handshake.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="overload4.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.ssl__stream.handshake.overload3"></a><a class="link" href="overload3.html" title="ssl::stream::handshake (3 of 4 overloads)">ssl::stream::handshake
(3 of 4 overloads)</a>
</h5></div></div></div>
<p>
Perform SSL handshaking.
</p>
<pre class="programlisting">template&lt;
typename <a class="link" href="../../ConstBufferSequence.html" title="Constant buffer sequence requirements">ConstBufferSequence</a>&gt;
void handshake(
handshake_type type,
const ConstBufferSequence &amp; buffers);
</pre>
<p>
This function is used to perform SSL handshaking on the stream. The function
call will block until handshaking is complete or an error occurs.
</p>
<h6>
<a name="asio.reference.ssl__stream.handshake.overload3.h0"></a>
<span><a name="asio.reference.ssl__stream.handshake.overload3.parameters"></a></span><a class="link" href="overload3.html#asio.reference.ssl__stream.handshake.overload3.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">type</span></dt>
<dd><p>
The type of handshaking to be performed, i.e. as a client or as
a server.
</p></dd>
<dt><span class="term">buffers</span></dt>
<dd><p>
The buffered data to be reused for the handshake.
</p></dd>
</dl>
</div>
<h6>
<a name="asio.reference.ssl__stream.handshake.overload3.h1"></a>
<span><a name="asio.reference.ssl__stream.handshake.overload3.exceptions"></a></span><a class="link" href="overload3.html#asio.reference.ssl__stream.handshake.overload3.exceptions">Exceptions</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">asio::system_error</span></dt>
<dd><p>
Thrown on failure.
</p></dd>
</dl>
</div>
</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-2020 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="overload2.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../handshake.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="overload4.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,74 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ssl::stream::handshake (4 of 4 overloads)</title>
<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../../index.html" title="Asio">
<link rel="up" href="../handshake.html" title="ssl::stream::handshake">
<link rel="prev" href="overload3.html" title="ssl::stream::handshake (3 of 4 overloads)">
<link rel="next" href="../handshake_type.html" title="ssl::stream::handshake_type">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="overload3.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../handshake.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="../handshake_type.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.ssl__stream.handshake.overload4"></a><a class="link" href="overload4.html" title="ssl::stream::handshake (4 of 4 overloads)">ssl::stream::handshake
(4 of 4 overloads)</a>
</h5></div></div></div>
<p>
Perform SSL handshaking.
</p>
<pre class="programlisting">template&lt;
typename <a class="link" href="../../ConstBufferSequence.html" title="Constant buffer sequence requirements">ConstBufferSequence</a>&gt;
void handshake(
handshake_type type,
const ConstBufferSequence &amp; buffers,
asio::error_code &amp; ec);
</pre>
<p>
This function is used to perform SSL handshaking on the stream. The function
call will block until handshaking is complete or an error occurs.
</p>
<h6>
<a name="asio.reference.ssl__stream.handshake.overload4.h0"></a>
<span><a name="asio.reference.ssl__stream.handshake.overload4.parameters"></a></span><a class="link" href="overload4.html#asio.reference.ssl__stream.handshake.overload4.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">type</span></dt>
<dd><p>
The type of handshaking to be performed, i.e. as a client or as
a server.
</p></dd>
<dt><span class="term">buffers</span></dt>
<dd><p>
The buffered data to be reused for the handshake.
</p></dd>
<dt><span class="term">ec</span></dt>
<dd><p>
Set to indicate what error occurred, if any.
</p></dd>
</dl>
</div>
</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-2020 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="overload3.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../handshake.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="../handshake_type.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,65 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ssl::stream::handshake_type</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../index.html" title="Asio">
<link rel="up" href="../ssl__stream.html" title="ssl::stream">
<link rel="prev" href="handshake/overload4.html" title="ssl::stream::handshake (4 of 4 overloads)">
<link rel="next" href="lowest_layer.html" title="ssl::stream::lowest_layer">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="handshake/overload4.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../ssl__stream.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="lowest_layer.html"><img src="../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="asio.reference.ssl__stream.handshake_type"></a><a class="link" href="handshake_type.html" title="ssl::stream::handshake_type">ssl::stream::handshake_type</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.ssl__stream.handshake_type"></a>
Different
handshake types.
</p>
<pre class="programlisting">enum handshake_type
</pre>
<p>
<a class="indexterm" name="asio.indexterm.ssl__stream.handshake_type.client"></a>
<a class="indexterm" name="asio.indexterm.ssl__stream.handshake_type.server"></a>
</p>
<h6>
<a name="asio.reference.ssl__stream.handshake_type.h0"></a>
<span><a name="asio.reference.ssl__stream.handshake_type.values"></a></span><a class="link" href="handshake_type.html#asio.reference.ssl__stream.handshake_type.values">Values</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">client</span></dt>
<dd><p>
Perform handshaking as a client.
</p></dd>
<dt><span class="term">server</span></dt>
<dd><p>
Perform handshaking as a server.
</p></dd>
</dl>
</div>
</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-2020 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="handshake/overload4.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../ssl__stream.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="lowest_layer.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,48 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ssl::stream::lowest_layer</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../index.html" title="Asio">
<link rel="up" href="../ssl__stream.html" title="ssl::stream">
<link rel="prev" href="handshake_type.html" title="ssl::stream::handshake_type">
<link rel="next" href="lowest_layer/overload1.html" title="ssl::stream::lowest_layer (1 of 2 overloads)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="handshake_type.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../ssl__stream.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="lowest_layer/overload1.html"><img src="../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="asio.reference.ssl__stream.lowest_layer"></a><a class="link" href="lowest_layer.html" title="ssl::stream::lowest_layer">ssl::stream::lowest_layer</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.ssl__stream.lowest_layer"></a>
Get a reference
to the lowest layer.
</p>
<pre class="programlisting">lowest_layer_type &amp; <a class="link" href="lowest_layer/overload1.html" title="ssl::stream::lowest_layer (1 of 2 overloads)">lowest_layer</a>();
<span class="emphasis"><em>» <a class="link" href="lowest_layer/overload1.html" title="ssl::stream::lowest_layer (1 of 2 overloads)">more...</a></em></span>
const lowest_layer_type &amp; <a class="link" href="lowest_layer/overload2.html" title="ssl::stream::lowest_layer (2 of 2 overloads)">lowest_layer</a>() const;
<span class="emphasis"><em>» <a class="link" href="lowest_layer/overload2.html" title="ssl::stream::lowest_layer (2 of 2 overloads)">more...</a></em></span>
</pre>
</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-2020 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="handshake_type.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../ssl__stream.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="lowest_layer/overload1.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,56 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ssl::stream::lowest_layer (1 of 2 overloads)</title>
<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../../index.html" title="Asio">
<link rel="up" href="../lowest_layer.html" title="ssl::stream::lowest_layer">
<link rel="prev" href="../lowest_layer.html" title="ssl::stream::lowest_layer">
<link rel="next" href="overload2.html" title="ssl::stream::lowest_layer (2 of 2 overloads)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../lowest_layer.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../lowest_layer.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.ssl__stream.lowest_layer.overload1"></a><a class="link" href="overload1.html" title="ssl::stream::lowest_layer (1 of 2 overloads)">ssl::stream::lowest_layer
(1 of 2 overloads)</a>
</h5></div></div></div>
<p>
Get a reference to the lowest layer.
</p>
<pre class="programlisting">lowest_layer_type &amp; lowest_layer();
</pre>
<p>
This function returns a reference to the lowest layer in a stack of stream
layers.
</p>
<h6>
<a name="asio.reference.ssl__stream.lowest_layer.overload1.h0"></a>
<span><a name="asio.reference.ssl__stream.lowest_layer.overload1.return_value"></a></span><a class="link" href="overload1.html#asio.reference.ssl__stream.lowest_layer.overload1.return_value">Return
Value</a>
</h6>
<p>
A reference to the lowest layer in the stack of stream layers. Ownership
is not transferred to the caller.
</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-2020 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="../lowest_layer.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../lowest_layer.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,56 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ssl::stream::lowest_layer (2 of 2 overloads)</title>
<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../../index.html" title="Asio">
<link rel="up" href="../lowest_layer.html" title="ssl::stream::lowest_layer">
<link rel="prev" href="overload1.html" title="ssl::stream::lowest_layer (1 of 2 overloads)">
<link rel="next" href="../lowest_layer_type.html" title="ssl::stream::lowest_layer_type">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="overload1.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../lowest_layer.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="../lowest_layer_type.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.ssl__stream.lowest_layer.overload2"></a><a class="link" href="overload2.html" title="ssl::stream::lowest_layer (2 of 2 overloads)">ssl::stream::lowest_layer
(2 of 2 overloads)</a>
</h5></div></div></div>
<p>
Get a reference to the lowest layer.
</p>
<pre class="programlisting">const lowest_layer_type &amp; lowest_layer() const;
</pre>
<p>
This function returns a reference to the lowest layer in a stack of stream
layers.
</p>
<h6>
<a name="asio.reference.ssl__stream.lowest_layer.overload2.h0"></a>
<span><a name="asio.reference.ssl__stream.lowest_layer.overload2.return_value"></a></span><a class="link" href="overload2.html#asio.reference.ssl__stream.lowest_layer.overload2.return_value">Return
Value</a>
</h6>
<p>
A reference to the lowest layer in the stack of stream layers. Ownership
is not transferred to the caller.
</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-2020 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="overload1.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../lowest_layer.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="../lowest_layer_type.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,54 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ssl::stream::lowest_layer_type</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../index.html" title="Asio">
<link rel="up" href="../ssl__stream.html" title="ssl::stream">
<link rel="prev" href="lowest_layer/overload2.html" title="ssl::stream::lowest_layer (2 of 2 overloads)">
<link rel="next" href="native_handle.html" title="ssl::stream::native_handle">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="lowest_layer/overload2.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../ssl__stream.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="native_handle.html"><img src="../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="asio.reference.ssl__stream.lowest_layer_type"></a><a class="link" href="lowest_layer_type.html" title="ssl::stream::lowest_layer_type">ssl::stream::lowest_layer_type</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.ssl__stream.lowest_layer_type"></a>
The
type of the lowest layer.
</p>
<pre class="programlisting">typedef next_layer_type::lowest_layer_type lowest_layer_type;
</pre>
<h6>
<a name="asio.reference.ssl__stream.lowest_layer_type.h0"></a>
<span><a name="asio.reference.ssl__stream.lowest_layer_type.requirements"></a></span><a class="link" href="lowest_layer_type.html#asio.reference.ssl__stream.lowest_layer_type.requirements">Requirements</a>
</h6>
<p>
<span class="emphasis"><em>Header: </em></span><code class="literal">asio/ssl/stream.hpp</code>
</p>
<p>
<span class="emphasis"><em>Convenience header: </em></span><code class="literal">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-2020 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="lowest_layer/overload2.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../ssl__stream.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="native_handle.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,70 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ssl::stream::native_handle</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../index.html" title="Asio">
<link rel="up" href="../ssl__stream.html" title="ssl::stream">
<link rel="prev" href="lowest_layer_type.html" title="ssl::stream::lowest_layer_type">
<link rel="next" href="native_handle_type.html" title="ssl::stream::native_handle_type">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="lowest_layer_type.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../ssl__stream.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="native_handle_type.html"><img src="../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="asio.reference.ssl__stream.native_handle"></a><a class="link" href="native_handle.html" title="ssl::stream::native_handle">ssl::stream::native_handle</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.ssl__stream.native_handle"></a>
Get the
underlying implementation in the native type.
</p>
<pre class="programlisting">native_handle_type native_handle();
</pre>
<p>
This function may be used to obtain the underlying implementation of the
context. This is intended to allow access to context functionality that
is not otherwise provided.
</p>
<h6>
<a name="asio.reference.ssl__stream.native_handle.h0"></a>
<span><a name="asio.reference.ssl__stream.native_handle.example"></a></span><a class="link" href="native_handle.html#asio.reference.ssl__stream.native_handle.example">Example</a>
</h6>
<p>
The <code class="computeroutput">native_handle()</code> function returns a pointer of type <code class="computeroutput">SSL*</code>
that is suitable for passing to functions such as <code class="computeroutput">SSL_get_verify_result</code>
and <code class="computeroutput">SSL_get_peer_certificate:</code>
</p>
<pre class="programlisting">asio::ssl::stream&lt;asio:ip::tcp::socket&gt; sock(my_context, ctx);
// ... establish connection and perform handshake ...
if (X509* cert = SSL_get_peer_certificate(sock.native_handle()))
{
if (SSL_get_verify_result(sock.native_handle()) == X509_V_OK)
{
// ...
}
}
</pre>
</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-2020 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="lowest_layer_type.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../ssl__stream.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="native_handle_type.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,54 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ssl::stream::native_handle_type</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../index.html" title="Asio">
<link rel="up" href="../ssl__stream.html" title="ssl::stream">
<link rel="prev" href="native_handle.html" title="ssl::stream::native_handle">
<link rel="next" href="next_layer.html" title="ssl::stream::next_layer">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="native_handle.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../ssl__stream.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="next_layer.html"><img src="../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="asio.reference.ssl__stream.native_handle_type"></a><a class="link" href="native_handle_type.html" title="ssl::stream::native_handle_type">ssl::stream::native_handle_type</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.ssl__stream.native_handle_type"></a>
The
native handle type of the SSL stream.
</p>
<pre class="programlisting">typedef SSL * native_handle_type;
</pre>
<h6>
<a name="asio.reference.ssl__stream.native_handle_type.h0"></a>
<span><a name="asio.reference.ssl__stream.native_handle_type.requirements"></a></span><a class="link" href="native_handle_type.html#asio.reference.ssl__stream.native_handle_type.requirements">Requirements</a>
</h6>
<p>
<span class="emphasis"><em>Header: </em></span><code class="literal">asio/ssl/stream.hpp</code>
</p>
<p>
<span class="emphasis"><em>Convenience header: </em></span><code class="literal">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-2020 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="native_handle.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../ssl__stream.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="next_layer.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,48 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ssl::stream::next_layer</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../index.html" title="Asio">
<link rel="up" href="../ssl__stream.html" title="ssl::stream">
<link rel="prev" href="native_handle_type.html" title="ssl::stream::native_handle_type">
<link rel="next" href="next_layer/overload1.html" title="ssl::stream::next_layer (1 of 2 overloads)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="native_handle_type.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../ssl__stream.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="next_layer/overload1.html"><img src="../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="asio.reference.ssl__stream.next_layer"></a><a class="link" href="next_layer.html" title="ssl::stream::next_layer">ssl::stream::next_layer</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.ssl__stream.next_layer"></a>
Get a reference
to the next layer.
</p>
<pre class="programlisting">const next_layer_type &amp; <a class="link" href="next_layer/overload1.html" title="ssl::stream::next_layer (1 of 2 overloads)">next_layer</a>() const;
<span class="emphasis"><em>» <a class="link" href="next_layer/overload1.html" title="ssl::stream::next_layer (1 of 2 overloads)">more...</a></em></span>
next_layer_type &amp; <a class="link" href="next_layer/overload2.html" title="ssl::stream::next_layer (2 of 2 overloads)">next_layer</a>();
<span class="emphasis"><em>» <a class="link" href="next_layer/overload2.html" title="ssl::stream::next_layer (2 of 2 overloads)">more...</a></em></span>
</pre>
</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-2020 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="native_handle_type.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../ssl__stream.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="next_layer/overload1.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,56 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ssl::stream::next_layer (1 of 2 overloads)</title>
<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../../index.html" title="Asio">
<link rel="up" href="../next_layer.html" title="ssl::stream::next_layer">
<link rel="prev" href="../next_layer.html" title="ssl::stream::next_layer">
<link rel="next" href="overload2.html" title="ssl::stream::next_layer (2 of 2 overloads)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../next_layer.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../next_layer.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.ssl__stream.next_layer.overload1"></a><a class="link" href="overload1.html" title="ssl::stream::next_layer (1 of 2 overloads)">ssl::stream::next_layer
(1 of 2 overloads)</a>
</h5></div></div></div>
<p>
Get a reference to the next layer.
</p>
<pre class="programlisting">const next_layer_type &amp; next_layer() const;
</pre>
<p>
This function returns a reference to the next layer in a stack of stream
layers.
</p>
<h6>
<a name="asio.reference.ssl__stream.next_layer.overload1.h0"></a>
<span><a name="asio.reference.ssl__stream.next_layer.overload1.return_value"></a></span><a class="link" href="overload1.html#asio.reference.ssl__stream.next_layer.overload1.return_value">Return
Value</a>
</h6>
<p>
A reference to the next layer in the stack of stream layers. Ownership
is not transferred to the caller.
</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-2020 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="../next_layer.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../next_layer.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,56 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ssl::stream::next_layer (2 of 2 overloads)</title>
<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../../index.html" title="Asio">
<link rel="up" href="../next_layer.html" title="ssl::stream::next_layer">
<link rel="prev" href="overload1.html" title="ssl::stream::next_layer (1 of 2 overloads)">
<link rel="next" href="../next_layer_type.html" title="ssl::stream::next_layer_type">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="overload1.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../next_layer.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="../next_layer_type.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.ssl__stream.next_layer.overload2"></a><a class="link" href="overload2.html" title="ssl::stream::next_layer (2 of 2 overloads)">ssl::stream::next_layer
(2 of 2 overloads)</a>
</h5></div></div></div>
<p>
Get a reference to the next layer.
</p>
<pre class="programlisting">next_layer_type &amp; next_layer();
</pre>
<p>
This function returns a reference to the next layer in a stack of stream
layers.
</p>
<h6>
<a name="asio.reference.ssl__stream.next_layer.overload2.h0"></a>
<span><a name="asio.reference.ssl__stream.next_layer.overload2.return_value"></a></span><a class="link" href="overload2.html#asio.reference.ssl__stream.next_layer.overload2.return_value">Return
Value</a>
</h6>
<p>
A reference to the next layer in the stack of stream layers. Ownership
is not transferred to the caller.
</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-2020 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="overload1.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../next_layer.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="../next_layer_type.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,54 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ssl::stream::next_layer_type</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../index.html" title="Asio">
<link rel="up" href="../ssl__stream.html" title="ssl::stream">
<link rel="prev" href="next_layer/overload2.html" title="ssl::stream::next_layer (2 of 2 overloads)">
<link rel="next" href="read_some.html" title="ssl::stream::read_some">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="next_layer/overload2.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../ssl__stream.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="read_some.html"><img src="../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="asio.reference.ssl__stream.next_layer_type"></a><a class="link" href="next_layer_type.html" title="ssl::stream::next_layer_type">ssl::stream::next_layer_type</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.ssl__stream.next_layer_type"></a>
The
type of the next layer.
</p>
<pre class="programlisting">typedef remove_reference&lt; Stream &gt;::type next_layer_type;
</pre>
<h6>
<a name="asio.reference.ssl__stream.next_layer_type.h0"></a>
<span><a name="asio.reference.ssl__stream.next_layer_type.requirements"></a></span><a class="link" href="next_layer_type.html#asio.reference.ssl__stream.next_layer_type.requirements">Requirements</a>
</h6>
<p>
<span class="emphasis"><em>Header: </em></span><code class="literal">asio/ssl/stream.hpp</code>
</p>
<p>
<span class="emphasis"><em>Convenience header: </em></span><code class="literal">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-2020 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="next_layer/overload2.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../ssl__stream.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="read_some.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,55 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ssl::stream::read_some</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../index.html" title="Asio">
<link rel="up" href="../ssl__stream.html" title="ssl::stream">
<link rel="prev" href="next_layer_type.html" title="ssl::stream::next_layer_type">
<link rel="next" href="read_some/overload1.html" title="ssl::stream::read_some (1 of 2 overloads)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="next_layer_type.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../ssl__stream.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="read_some/overload1.html"><img src="../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="asio.reference.ssl__stream.read_some"></a><a class="link" href="read_some.html" title="ssl::stream::read_some">ssl::stream::read_some</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.ssl__stream.read_some"></a>
Read some data
from the stream.
</p>
<pre class="programlisting">template&lt;
typename <a class="link" href="../MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a>&gt;
std::size_t <a class="link" href="read_some/overload1.html" title="ssl::stream::read_some (1 of 2 overloads)">read_some</a>(
const MutableBufferSequence &amp; buffers);
<span class="emphasis"><em>» <a class="link" href="read_some/overload1.html" title="ssl::stream::read_some (1 of 2 overloads)">more...</a></em></span>
template&lt;
typename <a class="link" href="../MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a>&gt;
std::size_t <a class="link" href="read_some/overload2.html" title="ssl::stream::read_some (2 of 2 overloads)">read_some</a>(
const MutableBufferSequence &amp; buffers,
asio::error_code &amp; ec);
<span class="emphasis"><em>» <a class="link" href="read_some/overload2.html" title="ssl::stream::read_some (2 of 2 overloads)">more...</a></em></span>
</pre>
</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-2020 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="next_layer_type.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../ssl__stream.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="read_some/overload1.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,95 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ssl::stream::read_some (1 of 2 overloads)</title>
<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../../index.html" title="Asio">
<link rel="up" href="../read_some.html" title="ssl::stream::read_some">
<link rel="prev" href="../read_some.html" title="ssl::stream::read_some">
<link rel="next" href="overload2.html" title="ssl::stream::read_some (2 of 2 overloads)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../read_some.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../read_some.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.ssl__stream.read_some.overload1"></a><a class="link" href="overload1.html" title="ssl::stream::read_some (1 of 2 overloads)">ssl::stream::read_some
(1 of 2 overloads)</a>
</h5></div></div></div>
<p>
Read some data from the stream.
</p>
<pre class="programlisting">template&lt;
typename <a class="link" href="../../MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a>&gt;
std::size_t read_some(
const MutableBufferSequence &amp; buffers);
</pre>
<p>
This function is used to read data from the stream. The function call
will block until one or more bytes of data has been read successfully,
or until an error occurs.
</p>
<h6>
<a name="asio.reference.ssl__stream.read_some.overload1.h0"></a>
<span><a name="asio.reference.ssl__stream.read_some.overload1.parameters"></a></span><a class="link" href="overload1.html#asio.reference.ssl__stream.read_some.overload1.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">buffers</span></dt>
<dd><p>
The buffers into which the data will be read.
</p></dd>
</dl>
</div>
<h6>
<a name="asio.reference.ssl__stream.read_some.overload1.h1"></a>
<span><a name="asio.reference.ssl__stream.read_some.overload1.return_value"></a></span><a class="link" href="overload1.html#asio.reference.ssl__stream.read_some.overload1.return_value">Return
Value</a>
</h6>
<p>
The number of bytes read.
</p>
<h6>
<a name="asio.reference.ssl__stream.read_some.overload1.h2"></a>
<span><a name="asio.reference.ssl__stream.read_some.overload1.exceptions"></a></span><a class="link" href="overload1.html#asio.reference.ssl__stream.read_some.overload1.exceptions">Exceptions</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">asio::system_error</span></dt>
<dd><p>
Thrown on failure.
</p></dd>
</dl>
</div>
<h6>
<a name="asio.reference.ssl__stream.read_some.overload1.h3"></a>
<span><a name="asio.reference.ssl__stream.read_some.overload1.remarks"></a></span><a class="link" href="overload1.html#asio.reference.ssl__stream.read_some.overload1.remarks">Remarks</a>
</h6>
<p>
The read_some operation may not read all of the requested number of bytes.
Consider using the <a class="link" href="../../read.html" title="read"><code class="computeroutput">read</code></a>
function if you need to ensure that the requested amount of data is read
before the blocking operation completes.
</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-2020 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="../read_some.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../read_some.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,87 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ssl::stream::read_some (2 of 2 overloads)</title>
<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../../index.html" title="Asio">
<link rel="up" href="../read_some.html" title="ssl::stream::read_some">
<link rel="prev" href="overload1.html" title="ssl::stream::read_some (1 of 2 overloads)">
<link rel="next" href="../set_verify_callback.html" title="ssl::stream::set_verify_callback">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="overload1.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../read_some.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="../set_verify_callback.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.ssl__stream.read_some.overload2"></a><a class="link" href="overload2.html" title="ssl::stream::read_some (2 of 2 overloads)">ssl::stream::read_some
(2 of 2 overloads)</a>
</h5></div></div></div>
<p>
Read some data from the stream.
</p>
<pre class="programlisting">template&lt;
typename <a class="link" href="../../MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a>&gt;
std::size_t read_some(
const MutableBufferSequence &amp; buffers,
asio::error_code &amp; ec);
</pre>
<p>
This function is used to read data from the stream. The function call
will block until one or more bytes of data has been read successfully,
or until an error occurs.
</p>
<h6>
<a name="asio.reference.ssl__stream.read_some.overload2.h0"></a>
<span><a name="asio.reference.ssl__stream.read_some.overload2.parameters"></a></span><a class="link" href="overload2.html#asio.reference.ssl__stream.read_some.overload2.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">buffers</span></dt>
<dd><p>
The buffers into which the data will be read.
</p></dd>
<dt><span class="term">ec</span></dt>
<dd><p>
Set to indicate what error occurred, if any.
</p></dd>
</dl>
</div>
<h6>
<a name="asio.reference.ssl__stream.read_some.overload2.h1"></a>
<span><a name="asio.reference.ssl__stream.read_some.overload2.return_value"></a></span><a class="link" href="overload2.html#asio.reference.ssl__stream.read_some.overload2.return_value">Return
Value</a>
</h6>
<p>
The number of bytes read. Returns 0 if an error occurred.
</p>
<h6>
<a name="asio.reference.ssl__stream.read_some.overload2.h2"></a>
<span><a name="asio.reference.ssl__stream.read_some.overload2.remarks"></a></span><a class="link" href="overload2.html#asio.reference.ssl__stream.read_some.overload2.remarks">Remarks</a>
</h6>
<p>
The read_some operation may not read all of the requested number of bytes.
Consider using the <a class="link" href="../../read.html" title="read"><code class="computeroutput">read</code></a>
function if you need to ensure that the requested amount of data is read
before the blocking operation completes.
</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-2020 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="overload1.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../read_some.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="../set_verify_callback.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,55 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ssl::stream::set_verify_callback</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../index.html" title="Asio">
<link rel="up" href="../ssl__stream.html" title="ssl::stream">
<link rel="prev" href="read_some/overload2.html" title="ssl::stream::read_some (2 of 2 overloads)">
<link rel="next" href="set_verify_callback/overload1.html" title="ssl::stream::set_verify_callback (1 of 2 overloads)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="read_some/overload2.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../ssl__stream.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="set_verify_callback/overload1.html"><img src="../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="asio.reference.ssl__stream.set_verify_callback"></a><a class="link" href="set_verify_callback.html" title="ssl::stream::set_verify_callback">ssl::stream::set_verify_callback</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.ssl__stream.set_verify_callback"></a>
Set
the callback used to verify peer certificates.
</p>
<pre class="programlisting">template&lt;
typename VerifyCallback&gt;
void <a class="link" href="set_verify_callback/overload1.html" title="ssl::stream::set_verify_callback (1 of 2 overloads)">set_verify_callback</a>(
VerifyCallback callback);
<span class="emphasis"><em>» <a class="link" href="set_verify_callback/overload1.html" title="ssl::stream::set_verify_callback (1 of 2 overloads)">more...</a></em></span>
template&lt;
typename VerifyCallback&gt;
void <a class="link" href="set_verify_callback/overload2.html" title="ssl::stream::set_verify_callback (2 of 2 overloads)">set_verify_callback</a>(
VerifyCallback callback,
asio::error_code &amp; ec);
<span class="emphasis"><em>» <a class="link" href="set_verify_callback/overload2.html" title="ssl::stream::set_verify_callback (2 of 2 overloads)">more...</a></em></span>
</pre>
</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-2020 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="read_some/overload2.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../ssl__stream.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="set_verify_callback/overload1.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,95 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ssl::stream::set_verify_callback (1 of 2 overloads)</title>
<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../../index.html" title="Asio">
<link rel="up" href="../set_verify_callback.html" title="ssl::stream::set_verify_callback">
<link rel="prev" href="../set_verify_callback.html" title="ssl::stream::set_verify_callback">
<link rel="next" href="overload2.html" title="ssl::stream::set_verify_callback (2 of 2 overloads)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../set_verify_callback.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../set_verify_callback.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.ssl__stream.set_verify_callback.overload1"></a><a class="link" href="overload1.html" title="ssl::stream::set_verify_callback (1 of 2 overloads)">ssl::stream::set_verify_callback
(1 of 2 overloads)</a>
</h5></div></div></div>
<p>
Set the callback used to verify peer certificates.
</p>
<pre class="programlisting">template&lt;
typename VerifyCallback&gt;
void set_verify_callback(
VerifyCallback callback);
</pre>
<p>
This function is used to specify a callback function that will be called
by the implementation when it needs to verify a peer certificate.
</p>
<h6>
<a name="asio.reference.ssl__stream.set_verify_callback.overload1.h0"></a>
<span><a name="asio.reference.ssl__stream.set_verify_callback.overload1.parameters"></a></span><a class="link" href="overload1.html#asio.reference.ssl__stream.set_verify_callback.overload1.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">callback</span></dt>
<dd>
<p>
The function object to be used for verifying a certificate. The
function signature of the handler must be:
</p>
<pre class="programlisting">bool verify_callback(
bool preverified, // True if the certificate passed pre-verification.
verify_context&amp; ctx // The peer certificate and other context.
);
</pre>
<p>
The return value of the callback is true if the certificate has
passed verification, false otherwise.
</p>
</dd>
</dl>
</div>
<h6>
<a name="asio.reference.ssl__stream.set_verify_callback.overload1.h1"></a>
<span><a name="asio.reference.ssl__stream.set_verify_callback.overload1.exceptions"></a></span><a class="link" href="overload1.html#asio.reference.ssl__stream.set_verify_callback.overload1.exceptions">Exceptions</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">asio::system_error</span></dt>
<dd><p>
Thrown on failure.
</p></dd>
</dl>
</div>
<h6>
<a name="asio.reference.ssl__stream.set_verify_callback.overload1.h2"></a>
<span><a name="asio.reference.ssl__stream.set_verify_callback.overload1.remarks"></a></span><a class="link" href="overload1.html#asio.reference.ssl__stream.set_verify_callback.overload1.remarks">Remarks</a>
</h6>
<p>
Calls <code class="computeroutput">SSL_set_verify</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-2020 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="../set_verify_callback.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../set_verify_callback.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,87 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ssl::stream::set_verify_callback (2 of 2 overloads)</title>
<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../../index.html" title="Asio">
<link rel="up" href="../set_verify_callback.html" title="ssl::stream::set_verify_callback">
<link rel="prev" href="overload1.html" title="ssl::stream::set_verify_callback (1 of 2 overloads)">
<link rel="next" href="../set_verify_depth.html" title="ssl::stream::set_verify_depth">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="overload1.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../set_verify_callback.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="../set_verify_depth.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.ssl__stream.set_verify_callback.overload2"></a><a class="link" href="overload2.html" title="ssl::stream::set_verify_callback (2 of 2 overloads)">ssl::stream::set_verify_callback
(2 of 2 overloads)</a>
</h5></div></div></div>
<p>
Set the callback used to verify peer certificates.
</p>
<pre class="programlisting">template&lt;
typename VerifyCallback&gt;
void set_verify_callback(
VerifyCallback callback,
asio::error_code &amp; ec);
</pre>
<p>
This function is used to specify a callback function that will be called
by the implementation when it needs to verify a peer certificate.
</p>
<h6>
<a name="asio.reference.ssl__stream.set_verify_callback.overload2.h0"></a>
<span><a name="asio.reference.ssl__stream.set_verify_callback.overload2.parameters"></a></span><a class="link" href="overload2.html#asio.reference.ssl__stream.set_verify_callback.overload2.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">callback</span></dt>
<dd>
<p>
The function object to be used for verifying a certificate. The
function signature of the handler must be:
</p>
<pre class="programlisting">bool verify_callback(
bool preverified, // True if the certificate passed pre-verification.
verify_context&amp; ctx // The peer certificate and other context.
);
</pre>
<p>
The return value of the callback is true if the certificate has
passed verification, false otherwise.
</p>
</dd>
<dt><span class="term">ec</span></dt>
<dd><p>
Set to indicate what error occurred, if any.
</p></dd>
</dl>
</div>
<h6>
<a name="asio.reference.ssl__stream.set_verify_callback.overload2.h1"></a>
<span><a name="asio.reference.ssl__stream.set_verify_callback.overload2.remarks"></a></span><a class="link" href="overload2.html#asio.reference.ssl__stream.set_verify_callback.overload2.remarks">Remarks</a>
</h6>
<p>
Calls <code class="computeroutput">SSL_set_verify</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-2020 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="overload1.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../set_verify_callback.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="../set_verify_depth.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,51 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ssl::stream::set_verify_depth</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../index.html" title="Asio">
<link rel="up" href="../ssl__stream.html" title="ssl::stream">
<link rel="prev" href="set_verify_callback/overload2.html" title="ssl::stream::set_verify_callback (2 of 2 overloads)">
<link rel="next" href="set_verify_depth/overload1.html" title="ssl::stream::set_verify_depth (1 of 2 overloads)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="set_verify_callback/overload2.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../ssl__stream.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="set_verify_depth/overload1.html"><img src="../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="asio.reference.ssl__stream.set_verify_depth"></a><a class="link" href="set_verify_depth.html" title="ssl::stream::set_verify_depth">ssl::stream::set_verify_depth</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.ssl__stream.set_verify_depth"></a>
Set
the peer verification depth.
</p>
<pre class="programlisting">void <a class="link" href="set_verify_depth/overload1.html" title="ssl::stream::set_verify_depth (1 of 2 overloads)">set_verify_depth</a>(
int depth);
<span class="emphasis"><em>» <a class="link" href="set_verify_depth/overload1.html" title="ssl::stream::set_verify_depth (1 of 2 overloads)">more...</a></em></span>
void <a class="link" href="set_verify_depth/overload2.html" title="ssl::stream::set_verify_depth (2 of 2 overloads)">set_verify_depth</a>(
int depth,
asio::error_code &amp; ec);
<span class="emphasis"><em>» <a class="link" href="set_verify_depth/overload2.html" title="ssl::stream::set_verify_depth (2 of 2 overloads)">more...</a></em></span>
</pre>
</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-2020 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="set_verify_callback/overload2.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../ssl__stream.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="set_verify_depth/overload1.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,82 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ssl::stream::set_verify_depth (1 of 2 overloads)</title>
<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../../index.html" title="Asio">
<link rel="up" href="../set_verify_depth.html" title="ssl::stream::set_verify_depth">
<link rel="prev" href="../set_verify_depth.html" title="ssl::stream::set_verify_depth">
<link rel="next" href="overload2.html" title="ssl::stream::set_verify_depth (2 of 2 overloads)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../set_verify_depth.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../set_verify_depth.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.ssl__stream.set_verify_depth.overload1"></a><a class="link" href="overload1.html" title="ssl::stream::set_verify_depth (1 of 2 overloads)">ssl::stream::set_verify_depth
(1 of 2 overloads)</a>
</h5></div></div></div>
<p>
Set the peer verification depth.
</p>
<pre class="programlisting">void set_verify_depth(
int depth);
</pre>
<p>
This function may be used to configure the maximum verification depth
allowed by the stream.
</p>
<h6>
<a name="asio.reference.ssl__stream.set_verify_depth.overload1.h0"></a>
<span><a name="asio.reference.ssl__stream.set_verify_depth.overload1.parameters"></a></span><a class="link" href="overload1.html#asio.reference.ssl__stream.set_verify_depth.overload1.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">depth</span></dt>
<dd><p>
Maximum depth for the certificate chain verification that shall
be allowed.
</p></dd>
</dl>
</div>
<h6>
<a name="asio.reference.ssl__stream.set_verify_depth.overload1.h1"></a>
<span><a name="asio.reference.ssl__stream.set_verify_depth.overload1.exceptions"></a></span><a class="link" href="overload1.html#asio.reference.ssl__stream.set_verify_depth.overload1.exceptions">Exceptions</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">asio::system_error</span></dt>
<dd><p>
Thrown on failure.
</p></dd>
</dl>
</div>
<h6>
<a name="asio.reference.ssl__stream.set_verify_depth.overload1.h2"></a>
<span><a name="asio.reference.ssl__stream.set_verify_depth.overload1.remarks"></a></span><a class="link" href="overload1.html#asio.reference.ssl__stream.set_verify_depth.overload1.remarks">Remarks</a>
</h6>
<p>
Calls <code class="computeroutput">SSL_set_verify_depth</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-2020 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="../set_verify_depth.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../set_verify_depth.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,74 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ssl::stream::set_verify_depth (2 of 2 overloads)</title>
<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../../index.html" title="Asio">
<link rel="up" href="../set_verify_depth.html" title="ssl::stream::set_verify_depth">
<link rel="prev" href="overload1.html" title="ssl::stream::set_verify_depth (1 of 2 overloads)">
<link rel="next" href="../set_verify_mode.html" title="ssl::stream::set_verify_mode">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="overload1.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../set_verify_depth.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="../set_verify_mode.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.ssl__stream.set_verify_depth.overload2"></a><a class="link" href="overload2.html" title="ssl::stream::set_verify_depth (2 of 2 overloads)">ssl::stream::set_verify_depth
(2 of 2 overloads)</a>
</h5></div></div></div>
<p>
Set the peer verification depth.
</p>
<pre class="programlisting">void set_verify_depth(
int depth,
asio::error_code &amp; ec);
</pre>
<p>
This function may be used to configure the maximum verification depth
allowed by the stream.
</p>
<h6>
<a name="asio.reference.ssl__stream.set_verify_depth.overload2.h0"></a>
<span><a name="asio.reference.ssl__stream.set_verify_depth.overload2.parameters"></a></span><a class="link" href="overload2.html#asio.reference.ssl__stream.set_verify_depth.overload2.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">depth</span></dt>
<dd><p>
Maximum depth for the certificate chain verification that shall
be allowed.
</p></dd>
<dt><span class="term">ec</span></dt>
<dd><p>
Set to indicate what error occurred, if any.
</p></dd>
</dl>
</div>
<h6>
<a name="asio.reference.ssl__stream.set_verify_depth.overload2.h1"></a>
<span><a name="asio.reference.ssl__stream.set_verify_depth.overload2.remarks"></a></span><a class="link" href="overload2.html#asio.reference.ssl__stream.set_verify_depth.overload2.remarks">Remarks</a>
</h6>
<p>
Calls <code class="computeroutput">SSL_set_verify_depth</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-2020 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="overload1.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../set_verify_depth.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="../set_verify_mode.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,51 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ssl::stream::set_verify_mode</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../index.html" title="Asio">
<link rel="up" href="../ssl__stream.html" title="ssl::stream">
<link rel="prev" href="set_verify_depth/overload2.html" title="ssl::stream::set_verify_depth (2 of 2 overloads)">
<link rel="next" href="set_verify_mode/overload1.html" title="ssl::stream::set_verify_mode (1 of 2 overloads)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="set_verify_depth/overload2.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../ssl__stream.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="set_verify_mode/overload1.html"><img src="../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="asio.reference.ssl__stream.set_verify_mode"></a><a class="link" href="set_verify_mode.html" title="ssl::stream::set_verify_mode">ssl::stream::set_verify_mode</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.ssl__stream.set_verify_mode"></a>
Set
the peer verification mode.
</p>
<pre class="programlisting">void <a class="link" href="set_verify_mode/overload1.html" title="ssl::stream::set_verify_mode (1 of 2 overloads)">set_verify_mode</a>(
verify_mode v);
<span class="emphasis"><em>» <a class="link" href="set_verify_mode/overload1.html" title="ssl::stream::set_verify_mode (1 of 2 overloads)">more...</a></em></span>
void <a class="link" href="set_verify_mode/overload2.html" title="ssl::stream::set_verify_mode (2 of 2 overloads)">set_verify_mode</a>(
verify_mode v,
asio::error_code &amp; ec);
<span class="emphasis"><em>» <a class="link" href="set_verify_mode/overload2.html" title="ssl::stream::set_verify_mode (2 of 2 overloads)">more...</a></em></span>
</pre>
</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-2020 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="set_verify_depth/overload2.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../ssl__stream.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="set_verify_mode/overload1.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,83 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ssl::stream::set_verify_mode (1 of 2 overloads)</title>
<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../../index.html" title="Asio">
<link rel="up" href="../set_verify_mode.html" title="ssl::stream::set_verify_mode">
<link rel="prev" href="../set_verify_mode.html" title="ssl::stream::set_verify_mode">
<link rel="next" href="overload2.html" title="ssl::stream::set_verify_mode (2 of 2 overloads)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../set_verify_mode.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../set_verify_mode.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.ssl__stream.set_verify_mode.overload1"></a><a class="link" href="overload1.html" title="ssl::stream::set_verify_mode (1 of 2 overloads)">ssl::stream::set_verify_mode
(1 of 2 overloads)</a>
</h5></div></div></div>
<p>
Set the peer verification mode.
</p>
<pre class="programlisting">void set_verify_mode(
verify_mode v);
</pre>
<p>
This function may be used to configure the peer verification mode used
by the stream. The new mode will override the mode inherited from the
context.
</p>
<h6>
<a name="asio.reference.ssl__stream.set_verify_mode.overload1.h0"></a>
<span><a name="asio.reference.ssl__stream.set_verify_mode.overload1.parameters"></a></span><a class="link" href="overload1.html#asio.reference.ssl__stream.set_verify_mode.overload1.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">v</span></dt>
<dd><p>
A bitmask of peer verification modes. See <a class="link" href="../../ssl__verify_mode.html" title="ssl::verify_mode"><code class="computeroutput">ssl::verify_mode</code></a>
for available values.
</p></dd>
</dl>
</div>
<h6>
<a name="asio.reference.ssl__stream.set_verify_mode.overload1.h1"></a>
<span><a name="asio.reference.ssl__stream.set_verify_mode.overload1.exceptions"></a></span><a class="link" href="overload1.html#asio.reference.ssl__stream.set_verify_mode.overload1.exceptions">Exceptions</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">asio::system_error</span></dt>
<dd><p>
Thrown on failure.
</p></dd>
</dl>
</div>
<h6>
<a name="asio.reference.ssl__stream.set_verify_mode.overload1.h2"></a>
<span><a name="asio.reference.ssl__stream.set_verify_mode.overload1.remarks"></a></span><a class="link" href="overload1.html#asio.reference.ssl__stream.set_verify_mode.overload1.remarks">Remarks</a>
</h6>
<p>
Calls <code class="computeroutput">SSL_set_verify</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-2020 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="../set_verify_mode.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../set_verify_mode.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,75 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ssl::stream::set_verify_mode (2 of 2 overloads)</title>
<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../../index.html" title="Asio">
<link rel="up" href="../set_verify_mode.html" title="ssl::stream::set_verify_mode">
<link rel="prev" href="overload1.html" title="ssl::stream::set_verify_mode (1 of 2 overloads)">
<link rel="next" href="../shutdown.html" title="ssl::stream::shutdown">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="overload1.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../set_verify_mode.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="../shutdown.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.ssl__stream.set_verify_mode.overload2"></a><a class="link" href="overload2.html" title="ssl::stream::set_verify_mode (2 of 2 overloads)">ssl::stream::set_verify_mode
(2 of 2 overloads)</a>
</h5></div></div></div>
<p>
Set the peer verification mode.
</p>
<pre class="programlisting">void set_verify_mode(
verify_mode v,
asio::error_code &amp; ec);
</pre>
<p>
This function may be used to configure the peer verification mode used
by the stream. The new mode will override the mode inherited from the
context.
</p>
<h6>
<a name="asio.reference.ssl__stream.set_verify_mode.overload2.h0"></a>
<span><a name="asio.reference.ssl__stream.set_verify_mode.overload2.parameters"></a></span><a class="link" href="overload2.html#asio.reference.ssl__stream.set_verify_mode.overload2.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">v</span></dt>
<dd><p>
A bitmask of peer verification modes. See <a class="link" href="../../ssl__verify_mode.html" title="ssl::verify_mode"><code class="computeroutput">ssl::verify_mode</code></a>
for available values.
</p></dd>
<dt><span class="term">ec</span></dt>
<dd><p>
Set to indicate what error occurred, if any.
</p></dd>
</dl>
</div>
<h6>
<a name="asio.reference.ssl__stream.set_verify_mode.overload2.h1"></a>
<span><a name="asio.reference.ssl__stream.set_verify_mode.overload2.remarks"></a></span><a class="link" href="overload2.html#asio.reference.ssl__stream.set_verify_mode.overload2.remarks">Remarks</a>
</h6>
<p>
Calls <code class="computeroutput">SSL_set_verify</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-2020 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="overload1.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../set_verify_mode.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="../shutdown.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,49 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ssl::stream::shutdown</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../index.html" title="Asio">
<link rel="up" href="../ssl__stream.html" title="ssl::stream">
<link rel="prev" href="set_verify_mode/overload2.html" title="ssl::stream::set_verify_mode (2 of 2 overloads)">
<link rel="next" href="shutdown/overload1.html" title="ssl::stream::shutdown (1 of 2 overloads)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="set_verify_mode/overload2.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../ssl__stream.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="shutdown/overload1.html"><img src="../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="asio.reference.ssl__stream.shutdown"></a><a class="link" href="shutdown.html" title="ssl::stream::shutdown">ssl::stream::shutdown</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.ssl__stream.shutdown"></a>
Shut down SSL on
the stream.
</p>
<pre class="programlisting">void <a class="link" href="shutdown/overload1.html" title="ssl::stream::shutdown (1 of 2 overloads)">shutdown</a>();
<span class="emphasis"><em>» <a class="link" href="shutdown/overload1.html" title="ssl::stream::shutdown (1 of 2 overloads)">more...</a></em></span>
void <a class="link" href="shutdown/overload2.html" title="ssl::stream::shutdown (2 of 2 overloads)">shutdown</a>(
asio::error_code &amp; ec);
<span class="emphasis"><em>» <a class="link" href="shutdown/overload2.html" title="ssl::stream::shutdown (2 of 2 overloads)">more...</a></em></span>
</pre>
</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-2020 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="set_verify_mode/overload2.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../ssl__stream.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="shutdown/overload1.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,60 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ssl::stream::shutdown (1 of 2 overloads)</title>
<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../../index.html" title="Asio">
<link rel="up" href="../shutdown.html" title="ssl::stream::shutdown">
<link rel="prev" href="../shutdown.html" title="ssl::stream::shutdown">
<link rel="next" href="overload2.html" title="ssl::stream::shutdown (2 of 2 overloads)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../shutdown.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../shutdown.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.ssl__stream.shutdown.overload1"></a><a class="link" href="overload1.html" title="ssl::stream::shutdown (1 of 2 overloads)">ssl::stream::shutdown
(1 of 2 overloads)</a>
</h5></div></div></div>
<p>
Shut down SSL on the stream.
</p>
<pre class="programlisting">void shutdown();
</pre>
<p>
This function is used to shut down SSL on the stream. The function call
will block until SSL has been shut down or an error occurs.
</p>
<h6>
<a name="asio.reference.ssl__stream.shutdown.overload1.h0"></a>
<span><a name="asio.reference.ssl__stream.shutdown.overload1.exceptions"></a></span><a class="link" href="overload1.html#asio.reference.ssl__stream.shutdown.overload1.exceptions">Exceptions</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">asio::system_error</span></dt>
<dd><p>
Thrown on failure.
</p></dd>
</dl>
</div>
</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-2020 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="../shutdown.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../shutdown.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,61 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ssl::stream::shutdown (2 of 2 overloads)</title>
<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../../index.html" title="Asio">
<link rel="up" href="../shutdown.html" title="ssl::stream::shutdown">
<link rel="prev" href="overload1.html" title="ssl::stream::shutdown (1 of 2 overloads)">
<link rel="next" href="../stream.html" title="ssl::stream::stream">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="overload1.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../shutdown.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="../stream.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.ssl__stream.shutdown.overload2"></a><a class="link" href="overload2.html" title="ssl::stream::shutdown (2 of 2 overloads)">ssl::stream::shutdown
(2 of 2 overloads)</a>
</h5></div></div></div>
<p>
Shut down SSL on the stream.
</p>
<pre class="programlisting">void shutdown(
asio::error_code &amp; ec);
</pre>
<p>
This function is used to shut down SSL on the stream. The function call
will block until SSL has been shut down or an error occurs.
</p>
<h6>
<a name="asio.reference.ssl__stream.shutdown.overload2.h0"></a>
<span><a name="asio.reference.ssl__stream.shutdown.overload2.parameters"></a></span><a class="link" href="overload2.html#asio.reference.ssl__stream.shutdown.overload2.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">ec</span></dt>
<dd><p>
Set to indicate what error occurred, if any.
</p></dd>
</dl>
</div>
</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-2020 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="overload1.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../shutdown.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="../stream.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,55 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ssl::stream::stream</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../index.html" title="Asio">
<link rel="up" href="../ssl__stream.html" title="ssl::stream">
<link rel="prev" href="shutdown/overload2.html" title="ssl::stream::shutdown (2 of 2 overloads)">
<link rel="next" href="stream/overload1.html" title="ssl::stream::stream (1 of 2 overloads)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="shutdown/overload2.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../ssl__stream.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="stream/overload1.html"><img src="../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="asio.reference.ssl__stream.stream"></a><a class="link" href="stream.html" title="ssl::stream::stream">ssl::stream::stream</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.ssl__stream.stream"></a>
Construct a stream.
</p>
<pre class="programlisting">template&lt;
typename Arg&gt;
<a class="link" href="stream/overload1.html" title="ssl::stream::stream (1 of 2 overloads)">stream</a>(
Arg &amp;&amp; arg,
context &amp; ctx);
<span class="emphasis"><em>» <a class="link" href="stream/overload1.html" title="ssl::stream::stream (1 of 2 overloads)">more...</a></em></span>
</pre>
<p>
Move-construct a stream from another.
</p>
<pre class="programlisting"><a class="link" href="stream/overload2.html" title="ssl::stream::stream (2 of 2 overloads)">stream</a>(
stream &amp;&amp; other);
<span class="emphasis"><em>» <a class="link" href="stream/overload2.html" title="ssl::stream::stream (2 of 2 overloads)">more...</a></em></span>
</pre>
</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-2020 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="shutdown/overload2.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../ssl__stream.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="stream/overload1.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,68 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ssl::stream::stream (1 of 2 overloads)</title>
<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../../index.html" title="Asio">
<link rel="up" href="../stream.html" title="ssl::stream::stream">
<link rel="prev" href="../stream.html" title="ssl::stream::stream">
<link rel="next" href="overload2.html" title="ssl::stream::stream (2 of 2 overloads)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../stream.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../stream.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.ssl__stream.stream.overload1"></a><a class="link" href="overload1.html" title="ssl::stream::stream (1 of 2 overloads)">ssl::stream::stream
(1 of 2 overloads)</a>
</h5></div></div></div>
<p>
Construct a stream.
</p>
<pre class="programlisting">template&lt;
typename Arg&gt;
stream(
Arg &amp;&amp; arg,
context &amp; ctx);
</pre>
<p>
This constructor creates a stream and initialises the underlying stream
object.
</p>
<h6>
<a name="asio.reference.ssl__stream.stream.overload1.h0"></a>
<span><a name="asio.reference.ssl__stream.stream.overload1.parameters"></a></span><a class="link" href="overload1.html#asio.reference.ssl__stream.stream.overload1.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">arg</span></dt>
<dd><p>
The argument to be passed to initialise the underlying stream.
</p></dd>
<dt><span class="term">ctx</span></dt>
<dd><p>
The SSL context to be used for the stream.
</p></dd>
</dl>
</div>
</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-2020 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="../stream.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../stream.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,60 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ssl::stream::stream (2 of 2 overloads)</title>
<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../../index.html" title="Asio">
<link rel="up" href="../stream.html" title="ssl::stream::stream">
<link rel="prev" href="overload1.html" title="ssl::stream::stream (1 of 2 overloads)">
<link rel="next" href="../write_some.html" title="ssl::stream::write_some">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="overload1.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../stream.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="../write_some.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.ssl__stream.stream.overload2"></a><a class="link" href="overload2.html" title="ssl::stream::stream (2 of 2 overloads)">ssl::stream::stream
(2 of 2 overloads)</a>
</h5></div></div></div>
<p>
Move-construct a stream from another.
</p>
<pre class="programlisting">stream(
stream &amp;&amp; other);
</pre>
<h6>
<a name="asio.reference.ssl__stream.stream.overload2.h0"></a>
<span><a name="asio.reference.ssl__stream.stream.overload2.parameters"></a></span><a class="link" href="overload2.html#asio.reference.ssl__stream.stream.overload2.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">other</span></dt>
<dd><p>
The other stream object from which the move will occur. Must have
no outstanding asynchronous operations associated with it. Following
the move, <code class="computeroutput">other</code> has a valid but unspecified state
where the only safe operation is destruction.
</p></dd>
</dl>
</div>
</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-2020 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="overload1.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../stream.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="../write_some.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,55 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ssl::stream::write_some</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../index.html" title="Asio">
<link rel="up" href="../ssl__stream.html" title="ssl::stream">
<link rel="prev" href="stream/overload2.html" title="ssl::stream::stream (2 of 2 overloads)">
<link rel="next" href="write_some/overload1.html" title="ssl::stream::write_some (1 of 2 overloads)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="stream/overload2.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../ssl__stream.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="write_some/overload1.html"><img src="../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="asio.reference.ssl__stream.write_some"></a><a class="link" href="write_some.html" title="ssl::stream::write_some">ssl::stream::write_some</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.ssl__stream.write_some"></a>
Write some data
to the stream.
</p>
<pre class="programlisting">template&lt;
typename <a class="link" href="../ConstBufferSequence.html" title="Constant buffer sequence requirements">ConstBufferSequence</a>&gt;
std::size_t <a class="link" href="write_some/overload1.html" title="ssl::stream::write_some (1 of 2 overloads)">write_some</a>(
const ConstBufferSequence &amp; buffers);
<span class="emphasis"><em>» <a class="link" href="write_some/overload1.html" title="ssl::stream::write_some (1 of 2 overloads)">more...</a></em></span>
template&lt;
typename <a class="link" href="../ConstBufferSequence.html" title="Constant buffer sequence requirements">ConstBufferSequence</a>&gt;
std::size_t <a class="link" href="write_some/overload2.html" title="ssl::stream::write_some (2 of 2 overloads)">write_some</a>(
const ConstBufferSequence &amp; buffers,
asio::error_code &amp; ec);
<span class="emphasis"><em>» <a class="link" href="write_some/overload2.html" title="ssl::stream::write_some (2 of 2 overloads)">more...</a></em></span>
</pre>
</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-2020 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="stream/overload2.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../ssl__stream.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="write_some/overload1.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,95 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ssl::stream::write_some (1 of 2 overloads)</title>
<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../../index.html" title="Asio">
<link rel="up" href="../write_some.html" title="ssl::stream::write_some">
<link rel="prev" href="../write_some.html" title="ssl::stream::write_some">
<link rel="next" href="overload2.html" title="ssl::stream::write_some (2 of 2 overloads)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../write_some.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../write_some.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.ssl__stream.write_some.overload1"></a><a class="link" href="overload1.html" title="ssl::stream::write_some (1 of 2 overloads)">ssl::stream::write_some
(1 of 2 overloads)</a>
</h5></div></div></div>
<p>
Write some data to the stream.
</p>
<pre class="programlisting">template&lt;
typename <a class="link" href="../../ConstBufferSequence.html" title="Constant buffer sequence requirements">ConstBufferSequence</a>&gt;
std::size_t write_some(
const ConstBufferSequence &amp; buffers);
</pre>
<p>
This function is used to write data on the stream. The function call
will block until one or more bytes of data has been written successfully,
or until an error occurs.
</p>
<h6>
<a name="asio.reference.ssl__stream.write_some.overload1.h0"></a>
<span><a name="asio.reference.ssl__stream.write_some.overload1.parameters"></a></span><a class="link" href="overload1.html#asio.reference.ssl__stream.write_some.overload1.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">buffers</span></dt>
<dd><p>
The data to be written.
</p></dd>
</dl>
</div>
<h6>
<a name="asio.reference.ssl__stream.write_some.overload1.h1"></a>
<span><a name="asio.reference.ssl__stream.write_some.overload1.return_value"></a></span><a class="link" href="overload1.html#asio.reference.ssl__stream.write_some.overload1.return_value">Return
Value</a>
</h6>
<p>
The number of bytes written.
</p>
<h6>
<a name="asio.reference.ssl__stream.write_some.overload1.h2"></a>
<span><a name="asio.reference.ssl__stream.write_some.overload1.exceptions"></a></span><a class="link" href="overload1.html#asio.reference.ssl__stream.write_some.overload1.exceptions">Exceptions</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">asio::system_error</span></dt>
<dd><p>
Thrown on failure.
</p></dd>
</dl>
</div>
<h6>
<a name="asio.reference.ssl__stream.write_some.overload1.h3"></a>
<span><a name="asio.reference.ssl__stream.write_some.overload1.remarks"></a></span><a class="link" href="overload1.html#asio.reference.ssl__stream.write_some.overload1.remarks">Remarks</a>
</h6>
<p>
The write_some operation may not transmit all of the data to the peer.
Consider using the <a class="link" href="../../write.html" title="write"><code class="computeroutput">write</code></a>
function if you need to ensure that all data is written before the blocking
operation completes.
</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-2020 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="../write_some.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../write_some.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,87 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ssl::stream::write_some (2 of 2 overloads)</title>
<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../../index.html" title="Asio">
<link rel="up" href="../write_some.html" title="ssl::stream::write_some">
<link rel="prev" href="overload1.html" title="ssl::stream::write_some (1 of 2 overloads)">
<link rel="next" href="../_stream.html" title="ssl::stream::~stream">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="overload1.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../write_some.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="../_stream.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.ssl__stream.write_some.overload2"></a><a class="link" href="overload2.html" title="ssl::stream::write_some (2 of 2 overloads)">ssl::stream::write_some
(2 of 2 overloads)</a>
</h5></div></div></div>
<p>
Write some data to the stream.
</p>
<pre class="programlisting">template&lt;
typename <a class="link" href="../../ConstBufferSequence.html" title="Constant buffer sequence requirements">ConstBufferSequence</a>&gt;
std::size_t write_some(
const ConstBufferSequence &amp; buffers,
asio::error_code &amp; ec);
</pre>
<p>
This function is used to write data on the stream. The function call
will block until one or more bytes of data has been written successfully,
or until an error occurs.
</p>
<h6>
<a name="asio.reference.ssl__stream.write_some.overload2.h0"></a>
<span><a name="asio.reference.ssl__stream.write_some.overload2.parameters"></a></span><a class="link" href="overload2.html#asio.reference.ssl__stream.write_some.overload2.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">buffers</span></dt>
<dd><p>
The data to be written to the stream.
</p></dd>
<dt><span class="term">ec</span></dt>
<dd><p>
Set to indicate what error occurred, if any.
</p></dd>
</dl>
</div>
<h6>
<a name="asio.reference.ssl__stream.write_some.overload2.h1"></a>
<span><a name="asio.reference.ssl__stream.write_some.overload2.return_value"></a></span><a class="link" href="overload2.html#asio.reference.ssl__stream.write_some.overload2.return_value">Return
Value</a>
</h6>
<p>
The number of bytes written. Returns 0 if an error occurred.
</p>
<h6>
<a name="asio.reference.ssl__stream.write_some.overload2.h2"></a>
<span><a name="asio.reference.ssl__stream.write_some.overload2.remarks"></a></span><a class="link" href="overload2.html#asio.reference.ssl__stream.write_some.overload2.remarks">Remarks</a>
</h6>
<p>
The write_some operation may not transmit all of the data to the peer.
Consider using the <a class="link" href="../../write.html" title="write"><code class="computeroutput">write</code></a>
function if you need to ensure that all data is written before the blocking
operation completes.
</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-2020 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="overload1.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../write_some.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="../_stream.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>