libs/beast/doc/html/beast/ref/boost__beast__beast_close_socket.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>beast_close_socket</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__basic_string_view.html" title="basic_string_view">
  10 <link rel="next" href="boost__beast__bind_front_handler.html" title="bind_front_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__basic_string_view.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__bind_front_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__beast_close_socket"></a><a class="link" href="boost__beast__beast_close_socket.html" title="beast_close_socket">beast_close_socket</a>
  28 </h4></div></div></div>
  29 <p>
  30         <a class="indexterm" name="idm45873514152528"></a>
  31 Default socket close function.
  32       </p>
  33 <h5>
  34 <a name="beast.ref.boost__beast__beast_close_socket.h0"></a>
  35         <span class="phrase"><a name="beast.ref.boost__beast__beast_close_socket.synopsis"></a></span><a class="link" href="boost__beast__beast_close_socket.html#beast.ref.boost__beast__beast_close_socket.synopsis">Synopsis</a>
  36       </h5>
  37 <p>
  38         Defined in header <code class="literal">&lt;<a href="../../../../../../boost/beast/core/stream_traits.hpp" target="_top">boost/beast/core/stream_traits.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 href="../../../../../../doc/html/boost_asio/reference/Protocol.html" target="_top"><span class="emphasis"><em>Protocol</em></span></a><span class="special">,</span>
  42     <span class="keyword">class</span> <a href="../../../../../../doc/html/boost_asio/reference/Executor1.html" target="_top"><span class="emphasis"><em>Executor</em></span></a><span class="special">&gt;</span>
  43 <span class="keyword">void</span>
  44 <span class="identifier">beast_close_socket</span><span class="special">(</span>
  45     <span class="identifier">net</span><span class="special">::</span><span class="identifier">basic_socket</span><span class="special">&lt;</span> <span class="identifier">Protocol</span><span class="special">,</span> <span class="identifier">Executor</span> <span class="special">&gt;&amp;</span> <span class="identifier">sock</span><span class="special">);</span>
  46 </pre>
  47 <h5>
  48 <a name="beast.ref.boost__beast__beast_close_socket.h1"></a>
  49         <span class="phrase"><a name="beast.ref.boost__beast__beast_close_socket.description"></a></span><a class="link" href="boost__beast__beast_close_socket.html#beast.ref.boost__beast__beast_close_socket.description">Description</a>
  50       </h5>
  51 <p>
  52         This function is not meant to be called directly. Instead, it is called automatically
  53         when using <a class="link" href="boost__beast__close_socket.html" title="close_socket"><code class="computeroutput"><span class="identifier">close_socket</span></code></a>. To enable closure
  54         of user-defined types or classes derived from a particular user-defined type,
  55         this function should be overloaded in the corresponding namespace for the
  56         type in question.
  57       </p>
  58 <h5>
  59 <a name="beast.ref.boost__beast__beast_close_socket.h2"></a>
  60         <span class="phrase"><a name="beast.ref.boost__beast__beast_close_socket.see_also"></a></span><a class="link" href="boost__beast__beast_close_socket.html#beast.ref.boost__beast__beast_close_socket.see_also">See
  61         Also</a>
  62       </h5>
  63 <p>
  64         <a class="link" href="boost__beast__close_socket.html" title="close_socket"><code class="computeroutput"><span class="identifier">close_socket</span></code></a>
  65       </p>
  66 <p>
  67         Convenience header <code class="literal">&lt;<a href="../../../../../../boost/beast/core.hpp" target="_top">boost/beast/core.hpp</a>&gt;</code>
  68       </p>
  69 </div>
  70 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  71 <td align="left"></td>
  72 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Vinnie
  73       Falco<p>
  74         Distributed under the Boost Software License, Version 1.0. (See accompanying
  75         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>)
  76       </p>
  77 </div></td>
  78 </tr></table>
  79 <hr>
  80 <div class="spirit-nav">
  81 <a accesskey="p" href="boost__beast__basic_string_view.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__bind_front_handler.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  82 </div>
  83 </body>
  84 </html>