• 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_raw_socket::non_blocking (2 of 3 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="../non_blocking.html" title="basic_raw_socket::non_blocking">
9<link rel="prev" href="overload1.html" title="basic_raw_socket::non_blocking (1 of 3 overloads)">
10<link rel="next" href="overload3.html" title="basic_raw_socket::non_blocking (3 of 3 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="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../non_blocking.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="overload3.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_raw_socket.non_blocking.overload2"></a><a class="link" href="overload2.html" title="basic_raw_socket::non_blocking (2 of 3 overloads)">basic_raw_socket::non_blocking
28          (2 of 3 overloads)</a>
29</h5></div></div></div>
30<p>
31            <span class="emphasis"><em>Inherited from basic_socket.</em></span>
32          </p>
33<p>
34            Sets the non-blocking mode of the socket.
35          </p>
36<pre class="programlisting">void non_blocking(
37    bool mode);
38</pre>
39<h6>
40<a name="boost_asio.reference.basic_raw_socket.non_blocking.overload2.h0"></a>
41            <span class="phrase"><a name="boost_asio.reference.basic_raw_socket.non_blocking.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_raw_socket.non_blocking.overload2.parameters">Parameters</a>
42          </h6>
43<div class="variablelist">
44<p class="title"><b></b></p>
45<dl class="variablelist">
46<dt><span class="term">mode</span></dt>
47<dd><p>
48                  If <code class="computeroutput">true</code>, the socket's synchronous operations will
49                  fail with <code class="computeroutput">boost::asio::error::would_block</code> if they
50                  are unable to perform the requested operation immediately. If
51                  <code class="computeroutput">false</code>, synchronous operations will block until complete.
52                </p></dd>
53</dl>
54</div>
55<h6>
56<a name="boost_asio.reference.basic_raw_socket.non_blocking.overload2.h1"></a>
57            <span class="phrase"><a name="boost_asio.reference.basic_raw_socket.non_blocking.overload2.exceptions"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_raw_socket.non_blocking.overload2.exceptions">Exceptions</a>
58          </h6>
59<div class="variablelist">
60<p class="title"><b></b></p>
61<dl class="variablelist">
62<dt><span class="term">boost::system::system_error</span></dt>
63<dd><p>
64                  Thrown on failure.
65                </p></dd>
66</dl>
67</div>
68<h6>
69<a name="boost_asio.reference.basic_raw_socket.non_blocking.overload2.h2"></a>
70            <span class="phrase"><a name="boost_asio.reference.basic_raw_socket.non_blocking.overload2.remarks"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_raw_socket.non_blocking.overload2.remarks">Remarks</a>
71          </h6>
72<p>
73            The non-blocking mode has no effect on the behaviour of asynchronous
74            operations. Asynchronous operations will never fail with the error <code class="computeroutput">boost::asio::error::would_block</code>.
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="../non_blocking.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="overload3.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
89</div>
90</body>
91</html>
92