• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
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 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__get_lowest_layer.html" title="get_lowest_layer">
10<link rel="next" href="boost__beast__close_socket.html" title="close_socket">
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__get_lowest_layer.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__close_socket.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="idm46057510912384"></a>
31      </p>
32<p>
33        Default socket close function.
34      </p>
35<h5>
36<a name="beast.ref.boost__beast__beast_close_socket.h0"></a>
37        <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>
38      </h5>
39<p>
40        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>
41      </p>
42<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
43    <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>
44    <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>
45<span class="keyword">void</span>
46<span class="identifier">beast_close_socket</span><span class="special">(</span>
47    <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>
48</pre>
49<h5>
50<a name="beast.ref.boost__beast__beast_close_socket.h1"></a>
51        <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>
52      </h5>
53<p>
54        This function is not meant to be called directly. Instead, it is called automatically
55        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
56        of user-defined types or classes derived from a particular user-defined type,
57        this function should be overloaded in the corresponding namespace for the
58        type in question.
59      </p>
60<h5>
61<a name="beast.ref.boost__beast__beast_close_socket.h2"></a>
62        <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
63        Also</a>
64      </h5>
65<p>
66        <a class="link" href="boost__beast__close_socket.html" title="close_socket"><code class="computeroutput"><span class="identifier">close_socket</span></code></a>
67      </p>
68</div>
69<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
70<td align="left"></td>
71<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie
72      Falco<p>
73        Distributed under the Boost Software License, Version 1.0. (See accompanying
74        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>)
75      </p>
76</div></td>
77</tr></table>
78<hr>
79<div class="spirit-nav">
80<a accesskey="p" href="boost__beast__get_lowest_layer.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__close_socket.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
81</div>
82</body>
83</html>
84