• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>basic_socket::shutdown (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="../../../../boost_asio.html" title="Boost.Asio">
8<link rel="up" href="../shutdown.html" title="basic_socket::shutdown">
9<link rel="prev" href="../shutdown.html" title="basic_socket::shutdown">
10<link rel="next" href="overload2.html" title="basic_socket::shutdown (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="../shutdown.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../shutdown.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.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="boost_asio.reference.basic_socket.shutdown.overload1"></a><a class="link" href="overload1.html" title="basic_socket::shutdown (1 of 2 overloads)">basic_socket::shutdown
28          (1 of 2 overloads)</a>
29</h5></div></div></div>
30<p>
31            Disable sends or receives on the socket.
32          </p>
33<pre class="programlisting">void shutdown(
34    shutdown_type what);
35</pre>
36<p>
37            This function is used to disable send operations, receive operations,
38            or both.
39          </p>
40<h6>
41<a name="boost_asio.reference.basic_socket.shutdown.overload1.h0"></a>
42            <span class="phrase"><a name="boost_asio.reference.basic_socket.shutdown.overload1.parameters"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_socket.shutdown.overload1.parameters">Parameters</a>
43          </h6>
44<div class="variablelist">
45<p class="title"><b></b></p>
46<dl class="variablelist">
47<dt><span class="term">what</span></dt>
48<dd><p>
49                  Determines what types of operation will no longer be allowed.
50                </p></dd>
51</dl>
52</div>
53<h6>
54<a name="boost_asio.reference.basic_socket.shutdown.overload1.h1"></a>
55            <span class="phrase"><a name="boost_asio.reference.basic_socket.shutdown.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_socket.shutdown.overload1.exceptions">Exceptions</a>
56          </h6>
57<div class="variablelist">
58<p class="title"><b></b></p>
59<dl class="variablelist">
60<dt><span class="term">boost::system::system_error</span></dt>
61<dd><p>
62                  Thrown on failure.
63                </p></dd>
64</dl>
65</div>
66<h6>
67<a name="boost_asio.reference.basic_socket.shutdown.overload1.h2"></a>
68            <span class="phrase"><a name="boost_asio.reference.basic_socket.shutdown.overload1.example"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_socket.shutdown.overload1.example">Example</a>
69          </h6>
70<p>
71            Shutting down the send side of the socket:
72          </p>
73<pre class="programlisting">boost::asio::ip::tcp::socket socket(my_context);
74...
75socket.shutdown(boost::asio::ip::tcp::socket::shutdown_send);
76</pre>
77</div>
78<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
79<td align="left"></td>
80<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M.
81      Kohlhoff<p>
82        Distributed under the Boost Software License, Version 1.0. (See accompanying
83        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>)
84      </p>
85</div></td>
86</tr></table>
87<hr>
88<div class="spirit-nav">
89<a accesskey="p" href="../shutdown.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../shutdown.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.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>
90</div>
91</body>
92</html>
93