doc/html/boost_asio/reference/basic_stream_socket/non_blocking/overload1.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>basic_stream_socket::non_blocking (1 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.76.1">
   7 <link rel="home" href="../../../../boost_asio.html" title="Boost.Asio">
   8 <link rel="up" href="../non_blocking.html" title="basic_stream_socket::non_blocking">
   9 <link rel="prev" href="../non_blocking.html" title="basic_stream_socket::non_blocking">
  10 <link rel="next" href="overload2.html" title="basic_stream_socket::non_blocking (2 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="../non_blocking.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="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_stream_socket.non_blocking.overload1"></a><a class="link" href="overload1.html" title="basic_stream_socket::non_blocking (1 of 3 overloads)">basic_stream_socket::non_blocking
  28           (1 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             Gets the non-blocking mode of the socket.
  35           </p>
  36 <pre class="programlisting"><span class="keyword">bool</span> <span class="identifier">non_blocking</span><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span>
  37 </pre>
  38 <h6>
  39 <a name="boost_asio.reference.basic_stream_socket.non_blocking.overload1.h0"></a>
  40             <span><a name="boost_asio.reference.basic_stream_socket.non_blocking.overload1.return_value"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_stream_socket.non_blocking.overload1.return_value">Return
  41             Value</a>
  42           </h6>
  43 <p>
  44             <code class="computeroutput"><span class="keyword">true</span></code> if the socket's synchronous
  45             operations will fail with <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">error</span><span class="special">::</span><span class="identifier">would_block</span></code>
  46             if they are unable to perform the requested operation immediately. If
  47             <code class="computeroutput"><span class="keyword">false</span></code>, synchronous operations
  48             will block until complete.
  49           </p>
  50 <h6>
  51 <a name="boost_asio.reference.basic_stream_socket.non_blocking.overload1.h1"></a>
  52             <span><a name="boost_asio.reference.basic_stream_socket.non_blocking.overload1.remarks"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_stream_socket.non_blocking.overload1.remarks">Remarks</a>
  53           </h6>
  54 <p>
  55             The non-blocking mode has no effect on the behaviour of asynchronous
  56             operations. Asynchronous operations will never fail with the error <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">error</span><span class="special">::</span><span class="identifier">would_block</span></code>.
  57           </p>
  58 </div>
  59 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  60 <td align="left"></td>
  61 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2012 Christopher M. Kohlhoff<p>
  62         Distributed under the Boost Software License, Version 1.0. (See accompanying
  63         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>)
  64       </p>
  65 </div></td>
  66 </tr></table>
  67 <hr>
  68 <div class="spirit-nav">
  69 <a accesskey="p" href="../non_blocking.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="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  70 </div>
  71 </body>
  72 </html>