doc/html/boost_asio/reference/ssl__stream/async_handshake/overload1.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   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="../../../../boost_asio.html" title="Boost.Asio">
   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="../../../../boost_asio.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><h5 class="title">
  27 <a name="boost_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
  28           (1 of 2 overloads)</a>
  29 </h5></div></div></div>
  30 <p>
  31             Start an asynchronous SSL handshake.
  32           </p>
  33 <pre class="programlisting">template&lt;
  34     typename <a class="link" href="../../HandshakeHandler.html" title="SSL handshake handler requirements">HandshakeHandler</a> = <a class="link" href="../../asynchronous_operations.html#boost_asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>&gt;
  35 <a class="link" href="../../asynchronous_operations.html#boost_asio.reference.asynchronous_operations.automatic_deduction_of_initiating_function_return_type"><span class="emphasis"><em>DEDUCED</em></span></a> async_handshake(
  36     handshake_type type,
  37     HandshakeHandler &amp;&amp; handler = <a class="link" href="../../asynchronous_operations.html#boost_asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>);
  38 </pre>
  39 <p>
  40             This function is used to asynchronously perform an SSL handshake on the
  41             stream. This function call always returns immediately.
  42           </p>
  43 <h6>
  44 <a name="boost_asio.reference.ssl__stream.async_handshake.overload1.h0"></a>
  45             <span class="phrase"><a name="boost_asio.reference.ssl__stream.async_handshake.overload1.parameters"></a></span><a class="link" href="overload1.html#boost_asio.reference.ssl__stream.async_handshake.overload1.parameters">Parameters</a>
  46           </h6>
  47 <div class="variablelist">
  48 <p class="title"><b></b></p>
  49 <dl class="variablelist">
  50 <dt><span class="term">type</span></dt>
  51 <dd><p>
  52                   The type of handshaking to be performed, i.e. as a client or as
  53                   a server.
  54                 </p></dd>
  55 <dt><span class="term">handler</span></dt>
  56 <dd>
  57 <p>
  58                   The handler to be called when the handshake operation completes.
  59                   Copies will be made of the handler as required. The equivalent
  60                   function signature of the handler must be:
  61 </p>
  62 <pre class="programlisting">void handler(
  63   const boost::system::error_code&amp; error // Result of operation.
  64 );
  65 </pre>
  66 <p>
  67                 </p>
  68 </dd>
  69 </dl>
  70 </div>
  71 </div>
  72 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  73 <td align="left"></td>
  74 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2019 Christopher M. Kohlhoff<p>
  75         Distributed under the Boost Software License, Version 1.0. (See accompanying
  76         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>)
  77       </p>
  78 </div></td>
  79 </tr></table>
  80 <hr>
  81 <div class="spirit-nav">
  82 <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="../../../../boost_asio.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>
  83 </div>
  84 </body>
  85 </html>