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="../../../index.html" title="Chapter 1. Boost.Beast"> 8<link rel="up" href="../boost__beast__ssl_stream.html" title="ssl_stream"> 9<link rel="prev" href="shutdown/overload2.html" title="ssl_stream::shutdown (2 of 2 overloads)"> 10<link rel="next" href="write_some.html" title="ssl_stream::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="shutdown/overload2.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__ssl_stream.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="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><h5 class="title"> 27<a name="beast.ref.boost__beast__ssl_stream.async_shutdown"></a><a class="link" href="async_shutdown.html" title="ssl_stream::async_shutdown">ssl_stream::async_shutdown</a> 28</h5></div></div></div> 29<p> 30 <a class="indexterm" name="idm46057526737920"></a> 31 </p> 32<p> 33 Asynchronously shut down SSL on the stream. 34 </p> 35<h6> 36<a name="beast.ref.boost__beast__ssl_stream.async_shutdown.h0"></a> 37 <span class="phrase"><a name="beast.ref.boost__beast__ssl_stream.async_shutdown.synopsis"></a></span><a class="link" href="async_shutdown.html#beast.ref.boost__beast__ssl_stream.async_shutdown.synopsis">Synopsis</a> 38 </h6> 39<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> 40 <span class="keyword">class</span> <span class="identifier">ShutdownHandler</span><span class="special">></span> 41<a href="../../../../../../../doc/html/boost_asio/reference/asynchronous_operations.html#boost_asio.reference.asynchronous_operations.automatic_deduction_of_initiating_function_return_type" target="_top"><span class="emphasis"><em>DEDUCED</em></span></a> 42<span class="identifier">async_shutdown</span><span class="special">(</span> 43 <span class="identifier">BOOST_ASIO_MOVE_ARG</span><span class="special">(</span><span class="identifier">ShutdownHandler</span><span class="special">)</span> <span class="identifier">handler</span><span class="special">);</span> 44</pre> 45<h6> 46<a name="beast.ref.boost__beast__ssl_stream.async_shutdown.h1"></a> 47 <span class="phrase"><a name="beast.ref.boost__beast__ssl_stream.async_shutdown.description"></a></span><a class="link" href="async_shutdown.html#beast.ref.boost__beast__ssl_stream.async_shutdown.description">Description</a> 48 </h6> 49<p> 50 This function is used to asynchronously shut down SSL on the stream. This 51 function call always returns immediately. 52 </p> 53<h6> 54<a name="beast.ref.boost__beast__ssl_stream.async_shutdown.h2"></a> 55 <span class="phrase"><a name="beast.ref.boost__beast__ssl_stream.async_shutdown.parameters"></a></span><a class="link" href="async_shutdown.html#beast.ref.boost__beast__ssl_stream.async_shutdown.parameters">Parameters</a> 56 </h6> 57<div class="informaltable"><table class="table"> 58<colgroup> 59<col> 60<col> 61</colgroup> 62<thead><tr> 63<th> 64 <p> 65 Name 66 </p> 67 </th> 68<th> 69 <p> 70 Description 71 </p> 72 </th> 73</tr></thead> 74<tbody><tr> 75<td> 76 <p> 77 <code class="computeroutput"><span class="identifier">handler</span></code> 78 </p> 79 </td> 80<td> 81 <p> 82 The handler to be called when the handshake operation completes. 83 Copies will be made of the handler as required. The equivalent 84 function signature of the handler must be: 85 </p> 86<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"> <span class="keyword">void</span> <span class="identifier">handler</span><span class="special">(</span> 87 <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</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> 88<span class="special">);</span> 89</pre> 90 </td> 91</tr></tbody> 92</table></div> 93</div> 94<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 95<td align="left"></td> 96<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie 97 Falco<p> 98 Distributed under the Boost Software License, Version 1.0. (See accompanying 99 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>) 100 </p> 101</div></td> 102</tr></table> 103<hr> 104<div class="spirit-nav"> 105<a accesskey="p" href="shutdown/overload2.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__ssl_stream.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="write_some.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> 106</div> 107</body> 108</html> 109
