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

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>ssl::stream::handshake (1 of 4 overloads)</title>
   5 <link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
   7 <link rel="home" href="../../../../boost_asio.html" title="Boost.Asio">
   8 <link rel="up" href="../handshake.html" title="ssl::stream::handshake">
   9 <link rel="prev" href="../handshake.html" title="ssl::stream::handshake">
  10 <link rel="next" href="overload2.html" title="ssl::stream::handshake (2 of 4 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="../handshake.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../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.handshake.overload1"></a><a class="link" href="overload1.html" title="ssl::stream::handshake (1 of 4 overloads)">ssl::stream::handshake
  28           (1 of 4 overloads)</a>
  29 </h5></div></div></div>
  30 <p>
  31             Perform SSL handshaking.
  32           </p>
  33 <pre class="programlisting"><span class="keyword">void</span> <span class="identifier">handshake</span><span class="special">(</span>
  34     <span class="identifier">handshake_type</span> <span class="identifier">type</span><span class="special">);</span>
  35 </pre>
  36 <p>
  37             This function is used to perform SSL handshaking on the stream. The function
  38             call will block until handshaking is complete or an error occurs.
  39           </p>
  40 <h6>
  41 <a name="boost_asio.reference.ssl__stream.handshake.overload1.h0"></a>
  42             <span class="phrase"><a name="boost_asio.reference.ssl__stream.handshake.overload1.parameters"></a></span><a class="link" href="overload1.html#boost_asio.reference.ssl__stream.handshake.overload1.parameters">Parameters</a>
  43           </h6>
  44 <div class="variablelist">
  45 <p class="title"><b></b></p>
  46 <dl class="variablelist">
  47 <dt><span class="term">type</span></dt>
  48 <dd><p>
  49                   The type of handshaking to be performed, i.e. as a client or as
  50                   a server.
  51                 </p></dd>
  52 </dl>
  53 </div>
  54 <h6>
  55 <a name="boost_asio.reference.ssl__stream.handshake.overload1.h1"></a>
  56             <span class="phrase"><a name="boost_asio.reference.ssl__stream.handshake.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.ssl__stream.handshake.overload1.exceptions">Exceptions</a>
  57           </h6>
  58 <div class="variablelist">
  59 <p class="title"><b></b></p>
  60 <dl class="variablelist">
  61 <dt><span class="term">boost::system::system_error</span></dt>
  62 <dd><p>
  63                   Thrown on failure.
  64                 </p></dd>
  65 </dl>
  66 </div>
  67 </div>
  68 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  69 <td align="left"></td>
  70 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2014 Christopher M. Kohlhoff<p>
  71         Distributed under the Boost Software License, Version 1.0. (See accompanying
  72         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>)
  73       </p>
  74 </div></td>
  75 </tr></table>
  76 <hr>
  77 <div class="spirit-nav">
  78 <a accesskey="p" href="../handshake.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../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>
  79 </div>
  80 </body>
  81 </html>