diff options
| author | Anas Nashif <anas.nashif@intel.com> | 2012-10-30 12:57:26 -0700 |
|---|---|---|
| committer | Anas Nashif <anas.nashif@intel.com> | 2012-10-30 12:57:26 -0700 |
| commit | 1a78a62555be32868418fe52f8e330c9d0f95d5a (patch) | |
| tree | d3765a80e7d3b9640ec2e930743630cd6b9fce2b /doc/html/boost_asio/reference/posix__basic_descriptor/native_non_blocking | |
| download | boost-1a78a62555be32868418fe52f8e330c9d0f95d5a.tar.gz boost-1a78a62555be32868418fe52f8e330c9d0f95d5a.tar.bz2 boost-1a78a62555be32868418fe52f8e330c9d0f95d5a.zip | |
Imported Upstream version 1.49.0upstream/1.49.0
Diffstat (limited to 'doc/html/boost_asio/reference/posix__basic_descriptor/native_non_blocking')
3 files changed, 240 insertions, 0 deletions
diff --git a/doc/html/boost_asio/reference/posix__basic_descriptor/native_non_blocking/overload1.html b/doc/html/boost_asio/reference/posix__basic_descriptor/native_non_blocking/overload1.html new file mode 100755 index 0000000000..3fb41294d4 --- /dev/null +++ b/doc/html/boost_asio/reference/posix__basic_descriptor/native_non_blocking/overload1.html @@ -0,0 +1,73 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>posix::basic_descriptor::native_non_blocking (1 of 3 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../native_non_blocking.html" title="posix::basic_descriptor::native_non_blocking"> +<link rel="prev" href="../native_non_blocking.html" title="posix::basic_descriptor::native_non_blocking"> +<link rel="next" href="overload2.html" title="posix::basic_descriptor::native_non_blocking (2 of 3 overloads)"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../native_non_blocking.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../native_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> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.posix__basic_descriptor.native_non_blocking.overload1"></a><a class="link" href="overload1.html" title="posix::basic_descriptor::native_non_blocking (1 of 3 overloads)">posix::basic_descriptor::native_non_blocking + (1 of 3 overloads)</a> +</h5></div></div></div> +<p> + Gets the non-blocking mode of the native descriptor implementation. + </p> +<pre class="programlisting"><span class="keyword">bool</span> <span class="identifier">native_non_blocking</span><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span> +</pre> +<p> + This function is used to retrieve the non-blocking mode of the underlying + native descriptor. This mode has no effect on the behaviour of the descriptor + object's synchronous operations. + </p> +<h6> +<a name="boost_asio.reference.posix__basic_descriptor.native_non_blocking.overload1.h0"></a> + <span><a name="boost_asio.reference.posix__basic_descriptor.native_non_blocking.overload1.return_value"></a></span><a class="link" href="overload1.html#boost_asio.reference.posix__basic_descriptor.native_non_blocking.overload1.return_value">Return + Value</a> + </h6> +<p> + <code class="computeroutput"><span class="keyword">true</span></code> if the underlying descriptor + is in non-blocking mode and direct system calls may 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> (or the equivalent system + error). + </p> +<h6> +<a name="boost_asio.reference.posix__basic_descriptor.native_non_blocking.overload1.h1"></a> + <span><a name="boost_asio.reference.posix__basic_descriptor.native_non_blocking.overload1.remarks"></a></span><a class="link" href="overload1.html#boost_asio.reference.posix__basic_descriptor.native_non_blocking.overload1.remarks">Remarks</a> + </h6> +<p> + The current non-blocking mode is cached by the descriptor object. Consequently, + the return value may be incorrect if the non-blocking mode was set directly + on the native descriptor. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 Christopher M. Kohlhoff<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + 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>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../native_non_blocking.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../native_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> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/posix__basic_descriptor/native_non_blocking/overload2.html b/doc/html/boost_asio/reference/posix__basic_descriptor/native_non_blocking/overload2.html new file mode 100755 index 0000000000..9fe4bba854 --- /dev/null +++ b/doc/html/boost_asio/reference/posix__basic_descriptor/native_non_blocking/overload2.html @@ -0,0 +1,88 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>posix::basic_descriptor::native_non_blocking (2 of 3 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../native_non_blocking.html" title="posix::basic_descriptor::native_non_blocking"> +<link rel="prev" href="overload1.html" title="posix::basic_descriptor::native_non_blocking (1 of 3 overloads)"> +<link rel="next" href="overload3.html" title="posix::basic_descriptor::native_non_blocking (3 of 3 overloads)"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../native_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> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.posix__basic_descriptor.native_non_blocking.overload2"></a><a class="link" href="overload2.html" title="posix::basic_descriptor::native_non_blocking (2 of 3 overloads)">posix::basic_descriptor::native_non_blocking + (2 of 3 overloads)</a> +</h5></div></div></div> +<p> + Sets the non-blocking mode of the native descriptor implementation. + </p> +<pre class="programlisting"><span class="keyword">void</span> <span class="identifier">native_non_blocking</span><span class="special">(</span> + <span class="keyword">bool</span> <span class="identifier">mode</span><span class="special">);</span> +</pre> +<p> + This function is used to modify the non-blocking mode of the underlying + native descriptor. It has no effect on the behaviour of the descriptor + object's synchronous operations. + </p> +<h6> +<a name="boost_asio.reference.posix__basic_descriptor.native_non_blocking.overload2.h0"></a> + <span><a name="boost_asio.reference.posix__basic_descriptor.native_non_blocking.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.posix__basic_descriptor.native_non_blocking.overload2.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">mode</span></dt> +<dd><p> + If <code class="computeroutput"><span class="keyword">true</span></code>, the underlying + descriptor is put into non-blocking mode and direct system calls + may 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> + (or the equivalent system error). + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.posix__basic_descriptor.native_non_blocking.overload2.h1"></a> + <span><a name="boost_asio.reference.posix__basic_descriptor.native_non_blocking.overload2.exceptions"></a></span><a class="link" href="overload2.html#boost_asio.reference.posix__basic_descriptor.native_non_blocking.overload2.exceptions">Exceptions</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">boost::system::system_error</span></dt> +<dd><p> + Thrown on failure. If the <code class="computeroutput"><span class="identifier">mode</span></code> + is <code class="computeroutput"><span class="keyword">false</span></code>, but the + current value of <code class="computeroutput"><span class="identifier">non_blocking</span><span class="special">()</span></code> is <code class="computeroutput"><span class="keyword">true</span></code>, + this function fails 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">invalid_argument</span></code>, + as the combination does not make sense. + </p></dd> +</dl> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 Christopher M. Kohlhoff<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + 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>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../native_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> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/posix__basic_descriptor/native_non_blocking/overload3.html b/doc/html/boost_asio/reference/posix__basic_descriptor/native_non_blocking/overload3.html new file mode 100755 index 0000000000..ac2b645453 --- /dev/null +++ b/doc/html/boost_asio/reference/posix__basic_descriptor/native_non_blocking/overload3.html @@ -0,0 +1,79 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>posix::basic_descriptor::native_non_blocking (3 of 3 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../native_non_blocking.html" title="posix::basic_descriptor::native_non_blocking"> +<link rel="prev" href="overload2.html" title="posix::basic_descriptor::native_non_blocking (2 of 3 overloads)"> +<link rel="next" href="../native_type.html" title="posix::basic_descriptor::native_type"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="overload2.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../native_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="../native_type.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.posix__basic_descriptor.native_non_blocking.overload3"></a><a class="link" href="overload3.html" title="posix::basic_descriptor::native_non_blocking (3 of 3 overloads)">posix::basic_descriptor::native_non_blocking + (3 of 3 overloads)</a> +</h5></div></div></div> +<p> + Sets the non-blocking mode of the native descriptor implementation. + </p> +<pre class="programlisting"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span> <span class="identifier">native_non_blocking</span><span class="special">(</span> + <span class="keyword">bool</span> <span class="identifier">mode</span><span class="special">,</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span> <span class="identifier">ec</span><span class="special">);</span> +</pre> +<p> + This function is used to modify the non-blocking mode of the underlying + native descriptor. It has no effect on the behaviour of the descriptor + object's synchronous operations. + </p> +<h6> +<a name="boost_asio.reference.posix__basic_descriptor.native_non_blocking.overload3.h0"></a> + <span><a name="boost_asio.reference.posix__basic_descriptor.native_non_blocking.overload3.parameters"></a></span><a class="link" href="overload3.html#boost_asio.reference.posix__basic_descriptor.native_non_blocking.overload3.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">mode</span></dt> +<dd><p> + If <code class="computeroutput"><span class="keyword">true</span></code>, the underlying + descriptor is put into non-blocking mode and direct system calls + may 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> + (or the equivalent system error). + </p></dd> +<dt><span class="term">ec</span></dt> +<dd><p> + Set to indicate what error occurred, if any. If the <code class="computeroutput"><span class="identifier">mode</span></code> is <code class="computeroutput"><span class="keyword">false</span></code>, + but the current value of <code class="computeroutput"><span class="identifier">non_blocking</span><span class="special">()</span></code> is <code class="computeroutput"><span class="keyword">true</span></code>, + this function fails 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">invalid_argument</span></code>, + as the combination does not make sense. + </p></dd> +</dl> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2012 Christopher M. Kohlhoff<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + 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>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="overload2.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../native_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="../native_type.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> |