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