<html> <head> <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> <title>ssl::stream::async_handshake</title> <link rel="stylesheet" href="../../../boostbook.css" type="text/css"> <meta name="generator" content="DocBook XSL Stylesheets V1.73.2"> <link rel="start" 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_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="../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_read_some.html"><img src="../../../next.png" alt="Next"></a> </div> <div class="section" lang="en"> <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="id1159923"></a> Start an asynchronous SSL handshake. </p> <pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> <span class="keyword">typename</span> <span class="identifier">HandshakeHandler</span><span class="special">></span> <span class="keyword">void</span> <span class="identifier">async_handshake</span><span class="special">(</span> <span class="identifier">handshake_type</span> <span class="identifier">type</span><span class="special">,</span> <span class="identifier">HandshakeHandler</span> <span class="identifier">handler</span><span class="special">);</span> </pre> <p> This function is used to asynchronously perform an SSL handshake on the stream. This function call always returns immediately. </p> <a name="asio.reference.ssl__stream.async_handshake.parameters"></a><h6> <a name="id1160025"></a> <a class="link" href="async_handshake.html#asio.reference.ssl__stream.async_handshake.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"><span class="keyword">void</span> <span class="identifier">handler</span><span class="special">(</span> <span class="keyword">const</span> <span class="identifier">asio</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><span class="special">);</span> </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 - 2010 Christopher M. Kohlhoff<p> Distributed under the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) </p> </div></td> </tr></table> <hr> <div class="spirit-nav"> <a accesskey="p" href="../ssl__stream.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_read_some.html"><img src="../../../next.png" alt="Next"></a> </div> </body> </html>