overload1.html
4.44 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
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<
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>>
<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 && 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& 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>