• 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::async_shutdown</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="../ssl__stream.html" title="ssl::stream">
9<link rel="prev" href="async_read_some.html" title="ssl::stream::async_read_some">
10<link rel="next" href="async_write_some.html" title="ssl::stream::async_write_some">
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_read_some.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../ssl__stream.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="async_write_some.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
24</div>
25<div class="section">
26<div class="titlepage"><div><div><h4 class="title">
27<a name="boost_asio.reference.ssl__stream.async_shutdown"></a><a class="link" href="async_shutdown.html" title="ssl::stream::async_shutdown">ssl::stream::async_shutdown</a>
28</h4></div></div></div>
29<p>
30          <a class="indexterm" name="boost_asio.indexterm.ssl__stream.async_shutdown"></a>
31Asynchronously
32          shut down SSL on the stream.
33        </p>
34<pre class="programlisting">template&lt;
35    typename <a class="link" href="../ShutdownHandler.html" title="SSL shutdown handler requirements">ShutdownHandler</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;
36<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_shutdown(
37    ShutdownHandler &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 shut down SSL on the stream. This
41          function call always returns immediately.
42        </p>
43<h6>
44<a name="boost_asio.reference.ssl__stream.async_shutdown.h0"></a>
45          <span class="phrase"><a name="boost_asio.reference.ssl__stream.async_shutdown.parameters"></a></span><a class="link" href="async_shutdown.html#boost_asio.reference.ssl__stream.async_shutdown.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">handler</span></dt>
51<dd>
52<p>
53                The handler to be called when the handshake operation completes.
54                Copies will be made of the handler as required. The equivalent function
55                signature of the handler must be:
56</p>
57<pre class="programlisting">void handler(
58  const boost::system::error_code&amp; error // Result of operation.
59);
60</pre>
61<p>
62              </p>
63</dd>
64</dl>
65</div>
66</div>
67<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
68<td align="left"></td>
69<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M.
70      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="async_read_some.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../ssl__stream.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="async_write_some.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
79</div>
80</body>
81</html>
82