libs/beast/doc/html/beast/ref/boost__beast__teardown.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>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__tcp_stream.html" title="tcp_stream">
  10 <link rel="next" href="boost__beast__test__any_handler.html" title="test::any_handler">
  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__tcp_stream.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__test__any_handler.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__teardown"></a><a class="link" href="boost__beast__teardown.html" title="teardown">teardown</a>
  28 </h4></div></div></div>
  29 <p>
  30         <a class="indexterm" name="idm45873477904192"></a>
  31 Tear 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__teardown.h0"></a>
  35         <span class="phrase"><a name="beast.ref.boost__beast__teardown.synopsis"></a></span><a class="link" href="boost__beast__teardown.html#beast.ref.boost__beast__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.SyncStream"><span class="emphasis"><em>SyncStream</em></span></a><span class="special">&gt;</span>
  42 <span class="keyword">void</span>
  43 <span class="identifier">teardown</span><span class="special">(</span>
  44     <span class="identifier">role_type</span> <span class="identifier">role</span><span class="special">,</span>
  45     <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">SyncStream</span> <span class="special">&gt;&amp;</span> <span class="identifier">stream</span><span class="special">,</span>
  46     <span class="identifier">error_code</span><span class="special">&amp;</span> <span class="identifier">ec</span><span class="special">);</span>
  47 </pre>
  48 <h5>
  49 <a name="beast.ref.boost__beast__teardown.h1"></a>
  50         <span class="phrase"><a name="beast.ref.boost__beast__teardown.description"></a></span><a class="link" href="boost__beast__teardown.html#beast.ref.boost__beast__teardown.description">Description</a>
  51       </h5>
  52 <p>
  53         This tears down a connection. The implementation will call the overload of
  54         this function based on the <code class="computeroutput"><span class="identifier">Stream</span></code>
  55         parameter used to consruct the socket. When <code class="computeroutput"><span class="identifier">Stream</span></code>
  56         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>
  57         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>,
  58         callers are responsible for providing a suitable overload of this function.
  59       </p>
  60 <h5>
  61 <a name="beast.ref.boost__beast__teardown.h2"></a>
  62         <span class="phrase"><a name="beast.ref.boost__beast__teardown.parameters"></a></span><a class="link" href="boost__beast__teardown.html#beast.ref.boost__beast__teardown.parameters">Parameters</a>
  63       </h5>
  64 <div class="informaltable"><table class="table">
  65 <colgroup>
  66 <col>
  67 <col>
  68 </colgroup>
  69 <thead><tr>
  70 <th>
  71                 <p>
  72                   Name
  73                 </p>
  74               </th>
  75 <th>
  76                 <p>
  77                   Description
  78                 </p>
  79               </th>
  80 </tr></thead>
  81 <tbody>
  82 <tr>
  83 <td>
  84                 <p>
  85                   <code class="computeroutput"><span class="identifier">role</span></code>
  86                 </p>
  87               </td>
  88 <td>
  89                 <p>
  90                   The role of the local endpoint
  91                 </p>
  92               </td>
  93 </tr>
  94 <tr>
  95 <td>
  96                 <p>
  97                   <code class="computeroutput"><span class="identifier">stream</span></code>
  98                 </p>
  99               </td>
 100 <td>
 101                 <p>
 102                   The stream to tear down.
 103                 </p>
 104               </td>
 105 </tr>
 106 <tr>
 107 <td>
 108                 <p>
 109                   <code class="computeroutput"><span class="identifier">ec</span></code>
 110                 </p>
 111               </td>
 112 <td>
 113                 <p>
 114                   Set to the error if any occurred.
 115                 </p>
 116               </td>
 117 </tr>
 118 </tbody>
 119 </table></div>
 120 <p>
 121         Convenience header <code class="literal">&lt;<a href="../../../../../../boost/beast/websocket.hpp" target="_top">boost/beast/websocket.hpp</a>&gt;</code>
 122       </p>
 123 </div>
 124 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 125 <td align="left"></td>
 126 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Vinnie
 127       Falco<p>
 128         Distributed under the Boost Software License, Version 1.0. (See accompanying
 129         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>)
 130       </p>
 131 </div></td>
 132 </tr></table>
 133 <hr>
 134 <div class="spirit-nav">
 135 <a accesskey="p" href="boost__beast__tcp_stream.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__test__any_handler.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
 136 </div>
 137 </body>
 138 </html>