1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>basic_socket::close (2 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="../close.html" title="basic_socket::close"> 9<link rel="prev" href="overload1.html" title="basic_socket::close (1 of 2 overloads)"> 10<link rel="next" href="../connect.html" title="basic_socket::connect"> 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="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../close.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="../connect.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.close.overload2"></a><a class="link" href="overload2.html" title="basic_socket::close (2 of 2 overloads)">basic_socket::close 28 (2 of 2 overloads)</a> 29</h5></div></div></div> 30<p> 31 Close the socket. 32 </p> 33<pre class="programlisting">void close( 34 boost::system::error_code & ec); 35</pre> 36<p> 37 This function is used to close the socket. Any asynchronous send, receive 38 or connect operations will be cancelled immediately, and will complete 39 with the <code class="computeroutput">boost::asio::error::operation_aborted</code> error. 40 </p> 41<h6> 42<a name="boost_asio.reference.basic_socket.close.overload2.h0"></a> 43 <span class="phrase"><a name="boost_asio.reference.basic_socket.close.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_socket.close.overload2.parameters">Parameters</a> 44 </h6> 45<div class="variablelist"> 46<p class="title"><b></b></p> 47<dl class="variablelist"> 48<dt><span class="term">ec</span></dt> 49<dd><p> 50 Set to indicate what error occurred, if any. Note that, even if 51 the function indicates an error, the underlying descriptor is closed. 52 </p></dd> 53</dl> 54</div> 55<h6> 56<a name="boost_asio.reference.basic_socket.close.overload2.h1"></a> 57 <span class="phrase"><a name="boost_asio.reference.basic_socket.close.overload2.example"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_socket.close.overload2.example">Example</a> 58 </h6> 59<pre class="programlisting">boost::asio::ip::tcp::socket socket(my_context); 60... 61boost::system::error_code ec; 62socket.close(ec); 63if (ec) 64{ 65 // An error occurred. 66} 67</pre> 68<h6> 69<a name="boost_asio.reference.basic_socket.close.overload2.h2"></a> 70 <span class="phrase"><a name="boost_asio.reference.basic_socket.close.overload2.remarks"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_socket.close.overload2.remarks">Remarks</a> 71 </h6> 72<p> 73 For portable behaviour with respect to graceful closure of a connected 74 socket, call <code class="computeroutput">shutdown()</code> before closing the socket. 75 </p> 76</div> 77<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 78<td align="left"></td> 79<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M. 80 Kohlhoff<p> 81 Distributed under the Boost Software License, Version 1.0. (See accompanying 82 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>) 83 </p> 84</div></td> 85</tr></table> 86<hr> 87<div class="spirit-nav"> 88<a accesskey="p" href="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../close.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="../connect.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 89</div> 90</body> 91</html> 92
