1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>ssl_stream::async_handshake (1 of 2 overloads)</title> 5<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="../../../../index.html" title="Chapter 1. Boost.Beast"> 8<link rel="up" href="../async_handshake.html" title="ssl_stream::async_handshake"> 9<link rel="prev" href="../async_handshake.html" title="ssl_stream::async_handshake"> 10<link rel="next" href="overload2.html" title="ssl_stream::async_handshake (2 of 2 overloads)"> 11</head> 12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 13<table cellpadding="2" width="100%"><tr> 14<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> 15<td align="center"><a href="../../../../../../../../index.html">Home</a></td> 16<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> 17<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> 18<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> 19<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> 20</tr></table> 21<hr> 22<div class="spirit-nav"> 23<a accesskey="p" href="../async_handshake.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../async_handshake.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="section"> 26<div class="titlepage"><div><div><h6 class="title"> 27<a name="beast.ref.boost__beast__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 28 (1 of 2 overloads)</a> 29</h6></div></div></div> 30<p> 31 Start an asynchronous SSL handshake. 32 </p> 33<h7><a name="beast.ref.boost__beast__ssl_stream.async_handshake.overload1.h0"></a> 34 <span class="phrase"><a name="beast.ref.boost__beast__ssl_stream.async_handshake.overload1.synopsis"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__ssl_stream.async_handshake.overload1.synopsis">Synopsis</a> 35 </h7><pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> 36 <span class="keyword">class</span> <span class="identifier">HandshakeHandler</span><span class="special">></span> 37<a href="../../../../../../../../doc/html/boost_asio/reference/asynchronous_operations.html#boost_asio.reference.asynchronous_operations.automatic_deduction_of_initiating_function_return_type" target="_top"><span class="emphasis"><em>DEDUCED</em></span></a> 38<span class="identifier">async_handshake</span><span class="special">(</span> 39 <span class="identifier">handshake_type</span> <span class="identifier">type</span><span class="special">,</span> 40 <span class="identifier">BOOST_ASIO_MOVE_ARG</span><span class="special">(</span><span class="identifier">HandshakeHandler</span><span class="special">)</span> <span class="identifier">handler</span><span class="special">);</span> 41</pre> 42<h7><a name="beast.ref.boost__beast__ssl_stream.async_handshake.overload1.h1"></a> 43 <span class="phrase"><a name="beast.ref.boost__beast__ssl_stream.async_handshake.overload1.description"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__ssl_stream.async_handshake.overload1.description">Description</a> 44 </h7><p> 45 This function is used to asynchronously perform an SSL handshake on the 46 stream. This function call always returns immediately. 47 </p> 48<h7><a name="beast.ref.boost__beast__ssl_stream.async_handshake.overload1.h2"></a> 49 <span class="phrase"><a name="beast.ref.boost__beast__ssl_stream.async_handshake.overload1.parameters"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__ssl_stream.async_handshake.overload1.parameters">Parameters</a> 50 </h7><div class="informaltable"><table class="table"> 51<colgroup> 52<col> 53<col> 54</colgroup> 55<thead><tr> 56<th> 57 <p> 58 Name 59 </p> 60 </th> 61<th> 62 <p> 63 Description 64 </p> 65 </th> 66</tr></thead> 67<tbody> 68<tr> 69<td> 70 <p> 71 <code class="computeroutput"><span class="identifier">type</span></code> 72 </p> 73 </td> 74<td> 75 <p> 76 The type of handshaking to be performed, i.e. as a client or 77 as a server. 78 </p> 79 </td> 80</tr> 81<tr> 82<td> 83 <p> 84 <code class="computeroutput"><span class="identifier">handler</span></code> 85 </p> 86 </td> 87<td> 88 <p> 89 The handler to be called when the handshake operation completes. 90 Copies will be made of the handler as required. The equivalent 91 function signature of the handler must be: 92 </p> 93<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"> <span class="keyword">void</span> <span class="identifier">handler</span><span class="special">(</span> 94 <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span><span class="special">&</span> <span class="identifier">error</span> <span class="comment">// Result of operation.</span> 95<span class="special">);</span> 96</pre> 97 </td> 98</tr> 99</tbody> 100</table></div> 101</div> 102<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 103<td align="left"></td> 104<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie 105 Falco<p> 106 Distributed under the Boost Software License, Version 1.0. (See accompanying 107 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>) 108 </p> 109</div></td> 110</tr></table> 111<hr> 112<div class="spirit-nav"> 113<a accesskey="p" href="../async_handshake.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../async_handshake.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> 114</div> 115</body> 116</html> 117
