1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>async_teardown</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="../ref.html" title="This Page Intentionally Left Blank 2/2"> 9<link rel="prev" href="boost__beast__teardown.html" title="teardown"> 10<link rel="next" href="boost__beast__http__error.html" title="http::error"> 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="boost__beast__teardown.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../ref.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="boost__beast__http__error.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="beast.ref.boost__beast__async_teardown"></a><a class="link" href="boost__beast__async_teardown.html" title="async_teardown">async_teardown</a> 28</h4></div></div></div> 29<p> 30 <a class="indexterm" name="idm46057510682128"></a> 31 </p> 32<p> 33 Start tearing down a <code class="computeroutput"><span class="identifier">net</span><span class="special">::</span><span class="identifier">ssl</span><span class="special">::</span><span class="identifier">stream</span></code>. 34 </p> 35<h5> 36<a name="beast.ref.boost__beast__async_teardown.h0"></a> 37 <span class="phrase"><a name="beast.ref.boost__beast__async_teardown.synopsis"></a></span><a class="link" href="boost__beast__async_teardown.html#beast.ref.boost__beast__async_teardown.synopsis">Synopsis</a> 38 </h5> 39<p> 40 Defined in header <code class="literal"><<a href="../../../../../../boost/beast/websocket/ssl.hpp" target="_top">boost/beast/websocket/ssl.hpp</a>></code> 41 </p> 42<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> 43 <span class="keyword">class</span> <a class="link" href="../concepts/streams.html#beast.concepts.streams.AsyncStream"><span class="emphasis"><em>AsyncStream</em></span></a><span class="special">,</span> 44 <span class="keyword">class</span> <span class="identifier">TeardownHandler</span><span class="special">></span> 45<span class="keyword">void</span> 46<span class="identifier">async_teardown</span><span class="special">(</span> 47 <span class="identifier">role_type</span> <span class="identifier">role</span><span class="special">,</span> 48 <span class="identifier">net</span><span class="special">::</span><span class="identifier">ssl</span><span class="special">::</span><span class="identifier">stream</span><span class="special"><</span> <span class="identifier">AsyncStream</span> <span class="special">>&</span> <span class="identifier">stream</span><span class="special">,</span> 49 <span class="identifier">TeardownHandler</span><span class="special">&&</span> <span class="identifier">handler</span><span class="special">);</span> 50</pre> 51<h5> 52<a name="beast.ref.boost__beast__async_teardown.h1"></a> 53 <span class="phrase"><a name="beast.ref.boost__beast__async_teardown.description"></a></span><a class="link" href="boost__beast__async_teardown.html#beast.ref.boost__beast__async_teardown.description">Description</a> 54 </h5> 55<p> 56 This begins tearing down a connection asynchronously. The implementation 57 will call the overload of this function based on the <code class="computeroutput"><span class="identifier">Stream</span></code> 58 parameter used to consruct the socket. When <code class="computeroutput"><span class="identifier">Stream</span></code> 59 is a user defined type, and not a <code class="computeroutput"><span class="identifier">net</span><span class="special">::</span><span class="identifier">ip</span><span class="special">::</span><span class="identifier">tcp</span><span class="special">::</span><span class="identifier">socket</span></code> 60 or any <code class="computeroutput"><span class="identifier">net</span><span class="special">::</span><span class="identifier">ssl</span><span class="special">::</span><span class="identifier">stream</span></code>, 61 callers are responsible for providing a suitable overload of this function. 62 </p> 63<h5> 64<a name="beast.ref.boost__beast__async_teardown.h2"></a> 65 <span class="phrase"><a name="beast.ref.boost__beast__async_teardown.parameters"></a></span><a class="link" href="boost__beast__async_teardown.html#beast.ref.boost__beast__async_teardown.parameters">Parameters</a> 66 </h5> 67<div class="informaltable"><table class="table"> 68<colgroup> 69<col> 70<col> 71</colgroup> 72<thead><tr> 73<th> 74 <p> 75 Name 76 </p> 77 </th> 78<th> 79 <p> 80 Description 81 </p> 82 </th> 83</tr></thead> 84<tbody> 85<tr> 86<td> 87 <p> 88 <code class="computeroutput"><span class="identifier">role</span></code> 89 </p> 90 </td> 91<td> 92 <p> 93 The role of the local endpoint 94 </p> 95 </td> 96</tr> 97<tr> 98<td> 99 <p> 100 <code class="computeroutput"><span class="identifier">stream</span></code> 101 </p> 102 </td> 103<td> 104 <p> 105 The stream to tear down. 106 </p> 107 </td> 108</tr> 109<tr> 110<td> 111 <p> 112 <code class="computeroutput"><span class="identifier">handler</span></code> 113 </p> 114 </td> 115<td> 116 <p> 117 The completion handler to invoke when the operation completes. 118 The implementation takes ownership of the handler by performing 119 a decay-copy. The equivalent function signature of the handler 120 must be: 121 </p> 122<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> 123 <span class="identifier">error_code</span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">error</span> <span class="comment">// result of operation</span> 124<span class="special">);</span> 125</pre> 126 <p> 127 Regardless of whether the asynchronous operation completes immediately 128 or not, the handler will not be invoked from within this function. 129 Invocation of the handler will be performed in a manner equivalent 130 to using <code class="computeroutput"><span class="identifier">net</span><span class="special">::</span><span class="identifier">post</span></code>. 131 </p> 132 </td> 133</tr> 134</tbody> 135</table></div> 136</div> 137<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 138<td align="left"></td> 139<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie 140 Falco<p> 141 Distributed under the Boost Software License, Version 1.0. (See accompanying 142 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>) 143 </p> 144</div></td> 145</tr></table> 146<hr> 147<div class="spirit-nav"> 148<a accesskey="p" href="boost__beast__teardown.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../ref.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="boost__beast__http__error.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 149</div> 150</body> 151</html> 152
