libs/beast/doc/html/beast/ref/boost__beast__async_teardown.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   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&#160;1.&#160;Boost.Beast">
   8 <link rel="up" href="../ref.html" title="This Page Intentionally Left Blank 2/2">
   9 <link rel="prev" href="boost__beast__async_detect_ssl.html" title="async_detect_ssl">
  10 <link rel="next" href="boost__beast__basic_flat_buffer.html" title="basic_flat_buffer">
  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__async_detect_ssl.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__basic_flat_buffer.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="idm45873519966736"></a>
  31 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>.
  32       </p>
  33 <h5>
  34 <a name="beast.ref.boost__beast__async_teardown.h0"></a>
  35         <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>
  36       </h5>
  37 <p>
  38         Defined in header <code class="literal">&lt;<a href="../../../../../../boost/beast/websocket/ssl.hpp" target="_top">boost/beast/websocket/ssl.hpp</a>&gt;</code>
  39       </p>
  40 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
  41     <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>
  42     <span class="keyword">class</span> <span class="identifier">TeardownHandler</span><span class="special">&gt;</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">net</span><span class="special">::</span><span class="identifier">ssl</span><span class="special">::</span><span class="identifier">stream</span><span class="special">&lt;</span> <span class="identifier">AsyncStream</span> <span class="special">&gt;&amp;</span> <span class="identifier">stream</span><span class="special">,</span>
  47     <span class="identifier">TeardownHandler</span><span class="special">&amp;&amp;</span> <span class="identifier">handler</span><span class="special">);</span>
  48 </pre>
  49 <h5>
  50 <a name="beast.ref.boost__beast__async_teardown.h1"></a>
  51         <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>
  52       </h5>
  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">Stream</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>,
  59         callers are responsible for providing a suitable overload of this function.
  60       </p>
  61 <h5>
  62 <a name="beast.ref.boost__beast__async_teardown.h2"></a>
  63         <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>
  64       </h5>
  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">stream</span></code>
  99                 </p>
 100               </td>
 101 <td>
 102                 <p>
 103                   The stream 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">&amp;</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 <p>
 135         Convenience header <code class="literal">&lt;<a href="../../../../../../boost/beast/websocket.hpp" target="_top">boost/beast/websocket.hpp</a>&gt;</code>
 136       </p>
 137 </div>
 138 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 139 <td align="left"></td>
 140 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Vinnie
 141       Falco<p>
 142         Distributed under the Boost Software License, Version 1.0. (See accompanying
 143         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>)
 144       </p>
 145 </div></td>
 146 </tr></table>
 147 <hr>
 148 <div class="spirit-nav">
 149 <a accesskey="p" href="boost__beast__async_detect_ssl.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__basic_flat_buffer.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
 150 </div>
 151 </body>
 152 </html>