• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>ssl::stream::handshake (3 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.79.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="overload2.html" title="ssl::stream::handshake (2 of 4 overloads)">
10<link rel="next" href="overload4.html" title="ssl::stream::handshake (4 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="overload2.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="overload4.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.overload3"></a><a class="link" href="overload3.html" title="ssl::stream::handshake (3 of 4 overloads)">ssl::stream::handshake
28          (3 of 4 overloads)</a>
29</h5></div></div></div>
30<p>
31            Perform SSL handshaking.
32          </p>
33<pre class="programlisting">template&lt;
34    typename <a class="link" href="../../ConstBufferSequence.html" title="Constant buffer sequence requirements">ConstBufferSequence</a>&gt;
35void handshake(
36    handshake_type type,
37    const ConstBufferSequence &amp; buffers);
38</pre>
39<p>
40            This function is used to perform SSL handshaking on the stream. The function
41            call will block until handshaking is complete or an error occurs.
42          </p>
43<h6>
44<a name="boost_asio.reference.ssl__stream.handshake.overload3.h0"></a>
45            <span class="phrase"><a name="boost_asio.reference.ssl__stream.handshake.overload3.parameters"></a></span><a class="link" href="overload3.html#boost_asio.reference.ssl__stream.handshake.overload3.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">buffers</span></dt>
56<dd><p>
57                  The buffered data to be reused for the handshake.
58                </p></dd>
59</dl>
60</div>
61<h6>
62<a name="boost_asio.reference.ssl__stream.handshake.overload3.h1"></a>
63            <span class="phrase"><a name="boost_asio.reference.ssl__stream.handshake.overload3.exceptions"></a></span><a class="link" href="overload3.html#boost_asio.reference.ssl__stream.handshake.overload3.exceptions">Exceptions</a>
64          </h6>
65<div class="variablelist">
66<p class="title"><b></b></p>
67<dl class="variablelist">
68<dt><span class="term">boost::system::system_error</span></dt>
69<dd><p>
70                  Thrown on failure.
71                </p></dd>
72</dl>
73</div>
74</div>
75<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
76<td align="left"></td>
77<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M.
78      Kohlhoff<p>
79        Distributed under the Boost Software License, Version 1.0. (See accompanying
80        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>)
81      </p>
82</div></td>
83</tr></table>
84<hr>
85<div class="spirit-nav">
86<a accesskey="p" href="overload2.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="overload4.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
87</div>
88</body>
89</html>
90