• 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::release (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="../release.html" title="basic_socket::release">
9<link rel="prev" href="../release.html" title="basic_socket::release">
10<link rel="next" href="overload2.html" title="basic_socket::release (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="../release.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../release.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.release.overload1"></a><a class="link" href="overload1.html" title="basic_socket::release (1 of 2 overloads)">basic_socket::release
28          (1 of 2 overloads)</a>
29</h5></div></div></div>
30<p>
31            Release ownership of the underlying native socket.
32          </p>
33<pre class="programlisting">native_handle_type release();
34</pre>
35<p>
36            This function causes all outstanding asynchronous connect, send and receive
37            operations to finish immediately, and the handlers for cancelled operations
38            will be passed the <code class="computeroutput">boost::asio::error::operation_aborted</code>
39            error. Ownership of the native socket is then transferred to the caller.
40          </p>
41<h6>
42<a name="boost_asio.reference.basic_socket.release.overload1.h0"></a>
43            <span class="phrase"><a name="boost_asio.reference.basic_socket.release.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_socket.release.overload1.exceptions">Exceptions</a>
44          </h6>
45<div class="variablelist">
46<p class="title"><b></b></p>
47<dl class="variablelist">
48<dt><span class="term">boost::system::system_error</span></dt>
49<dd><p>
50                  Thrown on failure.
51                </p></dd>
52</dl>
53</div>
54<h6>
55<a name="boost_asio.reference.basic_socket.release.overload1.h1"></a>
56            <span class="phrase"><a name="boost_asio.reference.basic_socket.release.overload1.remarks"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_socket.release.overload1.remarks">Remarks</a>
57          </h6>
58<p>
59            This function is unsupported on Windows versions prior to Windows 8.1,
60            and will fail with <code class="computeroutput">boost::asio::error::operation_not_supported</code>
61            on these platforms.
62          </p>
63</div>
64<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
65<td align="left"></td>
66<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M.
67      Kohlhoff<p>
68        Distributed under the Boost Software License, Version 1.0. (See accompanying
69        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>)
70      </p>
71</div></td>
72</tr></table>
73<hr>
74<div class="spirit-nav">
75<a accesskey="p" href="../release.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../release.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>
76</div>
77</body>
78</html>
79