diff options
Diffstat (limited to 'doc/html/boost_asio/reference/posix__basic_stream_descriptor')
56 files changed, 4396 insertions, 0 deletions
diff --git a/doc/html/boost_asio/reference/posix__basic_stream_descriptor/assign.html b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/assign.html new file mode 100755 index 0000000000..97a70a08da --- /dev/null +++ b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/assign.html @@ -0,0 +1,57 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>posix::basic_stream_descriptor::assign</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="../posix__basic_stream_descriptor.html" title="posix::basic_stream_descriptor"> +<link rel="prev" href="../posix__basic_stream_descriptor.html" title="posix::basic_stream_descriptor"> +<link rel="next" href="assign/overload1.html" title="posix::basic_stream_descriptor::assign (1 of 2 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="../posix__basic_stream_descriptor.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_stream_descriptor.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="assign/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.posix__basic_stream_descriptor.assign"></a><a class="link" href="assign.html" title="posix::basic_stream_descriptor::assign">posix::basic_stream_descriptor::assign</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1466316"></a> +Assign an existing native descriptor + to the descriptor. + </p> +<pre class="programlisting"><span class="keyword">void</span> <a class="link" href="assign/overload1.html" title="posix::basic_stream_descriptor::assign (1 of 2 overloads)">assign</a><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">native_handle_type</span> <span class="special">&</span> <span class="identifier">native_descriptor</span><span class="special">);</span> + <span class="emphasis"><em>» <a class="link" href="assign/overload1.html" title="posix::basic_stream_descriptor::assign (1 of 2 overloads)">more...</a></em></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> <a class="link" href="assign/overload2.html" title="posix::basic_stream_descriptor::assign (2 of 2 overloads)">assign</a><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">native_handle_type</span> <span class="special">&</span> <span class="identifier">native_descriptor</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> + <span class="emphasis"><em>» <a class="link" href="assign/overload2.html" title="posix::basic_stream_descriptor::assign (2 of 2 overloads)">more...</a></em></span> +</pre> +</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="../posix__basic_stream_descriptor.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_stream_descriptor.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="assign/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/posix__basic_stream_descriptor/assign/overload1.html b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/assign/overload1.html new file mode 100755 index 0000000000..bbdeeaf2de --- /dev/null +++ b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/assign/overload1.html @@ -0,0 +1,53 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>posix::basic_stream_descriptor::assign (1 of 2 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="../assign.html" title="posix::basic_stream_descriptor::assign"> +<link rel="prev" href="../assign.html" title="posix::basic_stream_descriptor::assign"> +<link rel="next" href="overload2.html" title="posix::basic_stream_descriptor::assign (2 of 2 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="../assign.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../assign.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_stream_descriptor.assign.overload1"></a><a class="link" href="overload1.html" title="posix::basic_stream_descriptor::assign (1 of 2 overloads)">posix::basic_stream_descriptor::assign + (1 of 2 overloads)</a> +</h5></div></div></div> +<p> + <span class="emphasis"><em>Inherited from posix::basic_descriptor.</em></span> + </p> +<p> + Assign an existing native descriptor to the descriptor. + </p> +<pre class="programlisting"><span class="keyword">void</span> <span class="identifier">assign</span><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">native_handle_type</span> <span class="special">&</span> <span class="identifier">native_descriptor</span><span class="special">);</span> +</pre> +</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="../assign.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../assign.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_stream_descriptor/assign/overload2.html b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/assign/overload2.html new file mode 100755 index 0000000000..263752db4e --- /dev/null +++ b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/assign/overload2.html @@ -0,0 +1,54 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>posix::basic_stream_descriptor::assign (2 of 2 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="../assign.html" title="posix::basic_stream_descriptor::assign"> +<link rel="prev" href="overload1.html" title="posix::basic_stream_descriptor::assign (1 of 2 overloads)"> +<link rel="next" href="../async_read_some.html" title="posix::basic_stream_descriptor::async_read_some"> +</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="../assign.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="../async_read_some.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_stream_descriptor.assign.overload2"></a><a class="link" href="overload2.html" title="posix::basic_stream_descriptor::assign (2 of 2 overloads)">posix::basic_stream_descriptor::assign + (2 of 2 overloads)</a> +</h5></div></div></div> +<p> + <span class="emphasis"><em>Inherited from posix::basic_descriptor.</em></span> + </p> +<p> + Assign an existing native descriptor to the descriptor. + </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">assign</span><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">native_handle_type</span> <span class="special">&</span> <span class="identifier">native_descriptor</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> +</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="../assign.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="../async_read_some.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/posix__basic_stream_descriptor/async_read_some.html b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/async_read_some.html new file mode 100755 index 0000000000..d7acba76ae --- /dev/null +++ b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/async_read_some.html @@ -0,0 +1,117 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>posix::basic_stream_descriptor::async_read_some</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="../posix__basic_stream_descriptor.html" title="posix::basic_stream_descriptor"> +<link rel="prev" href="assign/overload2.html" title="posix::basic_stream_descriptor::assign (2 of 2 overloads)"> +<link rel="next" href="async_write_some.html" title="posix::basic_stream_descriptor::async_write_some"> +</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="assign/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_stream_descriptor.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="async_write_some.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.posix__basic_stream_descriptor.async_read_some"></a><a class="link" href="async_read_some.html" title="posix::basic_stream_descriptor::async_read_some">posix::basic_stream_descriptor::async_read_some</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1466744"></a> +Start an asynchronous read. + </p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> + <span class="keyword">typename</span> <a class="link" href="../MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a><span class="special">,</span> + <span class="keyword">typename</span> <a class="link" href="../ReadHandler.html" title="Read handler requirements">ReadHandler</a><span class="special">></span> +<span class="keyword">void</span> <span class="identifier">async_read_some</span><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">MutableBufferSequence</span> <span class="special">&</span> <span class="identifier">buffers</span><span class="special">,</span> + <span class="identifier">ReadHandler</span> <span class="identifier">handler</span><span class="special">);</span> +</pre> +<p> + This function is used to asynchronously read data from the stream descriptor. + The function call always returns immediately. + </p> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.async_read_some.h0"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.async_read_some.parameters"></a></span><a class="link" href="async_read_some.html#boost_asio.reference.posix__basic_stream_descriptor.async_read_some.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">buffers</span></dt> +<dd><p> + One or more buffers into which the data will be read. Although the + buffers object may be copied as necessary, ownership of the underlying + memory blocks is retained by the caller, which must guarantee that + they remain valid until the handler is called. + </p></dd> +<dt><span class="term">handler</span></dt> +<dd> +<p> + The handler to be called when the read operation completes. Copies + will be made of the handler as required. The function signature of + the handler must be: +</p> +<pre class="programlisting"><span class="keyword">void</span> <span class="identifier">handler</span><span class="special">(</span> + <span class="keyword">const</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">error</span><span class="special">,</span> <span class="comment">// Result of operation.</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">bytes_transferred</span> <span class="comment">// Number of bytes read.</span> +<span class="special">);</span> +</pre> +<p> + Regardless of whether the asynchronous operation completes immediately + or not, the handler will not be invoked from within this function. + Invocation of the handler will be performed in a manner equivalent + to using <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span><span class="special">::</span><span class="identifier">post</span><span class="special">()</span></code>. + </p> +</dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.async_read_some.h1"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.async_read_some.remarks"></a></span><a class="link" href="async_read_some.html#boost_asio.reference.posix__basic_stream_descriptor.async_read_some.remarks">Remarks</a> + </h6> +<p> + The read operation may not read all of the requested number of bytes. Consider + using the <a class="link" href="../async_read.html" title="async_read"><code class="computeroutput"><span class="identifier">async_read</span></code></a> function if you need + to ensure that the requested amount of data is read before the asynchronous + operation completes. + </p> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.async_read_some.h2"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.async_read_some.example"></a></span><a class="link" href="async_read_some.html#boost_asio.reference.posix__basic_stream_descriptor.async_read_some.example">Example</a> + </h6> +<p> + To read into a single data buffer use the <a class="link" href="../buffer.html" title="buffer"><code class="computeroutput"><span class="identifier">buffer</span></code></a> function as follows: + </p> +<pre class="programlisting"><span class="identifier">descriptor</span><span class="special">.</span><span class="identifier">async_read_some</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">buffer</span><span class="special">(</span><span class="identifier">data</span><span class="special">,</span> <span class="identifier">size</span><span class="special">),</span> <span class="identifier">handler</span><span class="special">);</span> +</pre> +<p> + See the <a class="link" href="../buffer.html" title="buffer"><code class="computeroutput"><span class="identifier">buffer</span></code></a> + documentation for information on reading into multiple buffers in one go, + and how to use it with arrays, boost::array or std::vector. + </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="assign/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_stream_descriptor.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="async_write_some.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/posix__basic_stream_descriptor/async_write_some.html b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/async_write_some.html new file mode 100755 index 0000000000..394b3a730a --- /dev/null +++ b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/async_write_some.html @@ -0,0 +1,116 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>posix::basic_stream_descriptor::async_write_some</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="../posix__basic_stream_descriptor.html" title="posix::basic_stream_descriptor"> +<link rel="prev" href="async_read_some.html" title="posix::basic_stream_descriptor::async_read_some"> +<link rel="next" href="basic_stream_descriptor.html" title="posix::basic_stream_descriptor::basic_stream_descriptor"> +</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="async_read_some.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_stream_descriptor.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="basic_stream_descriptor.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.posix__basic_stream_descriptor.async_write_some"></a><a class="link" href="async_write_some.html" title="posix::basic_stream_descriptor::async_write_some">posix::basic_stream_descriptor::async_write_some</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1467306"></a> +Start an asynchronous write. + </p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> + <span class="keyword">typename</span> <a class="link" href="../ConstBufferSequence.html" title="Constant buffer sequence requirements">ConstBufferSequence</a><span class="special">,</span> + <span class="keyword">typename</span> <a class="link" href="../WriteHandler.html" title="Write handler requirements">WriteHandler</a><span class="special">></span> +<span class="keyword">void</span> <span class="identifier">async_write_some</span><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">ConstBufferSequence</span> <span class="special">&</span> <span class="identifier">buffers</span><span class="special">,</span> + <span class="identifier">WriteHandler</span> <span class="identifier">handler</span><span class="special">);</span> +</pre> +<p> + This function is used to asynchronously write data to the stream descriptor. + The function call always returns immediately. + </p> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.async_write_some.h0"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.async_write_some.parameters"></a></span><a class="link" href="async_write_some.html#boost_asio.reference.posix__basic_stream_descriptor.async_write_some.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">buffers</span></dt> +<dd><p> + One or more data buffers to be written to the descriptor. Although + the buffers object may be copied as necessary, ownership of the underlying + memory blocks is retained by the caller, which must guarantee that + they remain valid until the handler is called. + </p></dd> +<dt><span class="term">handler</span></dt> +<dd> +<p> + The handler to be called when the write operation completes. Copies + will be made of the handler as required. The function signature of + the handler must be: +</p> +<pre class="programlisting"><span class="keyword">void</span> <span class="identifier">handler</span><span class="special">(</span> + <span class="keyword">const</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">error</span><span class="special">,</span> <span class="comment">// Result of operation.</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">bytes_transferred</span> <span class="comment">// Number of bytes written.</span> +<span class="special">);</span> +</pre> +<p> + Regardless of whether the asynchronous operation completes immediately + or not, the handler will not be invoked from within this function. + Invocation of the handler will be performed in a manner equivalent + to using <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span><span class="special">::</span><span class="identifier">post</span><span class="special">()</span></code>. + </p> +</dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.async_write_some.h1"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.async_write_some.remarks"></a></span><a class="link" href="async_write_some.html#boost_asio.reference.posix__basic_stream_descriptor.async_write_some.remarks">Remarks</a> + </h6> +<p> + The write operation may not transmit all of the data to the peer. Consider + using the <a class="link" href="../async_write.html" title="async_write"><code class="computeroutput"><span class="identifier">async_write</span></code></a> function if you need + to ensure that all data is written before the asynchronous operation completes. + </p> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.async_write_some.h2"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.async_write_some.example"></a></span><a class="link" href="async_write_some.html#boost_asio.reference.posix__basic_stream_descriptor.async_write_some.example">Example</a> + </h6> +<p> + To write a single data buffer use the <a class="link" href="../buffer.html" title="buffer"><code class="computeroutput"><span class="identifier">buffer</span></code></a> function as follows: + </p> +<pre class="programlisting"><span class="identifier">descriptor</span><span class="special">.</span><span class="identifier">async_write_some</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">buffer</span><span class="special">(</span><span class="identifier">data</span><span class="special">,</span> <span class="identifier">size</span><span class="special">),</span> <span class="identifier">handler</span><span class="special">);</span> +</pre> +<p> + See the <a class="link" href="../buffer.html" title="buffer"><code class="computeroutput"><span class="identifier">buffer</span></code></a> + documentation for information on writing multiple buffers in one go, and + how to use it with arrays, boost::array or std::vector. + </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="async_read_some.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_stream_descriptor.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="basic_stream_descriptor.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/posix__basic_stream_descriptor/basic_stream_descriptor.html b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/basic_stream_descriptor.html new file mode 100755 index 0000000000..2d16eba522 --- /dev/null +++ b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/basic_stream_descriptor.html @@ -0,0 +1,68 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>posix::basic_stream_descriptor::basic_stream_descriptor</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="../posix__basic_stream_descriptor.html" title="posix::basic_stream_descriptor"> +<link rel="prev" href="async_write_some.html" title="posix::basic_stream_descriptor::async_write_some"> +<link rel="next" href="basic_stream_descriptor/overload1.html" title="posix::basic_stream_descriptor::basic_stream_descriptor (1 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="async_write_some.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_stream_descriptor.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="basic_stream_descriptor/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.posix__basic_stream_descriptor.basic_stream_descriptor"></a><a class="link" href="basic_stream_descriptor.html" title="posix::basic_stream_descriptor::basic_stream_descriptor">posix::basic_stream_descriptor::basic_stream_descriptor</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1468139"></a> +Construct a <a class="link" href="../posix__basic_stream_descriptor.html" title="posix::basic_stream_descriptor"><code class="computeroutput"><span class="identifier">posix</span><span class="special">::</span><span class="identifier">basic_stream_descriptor</span></code></a> without + opening it. + </p> +<pre class="programlisting"><span class="keyword">explicit</span> <a class="link" href="basic_stream_descriptor/overload1.html" title="posix::basic_stream_descriptor::basic_stream_descriptor (1 of 3 overloads)">basic_stream_descriptor</a><span class="special">(</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span> <span class="special">&</span> <span class="identifier">io_service</span><span class="special">);</span> + <span class="emphasis"><em>» <a class="link" href="basic_stream_descriptor/overload1.html" title="posix::basic_stream_descriptor::basic_stream_descriptor (1 of 3 overloads)">more...</a></em></span> +</pre> +<p> + Construct a <a class="link" href="../posix__basic_stream_descriptor.html" title="posix::basic_stream_descriptor"><code class="computeroutput"><span class="identifier">posix</span><span class="special">::</span><span class="identifier">basic_stream_descriptor</span></code></a> on an + existing native descriptor. + </p> +<pre class="programlisting"><a class="link" href="basic_stream_descriptor/overload2.html" title="posix::basic_stream_descriptor::basic_stream_descriptor (2 of 3 overloads)">basic_stream_descriptor</a><span class="special">(</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span> <span class="special">&</span> <span class="identifier">io_service</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">native_handle_type</span> <span class="special">&</span> <span class="identifier">native_descriptor</span><span class="special">);</span> + <span class="emphasis"><em>» <a class="link" href="basic_stream_descriptor/overload2.html" title="posix::basic_stream_descriptor::basic_stream_descriptor (2 of 3 overloads)">more...</a></em></span> +</pre> +<p> + Move-construct a <a class="link" href="../posix__basic_stream_descriptor.html" title="posix::basic_stream_descriptor"><code class="computeroutput"><span class="identifier">posix</span><span class="special">::</span><span class="identifier">basic_stream_descriptor</span></code></a> from another. + </p> +<pre class="programlisting"><a class="link" href="basic_stream_descriptor/overload3.html" title="posix::basic_stream_descriptor::basic_stream_descriptor (3 of 3 overloads)">basic_stream_descriptor</a><span class="special">(</span> + <span class="identifier">basic_stream_descriptor</span> <span class="special">&&</span> <span class="identifier">other</span><span class="special">);</span> + <span class="emphasis"><em>» <a class="link" href="basic_stream_descriptor/overload3.html" title="posix::basic_stream_descriptor::basic_stream_descriptor (3 of 3 overloads)">more...</a></em></span> +</pre> +</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="async_write_some.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_stream_descriptor.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="basic_stream_descriptor/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/posix__basic_stream_descriptor/basic_stream_descriptor/overload1.html b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/basic_stream_descriptor/overload1.html new file mode 100755 index 0000000000..18b61b0a68 --- /dev/null +++ b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/basic_stream_descriptor/overload1.html @@ -0,0 +1,71 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>posix::basic_stream_descriptor::basic_stream_descriptor (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="../basic_stream_descriptor.html" title="posix::basic_stream_descriptor::basic_stream_descriptor"> +<link rel="prev" href="../basic_stream_descriptor.html" title="posix::basic_stream_descriptor::basic_stream_descriptor"> +<link rel="next" href="overload2.html" title="posix::basic_stream_descriptor::basic_stream_descriptor (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="../basic_stream_descriptor.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_stream_descriptor.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_stream_descriptor.basic_stream_descriptor.overload1"></a><a class="link" href="overload1.html" title="posix::basic_stream_descriptor::basic_stream_descriptor (1 of 3 overloads)">posix::basic_stream_descriptor::basic_stream_descriptor + (1 of 3 overloads)</a> +</h5></div></div></div> +<p> + Construct a <a class="link" href="../../posix__basic_stream_descriptor.html" title="posix::basic_stream_descriptor"><code class="computeroutput"><span class="identifier">posix</span><span class="special">::</span><span class="identifier">basic_stream_descriptor</span></code></a> without + opening it. + </p> +<pre class="programlisting"><span class="identifier">basic_stream_descriptor</span><span class="special">(</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span> <span class="special">&</span> <span class="identifier">io_service</span><span class="special">);</span> +</pre> +<p> + This constructor creates a stream descriptor without opening it. The + descriptor needs to be opened and then connected or accepted before data + can be sent or received on it. + </p> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.basic_stream_descriptor.overload1.h0"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.basic_stream_descriptor.overload1.parameters"></a></span><a class="link" href="overload1.html#boost_asio.reference.posix__basic_stream_descriptor.basic_stream_descriptor.overload1.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">io_service</span></dt> +<dd><p> + The <a class="link" href="../../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> object that + the stream descriptor will use to dispatch handlers for any asynchronous + operations performed on the descriptor. + </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="../basic_stream_descriptor.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_stream_descriptor.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_stream_descriptor/basic_stream_descriptor/overload2.html b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/basic_stream_descriptor/overload2.html new file mode 100755 index 0000000000..204254b6fc --- /dev/null +++ b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/basic_stream_descriptor/overload2.html @@ -0,0 +1,88 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>posix::basic_stream_descriptor::basic_stream_descriptor (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="../basic_stream_descriptor.html" title="posix::basic_stream_descriptor::basic_stream_descriptor"> +<link rel="prev" href="overload1.html" title="posix::basic_stream_descriptor::basic_stream_descriptor (1 of 3 overloads)"> +<link rel="next" href="overload3.html" title="posix::basic_stream_descriptor::basic_stream_descriptor (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="../basic_stream_descriptor.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_stream_descriptor.basic_stream_descriptor.overload2"></a><a class="link" href="overload2.html" title="posix::basic_stream_descriptor::basic_stream_descriptor (2 of 3 overloads)">posix::basic_stream_descriptor::basic_stream_descriptor + (2 of 3 overloads)</a> +</h5></div></div></div> +<p> + Construct a <a class="link" href="../../posix__basic_stream_descriptor.html" title="posix::basic_stream_descriptor"><code class="computeroutput"><span class="identifier">posix</span><span class="special">::</span><span class="identifier">basic_stream_descriptor</span></code></a> on an + existing native descriptor. + </p> +<pre class="programlisting"><span class="identifier">basic_stream_descriptor</span><span class="special">(</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span> <span class="special">&</span> <span class="identifier">io_service</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">native_handle_type</span> <span class="special">&</span> <span class="identifier">native_descriptor</span><span class="special">);</span> +</pre> +<p> + This constructor creates a stream descriptor object to hold an existing + native descriptor. + </p> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.basic_stream_descriptor.overload2.h0"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.basic_stream_descriptor.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.posix__basic_stream_descriptor.basic_stream_descriptor.overload2.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">io_service</span></dt> +<dd><p> + The <a class="link" href="../../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> object that + the stream descriptor will use to dispatch handlers for any asynchronous + operations performed on the descriptor. + </p></dd> +<dt><span class="term">native_descriptor</span></dt> +<dd><p> + The new underlying descriptor implementation. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.basic_stream_descriptor.overload2.h1"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.basic_stream_descriptor.overload2.exceptions"></a></span><a class="link" href="overload2.html#boost_asio.reference.posix__basic_stream_descriptor.basic_stream_descriptor.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. + </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="../basic_stream_descriptor.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_stream_descriptor/basic_stream_descriptor/overload3.html b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/basic_stream_descriptor/overload3.html new file mode 100755 index 0000000000..c189c27f8b --- /dev/null +++ b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/basic_stream_descriptor/overload3.html @@ -0,0 +1,76 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>posix::basic_stream_descriptor::basic_stream_descriptor (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="../basic_stream_descriptor.html" title="posix::basic_stream_descriptor::basic_stream_descriptor"> +<link rel="prev" href="overload2.html" title="posix::basic_stream_descriptor::basic_stream_descriptor (2 of 3 overloads)"> +<link rel="next" href="../bytes_readable.html" title="posix::basic_stream_descriptor::bytes_readable"> +</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="../basic_stream_descriptor.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="../bytes_readable.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_stream_descriptor.basic_stream_descriptor.overload3"></a><a class="link" href="overload3.html" title="posix::basic_stream_descriptor::basic_stream_descriptor (3 of 3 overloads)">posix::basic_stream_descriptor::basic_stream_descriptor + (3 of 3 overloads)</a> +</h5></div></div></div> +<p> + Move-construct a <a class="link" href="../../posix__basic_stream_descriptor.html" title="posix::basic_stream_descriptor"><code class="computeroutput"><span class="identifier">posix</span><span class="special">::</span><span class="identifier">basic_stream_descriptor</span></code></a> from + another. + </p> +<pre class="programlisting"><span class="identifier">basic_stream_descriptor</span><span class="special">(</span> + <span class="identifier">basic_stream_descriptor</span> <span class="special">&&</span> <span class="identifier">other</span><span class="special">);</span> +</pre> +<p> + This constructor moves a stream descriptor from one object to another. + </p> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.basic_stream_descriptor.overload3.h0"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.basic_stream_descriptor.overload3.parameters"></a></span><a class="link" href="overload3.html#boost_asio.reference.posix__basic_stream_descriptor.basic_stream_descriptor.overload3.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">other</span></dt> +<dd><p> + The other <a class="link" href="../../posix__basic_stream_descriptor.html" title="posix::basic_stream_descriptor"><code class="computeroutput"><span class="identifier">posix</span><span class="special">::</span><span class="identifier">basic_stream_descriptor</span></code></a> + object from which the move will occur. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.basic_stream_descriptor.overload3.h1"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.basic_stream_descriptor.overload3.remarks"></a></span><a class="link" href="overload3.html#boost_asio.reference.posix__basic_stream_descriptor.basic_stream_descriptor.overload3.remarks">Remarks</a> + </h6> +<p> + Following the move, the moved-from object is in the same state as if + constructed using the <code class="computeroutput"><span class="identifier">basic_stream_descriptor</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">&)</span> <span class="identifier">constructor</span></code>. + </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="overload2.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_stream_descriptor.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="../bytes_readable.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/posix__basic_stream_descriptor/bytes_readable.html b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/bytes_readable.html new file mode 100755 index 0000000000..807d3bfd7c --- /dev/null +++ b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/bytes_readable.html @@ -0,0 +1,76 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>posix::basic_stream_descriptor::bytes_readable</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="../posix__basic_stream_descriptor.html" title="posix::basic_stream_descriptor"> +<link rel="prev" href="basic_stream_descriptor/overload3.html" title="posix::basic_stream_descriptor::basic_stream_descriptor (3 of 3 overloads)"> +<link rel="next" href="cancel.html" title="posix::basic_stream_descriptor::cancel"> +</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="basic_stream_descriptor/overload3.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_stream_descriptor.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="cancel.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.posix__basic_stream_descriptor.bytes_readable"></a><a class="link" href="bytes_readable.html" title="posix::basic_stream_descriptor::bytes_readable">posix::basic_stream_descriptor::bytes_readable</a> +</h4></div></div></div> +<p> + <span class="emphasis"><em>Inherited from posix::descriptor_base.</em></span> + </p> +<p> + <a class="indexterm" name="id1469174"></a> +IO control command to get the + amount of data that can be read without blocking. + </p> +<pre class="programlisting"><span class="keyword">typedef</span> <span class="identifier">implementation_defined</span> <span class="identifier">bytes_readable</span><span class="special">;</span> +</pre> +<p> + Implements the FIONREAD IO control command. + </p> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.bytes_readable.h0"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.bytes_readable.example"></a></span><a class="link" href="bytes_readable.html#boost_asio.reference.posix__basic_stream_descriptor.bytes_readable.example">Example</a> + </h6> +<pre class="programlisting"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">posix</span><span class="special">::</span><span class="identifier">stream_descriptor</span> <span class="identifier">descriptor</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">);</span> +<span class="special">...</span> +<span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">descriptor_base</span><span class="special">::</span><span class="identifier">bytes_readable</span> <span class="identifier">command</span><span class="special">(</span><span class="keyword">true</span><span class="special">);</span> +<span class="identifier">descriptor</span><span class="special">.</span><span class="identifier">io_control</span><span class="special">(</span><span class="identifier">command</span><span class="special">);</span> +<span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">bytes_readable</span> <span class="special">=</span> <span class="identifier">command</span><span class="special">.</span><span class="identifier">get</span><span class="special">();</span> +</pre> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.bytes_readable.h1"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.bytes_readable.requirements"></a></span><a class="link" href="bytes_readable.html#boost_asio.reference.posix__basic_stream_descriptor.bytes_readable.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>Header: </strong></span><code class="literal">boost/asio/posix/basic_stream_descriptor.hpp</code> + </p> +<p> + <span class="bold"><strong>Convenience header: </strong></span><code class="literal">boost/asio.hpp</code> + </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="basic_stream_descriptor/overload3.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_stream_descriptor.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="cancel.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/posix__basic_stream_descriptor/cancel.html b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/cancel.html new file mode 100755 index 0000000000..6e2a058597 --- /dev/null +++ b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/cancel.html @@ -0,0 +1,55 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>posix::basic_stream_descriptor::cancel</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="../posix__basic_stream_descriptor.html" title="posix::basic_stream_descriptor"> +<link rel="prev" href="bytes_readable.html" title="posix::basic_stream_descriptor::bytes_readable"> +<link rel="next" href="cancel/overload1.html" title="posix::basic_stream_descriptor::cancel (1 of 2 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="bytes_readable.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_stream_descriptor.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="cancel/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.posix__basic_stream_descriptor.cancel"></a><a class="link" href="cancel.html" title="posix::basic_stream_descriptor::cancel">posix::basic_stream_descriptor::cancel</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1469502"></a> +Cancel all asynchronous operations + associated with the descriptor. + </p> +<pre class="programlisting"><span class="keyword">void</span> <a class="link" href="cancel/overload1.html" title="posix::basic_stream_descriptor::cancel (1 of 2 overloads)">cancel</a><span class="special">();</span> + <span class="emphasis"><em>» <a class="link" href="cancel/overload1.html" title="posix::basic_stream_descriptor::cancel (1 of 2 overloads)">more...</a></em></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> <a class="link" href="cancel/overload2.html" title="posix::basic_stream_descriptor::cancel (2 of 2 overloads)">cancel</a><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> + <span class="emphasis"><em>» <a class="link" href="cancel/overload2.html" title="posix::basic_stream_descriptor::cancel (2 of 2 overloads)">more...</a></em></span> +</pre> +</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="bytes_readable.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_stream_descriptor.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="cancel/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/posix__basic_stream_descriptor/cancel/overload1.html b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/cancel/overload1.html new file mode 100755 index 0000000000..c8bd1d4249 --- /dev/null +++ b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/cancel/overload1.html @@ -0,0 +1,70 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>posix::basic_stream_descriptor::cancel (1 of 2 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="../cancel.html" title="posix::basic_stream_descriptor::cancel"> +<link rel="prev" href="../cancel.html" title="posix::basic_stream_descriptor::cancel"> +<link rel="next" href="overload2.html" title="posix::basic_stream_descriptor::cancel (2 of 2 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="../cancel.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../cancel.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_stream_descriptor.cancel.overload1"></a><a class="link" href="overload1.html" title="posix::basic_stream_descriptor::cancel (1 of 2 overloads)">posix::basic_stream_descriptor::cancel + (1 of 2 overloads)</a> +</h5></div></div></div> +<p> + <span class="emphasis"><em>Inherited from posix::basic_descriptor.</em></span> + </p> +<p> + Cancel all asynchronous operations associated with the descriptor. + </p> +<pre class="programlisting"><span class="keyword">void</span> <span class="identifier">cancel</span><span class="special">();</span> +</pre> +<p> + This function causes all outstanding asynchronous read or write operations + to finish immediately, and the handlers for cancelled operations will + be passed the <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">operation_aborted</span></code> error. + </p> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.cancel.overload1.h0"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.cancel.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.posix__basic_stream_descriptor.cancel.overload1.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. + </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="../cancel.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../cancel.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_stream_descriptor/cancel/overload2.html b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/cancel/overload2.html new file mode 100755 index 0000000000..4f452f1331 --- /dev/null +++ b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/cancel/overload2.html @@ -0,0 +1,71 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>posix::basic_stream_descriptor::cancel (2 of 2 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="../cancel.html" title="posix::basic_stream_descriptor::cancel"> +<link rel="prev" href="overload1.html" title="posix::basic_stream_descriptor::cancel (1 of 2 overloads)"> +<link rel="next" href="../close.html" title="posix::basic_stream_descriptor::close"> +</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="../cancel.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="../close.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_stream_descriptor.cancel.overload2"></a><a class="link" href="overload2.html" title="posix::basic_stream_descriptor::cancel (2 of 2 overloads)">posix::basic_stream_descriptor::cancel + (2 of 2 overloads)</a> +</h5></div></div></div> +<p> + <span class="emphasis"><em>Inherited from posix::basic_descriptor.</em></span> + </p> +<p> + Cancel all asynchronous operations associated with the descriptor. + </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">cancel</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 causes all outstanding asynchronous read or write operations + to finish immediately, and the handlers for cancelled operations will + be passed the <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">operation_aborted</span></code> error. + </p> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.cancel.overload2.h0"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.cancel.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.posix__basic_stream_descriptor.cancel.overload2.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">ec</span></dt> +<dd><p> + Set to indicate what error occurred, if any. + </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="../cancel.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="../close.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/posix__basic_stream_descriptor/close.html b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/close.html new file mode 100755 index 0000000000..67da0aaf00 --- /dev/null +++ b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/close.html @@ -0,0 +1,54 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>posix::basic_stream_descriptor::close</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="../posix__basic_stream_descriptor.html" title="posix::basic_stream_descriptor"> +<link rel="prev" href="cancel/overload2.html" title="posix::basic_stream_descriptor::cancel (2 of 2 overloads)"> +<link rel="next" href="close/overload1.html" title="posix::basic_stream_descriptor::close (1 of 2 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="cancel/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_stream_descriptor.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="close/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.posix__basic_stream_descriptor.close"></a><a class="link" href="close.html" title="posix::basic_stream_descriptor::close">posix::basic_stream_descriptor::close</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1470002"></a> +Close the descriptor. + </p> +<pre class="programlisting"><span class="keyword">void</span> <a class="link" href="close/overload1.html" title="posix::basic_stream_descriptor::close (1 of 2 overloads)">close</a><span class="special">();</span> + <span class="emphasis"><em>» <a class="link" href="close/overload1.html" title="posix::basic_stream_descriptor::close (1 of 2 overloads)">more...</a></em></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> <a class="link" href="close/overload2.html" title="posix::basic_stream_descriptor::close (2 of 2 overloads)">close</a><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> + <span class="emphasis"><em>» <a class="link" href="close/overload2.html" title="posix::basic_stream_descriptor::close (2 of 2 overloads)">more...</a></em></span> +</pre> +</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="cancel/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_stream_descriptor.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="close/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/posix__basic_stream_descriptor/close/overload1.html b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/close/overload1.html new file mode 100755 index 0000000000..b6eecb16fc --- /dev/null +++ b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/close/overload1.html @@ -0,0 +1,71 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>posix::basic_stream_descriptor::close (1 of 2 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="../close.html" title="posix::basic_stream_descriptor::close"> +<link rel="prev" href="../close.html" title="posix::basic_stream_descriptor::close"> +<link rel="next" href="overload2.html" title="posix::basic_stream_descriptor::close (2 of 2 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="../close.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="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_stream_descriptor.close.overload1"></a><a class="link" href="overload1.html" title="posix::basic_stream_descriptor::close (1 of 2 overloads)">posix::basic_stream_descriptor::close + (1 of 2 overloads)</a> +</h5></div></div></div> +<p> + <span class="emphasis"><em>Inherited from posix::basic_descriptor.</em></span> + </p> +<p> + Close the descriptor. + </p> +<pre class="programlisting"><span class="keyword">void</span> <span class="identifier">close</span><span class="special">();</span> +</pre> +<p> + This function is used to close the descriptor. Any asynchronous read + or write operations will be cancelled immediately, and will complete + with the <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">operation_aborted</span></code> error. + </p> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.close.overload1.h0"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.close.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.posix__basic_stream_descriptor.close.overload1.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. Note that, even if the function indicates an + error, the underlying descriptor is closed. + </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="../close.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="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_stream_descriptor/close/overload2.html b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/close/overload2.html new file mode 100755 index 0000000000..fb58cfc131 --- /dev/null +++ b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/close/overload2.html @@ -0,0 +1,72 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>posix::basic_stream_descriptor::close (2 of 2 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="../close.html" title="posix::basic_stream_descriptor::close"> +<link rel="prev" href="overload1.html" title="posix::basic_stream_descriptor::close (1 of 2 overloads)"> +<link rel="next" href="../get_implementation.html" title="posix::basic_stream_descriptor::get_implementation"> +</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="../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="../get_implementation.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_stream_descriptor.close.overload2"></a><a class="link" href="overload2.html" title="posix::basic_stream_descriptor::close (2 of 2 overloads)">posix::basic_stream_descriptor::close + (2 of 2 overloads)</a> +</h5></div></div></div> +<p> + <span class="emphasis"><em>Inherited from posix::basic_descriptor.</em></span> + </p> +<p> + Close the descriptor. + </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">close</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 close the descriptor. Any asynchronous read + or write operations will be cancelled immediately, and will complete + with the <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">operation_aborted</span></code> error. + </p> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.close.overload2.h0"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.close.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.posix__basic_stream_descriptor.close.overload2.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">ec</span></dt> +<dd><p> + Set to indicate what error occurred, if any. Note that, even if + the function indicates an error, the underlying descriptor is closed. + </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="../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="../get_implementation.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/posix__basic_stream_descriptor/get_implementation.html b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/get_implementation.html new file mode 100755 index 0000000000..af0631b3f4 --- /dev/null +++ b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/get_implementation.html @@ -0,0 +1,54 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>posix::basic_stream_descriptor::get_implementation</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="../posix__basic_stream_descriptor.html" title="posix::basic_stream_descriptor"> +<link rel="prev" href="close/overload2.html" title="posix::basic_stream_descriptor::close (2 of 2 overloads)"> +<link rel="next" href="get_implementation/overload1.html" title="posix::basic_stream_descriptor::get_implementation (1 of 2 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="close/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_stream_descriptor.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="get_implementation/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.posix__basic_stream_descriptor.get_implementation"></a><a class="link" href="get_implementation.html" title="posix::basic_stream_descriptor::get_implementation">posix::basic_stream_descriptor::get_implementation</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1470506"></a> +Get the underlying implementation + of the I/O object. + </p> +<pre class="programlisting"><span class="identifier">implementation_type</span> <span class="special">&</span> <a class="link" href="get_implementation/overload1.html" title="posix::basic_stream_descriptor::get_implementation (1 of 2 overloads)">get_implementation</a><span class="special">();</span> + <span class="emphasis"><em>» <a class="link" href="get_implementation/overload1.html" title="posix::basic_stream_descriptor::get_implementation (1 of 2 overloads)">more...</a></em></span> + +<span class="keyword">const</span> <span class="identifier">implementation_type</span> <span class="special">&</span> <a class="link" href="get_implementation/overload2.html" title="posix::basic_stream_descriptor::get_implementation (2 of 2 overloads)">get_implementation</a><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span> + <span class="emphasis"><em>» <a class="link" href="get_implementation/overload2.html" title="posix::basic_stream_descriptor::get_implementation (2 of 2 overloads)">more...</a></em></span> +</pre> +</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="close/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_stream_descriptor.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="get_implementation/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/posix__basic_stream_descriptor/get_implementation/overload1.html b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/get_implementation/overload1.html new file mode 100755 index 0000000000..9a74422fd7 --- /dev/null +++ b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/get_implementation/overload1.html @@ -0,0 +1,52 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>posix::basic_stream_descriptor::get_implementation (1 of 2 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="../get_implementation.html" title="posix::basic_stream_descriptor::get_implementation"> +<link rel="prev" href="../get_implementation.html" title="posix::basic_stream_descriptor::get_implementation"> +<link rel="next" href="overload2.html" title="posix::basic_stream_descriptor::get_implementation (2 of 2 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="../get_implementation.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../get_implementation.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_stream_descriptor.get_implementation.overload1"></a><a class="link" href="overload1.html" title="posix::basic_stream_descriptor::get_implementation (1 of 2 overloads)">posix::basic_stream_descriptor::get_implementation + (1 of 2 overloads)</a> +</h5></div></div></div> +<p> + <span class="emphasis"><em>Inherited from basic_io_object.</em></span> + </p> +<p> + Get the underlying implementation of the I/O object. + </p> +<pre class="programlisting"><span class="identifier">implementation_type</span> <span class="special">&</span> <span class="identifier">get_implementation</span><span class="special">();</span> +</pre> +</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="../get_implementation.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../get_implementation.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_stream_descriptor/get_implementation/overload2.html b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/get_implementation/overload2.html new file mode 100755 index 0000000000..888d48c7eb --- /dev/null +++ b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/get_implementation/overload2.html @@ -0,0 +1,52 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>posix::basic_stream_descriptor::get_implementation (2 of 2 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="../get_implementation.html" title="posix::basic_stream_descriptor::get_implementation"> +<link rel="prev" href="overload1.html" title="posix::basic_stream_descriptor::get_implementation (1 of 2 overloads)"> +<link rel="next" href="../get_io_service.html" title="posix::basic_stream_descriptor::get_io_service"> +</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="../get_implementation.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="../get_io_service.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_stream_descriptor.get_implementation.overload2"></a><a class="link" href="overload2.html" title="posix::basic_stream_descriptor::get_implementation (2 of 2 overloads)">posix::basic_stream_descriptor::get_implementation + (2 of 2 overloads)</a> +</h5></div></div></div> +<p> + <span class="emphasis"><em>Inherited from basic_io_object.</em></span> + </p> +<p> + Get the underlying implementation of the I/O object. + </p> +<pre class="programlisting"><span class="keyword">const</span> <span class="identifier">implementation_type</span> <span class="special">&</span> <span class="identifier">get_implementation</span><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span> +</pre> +</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="../get_implementation.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="../get_io_service.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/posix__basic_stream_descriptor/get_io_service.html b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/get_io_service.html new file mode 100755 index 0000000000..1787465e48 --- /dev/null +++ b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/get_io_service.html @@ -0,0 +1,67 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>posix::basic_stream_descriptor::get_io_service</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="../posix__basic_stream_descriptor.html" title="posix::basic_stream_descriptor"> +<link rel="prev" href="get_implementation/overload2.html" title="posix::basic_stream_descriptor::get_implementation (2 of 2 overloads)"> +<link rel="next" href="get_service.html" title="posix::basic_stream_descriptor::get_service"> +</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="get_implementation/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_stream_descriptor.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="get_service.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.posix__basic_stream_descriptor.get_io_service"></a><a class="link" href="get_io_service.html" title="posix::basic_stream_descriptor::get_io_service">posix::basic_stream_descriptor::get_io_service</a> +</h4></div></div></div> +<p> + <span class="emphasis"><em>Inherited from basic_io_object.</em></span> + </p> +<p> + <a class="indexterm" name="id1470776"></a> +Get the <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> associated with the + object. + </p> +<pre class="programlisting"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span> <span class="special">&</span> <span class="identifier">get_io_service</span><span class="special">();</span> +</pre> +<p> + This function may be used to obtain the <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> object that the I/O + object uses to dispatch handlers for asynchronous operations. + </p> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.get_io_service.h0"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.get_io_service.return_value"></a></span><a class="link" href="get_io_service.html#boost_asio.reference.posix__basic_stream_descriptor.get_io_service.return_value">Return + Value</a> + </h6> +<p> + A reference to the <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> object that the I/O + object will use to dispatch handlers. Ownership is not transferred to the + caller. + </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="get_implementation/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_stream_descriptor.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="get_service.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/posix__basic_stream_descriptor/get_service.html b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/get_service.html new file mode 100755 index 0000000000..b3a955dfac --- /dev/null +++ b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/get_service.html @@ -0,0 +1,54 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>posix::basic_stream_descriptor::get_service</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="../posix__basic_stream_descriptor.html" title="posix::basic_stream_descriptor"> +<link rel="prev" href="get_io_service.html" title="posix::basic_stream_descriptor::get_io_service"> +<link rel="next" href="get_service/overload1.html" title="posix::basic_stream_descriptor::get_service (1 of 2 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="get_io_service.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_stream_descriptor.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="get_service/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.posix__basic_stream_descriptor.get_service"></a><a class="link" href="get_service.html" title="posix::basic_stream_descriptor::get_service">posix::basic_stream_descriptor::get_service</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1470935"></a> +Get the service associated with + the I/O object. + </p> +<pre class="programlisting"><span class="identifier">service_type</span> <span class="special">&</span> <a class="link" href="get_service/overload1.html" title="posix::basic_stream_descriptor::get_service (1 of 2 overloads)">get_service</a><span class="special">();</span> + <span class="emphasis"><em>» <a class="link" href="get_service/overload1.html" title="posix::basic_stream_descriptor::get_service (1 of 2 overloads)">more...</a></em></span> + +<span class="keyword">const</span> <span class="identifier">service_type</span> <span class="special">&</span> <a class="link" href="get_service/overload2.html" title="posix::basic_stream_descriptor::get_service (2 of 2 overloads)">get_service</a><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span> + <span class="emphasis"><em>» <a class="link" href="get_service/overload2.html" title="posix::basic_stream_descriptor::get_service (2 of 2 overloads)">more...</a></em></span> +</pre> +</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="get_io_service.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_stream_descriptor.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="get_service/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/posix__basic_stream_descriptor/get_service/overload1.html b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/get_service/overload1.html new file mode 100755 index 0000000000..1aea9d349f --- /dev/null +++ b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/get_service/overload1.html @@ -0,0 +1,52 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>posix::basic_stream_descriptor::get_service (1 of 2 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="../get_service.html" title="posix::basic_stream_descriptor::get_service"> +<link rel="prev" href="../get_service.html" title="posix::basic_stream_descriptor::get_service"> +<link rel="next" href="overload2.html" title="posix::basic_stream_descriptor::get_service (2 of 2 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="../get_service.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../get_service.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_stream_descriptor.get_service.overload1"></a><a class="link" href="overload1.html" title="posix::basic_stream_descriptor::get_service (1 of 2 overloads)">posix::basic_stream_descriptor::get_service + (1 of 2 overloads)</a> +</h5></div></div></div> +<p> + <span class="emphasis"><em>Inherited from basic_io_object.</em></span> + </p> +<p> + Get the service associated with the I/O object. + </p> +<pre class="programlisting"><span class="identifier">service_type</span> <span class="special">&</span> <span class="identifier">get_service</span><span class="special">();</span> +</pre> +</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="../get_service.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../get_service.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_stream_descriptor/get_service/overload2.html b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/get_service/overload2.html new file mode 100755 index 0000000000..a0fc0eac62 --- /dev/null +++ b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/get_service/overload2.html @@ -0,0 +1,52 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>posix::basic_stream_descriptor::get_service (2 of 2 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="../get_service.html" title="posix::basic_stream_descriptor::get_service"> +<link rel="prev" href="overload1.html" title="posix::basic_stream_descriptor::get_service (1 of 2 overloads)"> +<link rel="next" href="../implementation.html" title="posix::basic_stream_descriptor::implementation"> +</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="../get_service.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="../implementation.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_stream_descriptor.get_service.overload2"></a><a class="link" href="overload2.html" title="posix::basic_stream_descriptor::get_service (2 of 2 overloads)">posix::basic_stream_descriptor::get_service + (2 of 2 overloads)</a> +</h5></div></div></div> +<p> + <span class="emphasis"><em>Inherited from basic_io_object.</em></span> + </p> +<p> + Get the service associated with the I/O object. + </p> +<pre class="programlisting"><span class="keyword">const</span> <span class="identifier">service_type</span> <span class="special">&</span> <span class="identifier">get_service</span><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span> +</pre> +</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="../get_service.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="../implementation.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/posix__basic_stream_descriptor/implementation.html b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/implementation.html new file mode 100755 index 0000000000..a3321989e9 --- /dev/null +++ b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/implementation.html @@ -0,0 +1,53 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>posix::basic_stream_descriptor::implementation</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="../posix__basic_stream_descriptor.html" title="posix::basic_stream_descriptor"> +<link rel="prev" href="get_service/overload2.html" title="posix::basic_stream_descriptor::get_service (2 of 2 overloads)"> +<link rel="next" href="implementation_type.html" title="posix::basic_stream_descriptor::implementation_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="get_service/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_stream_descriptor.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="implementation_type.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.posix__basic_stream_descriptor.implementation"></a><a class="link" href="implementation.html" title="posix::basic_stream_descriptor::implementation">posix::basic_stream_descriptor::implementation</a> +</h4></div></div></div> +<p> + <span class="emphasis"><em>Inherited from basic_io_object.</em></span> + </p> +<p> + <a class="indexterm" name="id1471202"></a> +(Deprecated: Use <code class="computeroutput"><span class="identifier">get_implementation</span><span class="special">()</span></code>.) + The underlying implementation of the I/O object. + </p> +<pre class="programlisting"><span class="identifier">implementation_type</span> <span class="identifier">implementation</span><span class="special">;</span> +</pre> +</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="get_service/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_stream_descriptor.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="implementation_type.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/posix__basic_stream_descriptor/implementation_type.html b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/implementation_type.html new file mode 100755 index 0000000000..2578c11003 --- /dev/null +++ b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/implementation_type.html @@ -0,0 +1,63 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>posix::basic_stream_descriptor::implementation_type</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="../posix__basic_stream_descriptor.html" title="posix::basic_stream_descriptor"> +<link rel="prev" href="implementation.html" title="posix::basic_stream_descriptor::implementation"> +<link rel="next" href="io_control.html" title="posix::basic_stream_descriptor::io_control"> +</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="implementation.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_stream_descriptor.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="io_control.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.posix__basic_stream_descriptor.implementation_type"></a><a class="link" href="implementation_type.html" title="posix::basic_stream_descriptor::implementation_type">posix::basic_stream_descriptor::implementation_type</a> +</h4></div></div></div> +<p> + <span class="emphasis"><em>Inherited from basic_io_object.</em></span> + </p> +<p> + <a class="indexterm" name="id1471279"></a> +The underlying implementation + type of I/O object. + </p> +<pre class="programlisting"><span class="keyword">typedef</span> <span class="identifier">service_type</span><span class="special">::</span><span class="identifier">implementation_type</span> <span class="identifier">implementation_type</span><span class="special">;</span> +</pre> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.implementation_type.h0"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.implementation_type.requirements"></a></span><a class="link" href="implementation_type.html#boost_asio.reference.posix__basic_stream_descriptor.implementation_type.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>Header: </strong></span><code class="literal">boost/asio/posix/basic_stream_descriptor.hpp</code> + </p> +<p> + <span class="bold"><strong>Convenience header: </strong></span><code class="literal">boost/asio.hpp</code> + </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="implementation.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_stream_descriptor.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="io_control.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/posix__basic_stream_descriptor/io_control.html b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/io_control.html new file mode 100755 index 0000000000..5133a12132 --- /dev/null +++ b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/io_control.html @@ -0,0 +1,57 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>posix::basic_stream_descriptor::io_control</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="../posix__basic_stream_descriptor.html" title="posix::basic_stream_descriptor"> +<link rel="prev" href="implementation_type.html" title="posix::basic_stream_descriptor::implementation_type"> +<link rel="next" href="io_control/overload1.html" title="posix::basic_stream_descriptor::io_control (1 of 2 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="implementation_type.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_stream_descriptor.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="io_control/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.posix__basic_stream_descriptor.io_control"></a><a class="link" href="io_control.html" title="posix::basic_stream_descriptor::io_control">posix::basic_stream_descriptor::io_control</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1471402"></a> +Perform an IO control command on + the descriptor. + </p> +<pre class="programlisting"><span class="keyword">void</span> <a class="link" href="io_control/overload1.html" title="posix::basic_stream_descriptor::io_control (1 of 2 overloads)">io_control</a><span class="special">(</span> + <span class="identifier">IoControlCommand</span> <span class="special">&</span> <span class="identifier">command</span><span class="special">);</span> + <span class="emphasis"><em>» <a class="link" href="io_control/overload1.html" title="posix::basic_stream_descriptor::io_control (1 of 2 overloads)">more...</a></em></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> <a class="link" href="io_control/overload2.html" title="posix::basic_stream_descriptor::io_control (2 of 2 overloads)">io_control</a><span class="special">(</span> + <span class="identifier">IoControlCommand</span> <span class="special">&</span> <span class="identifier">command</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> + <span class="emphasis"><em>» <a class="link" href="io_control/overload2.html" title="posix::basic_stream_descriptor::io_control (2 of 2 overloads)">more...</a></em></span> +</pre> +</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="implementation_type.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_stream_descriptor.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="io_control/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/posix__basic_stream_descriptor/io_control/overload1.html b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/io_control/overload1.html new file mode 100755 index 0000000000..519ec43ed3 --- /dev/null +++ b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/io_control/overload1.html @@ -0,0 +1,97 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>posix::basic_stream_descriptor::io_control (1 of 2 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="../io_control.html" title="posix::basic_stream_descriptor::io_control"> +<link rel="prev" href="../io_control.html" title="posix::basic_stream_descriptor::io_control"> +<link rel="next" href="overload2.html" title="posix::basic_stream_descriptor::io_control (2 of 2 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="../io_control.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_control.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_stream_descriptor.io_control.overload1"></a><a class="link" href="overload1.html" title="posix::basic_stream_descriptor::io_control (1 of 2 overloads)">posix::basic_stream_descriptor::io_control + (1 of 2 overloads)</a> +</h5></div></div></div> +<p> + <span class="emphasis"><em>Inherited from posix::basic_descriptor.</em></span> + </p> +<p> + Perform an IO control command on the descriptor. + </p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> + <span class="keyword">typename</span> <a class="link" href="../../IoControlCommand.html" title="I/O control command requirements">IoControlCommand</a><span class="special">></span> +<span class="keyword">void</span> <span class="identifier">io_control</span><span class="special">(</span> + <span class="identifier">IoControlCommand</span> <span class="special">&</span> <span class="identifier">command</span><span class="special">);</span> +</pre> +<p> + This function is used to execute an IO control command on the descriptor. + </p> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.io_control.overload1.h0"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.io_control.overload1.parameters"></a></span><a class="link" href="overload1.html#boost_asio.reference.posix__basic_stream_descriptor.io_control.overload1.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">command</span></dt> +<dd><p> + The IO control command to be performed on the descriptor. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.io_control.overload1.h1"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.io_control.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.posix__basic_stream_descriptor.io_control.overload1.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. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.io_control.overload1.h2"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.io_control.overload1.example"></a></span><a class="link" href="overload1.html#boost_asio.reference.posix__basic_stream_descriptor.io_control.overload1.example">Example</a> + </h6> +<p> + Getting the number of bytes ready to read: + </p> +<pre class="programlisting"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">posix</span><span class="special">::</span><span class="identifier">stream_descriptor</span> <span class="identifier">descriptor</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">);</span> +<span class="special">...</span> +<span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">posix</span><span class="special">::</span><span class="identifier">stream_descriptor</span><span class="special">::</span><span class="identifier">bytes_readable</span> <span class="identifier">command</span><span class="special">;</span> +<span class="identifier">descriptor</span><span class="special">.</span><span class="identifier">io_control</span><span class="special">(</span><span class="identifier">command</span><span class="special">);</span> +<span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">bytes_readable</span> <span class="special">=</span> <span class="identifier">command</span><span class="special">.</span><span class="identifier">get</span><span class="special">();</span> +</pre> +</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="../io_control.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_control.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_stream_descriptor/io_control/overload2.html b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/io_control/overload2.html new file mode 100755 index 0000000000..ad571ee207 --- /dev/null +++ b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/io_control/overload2.html @@ -0,0 +1,94 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>posix::basic_stream_descriptor::io_control (2 of 2 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="../io_control.html" title="posix::basic_stream_descriptor::io_control"> +<link rel="prev" href="overload1.html" title="posix::basic_stream_descriptor::io_control (1 of 2 overloads)"> +<link rel="next" href="../is_open.html" title="posix::basic_stream_descriptor::is_open"> +</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="../io_control.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="../is_open.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_stream_descriptor.io_control.overload2"></a><a class="link" href="overload2.html" title="posix::basic_stream_descriptor::io_control (2 of 2 overloads)">posix::basic_stream_descriptor::io_control + (2 of 2 overloads)</a> +</h5></div></div></div> +<p> + <span class="emphasis"><em>Inherited from posix::basic_descriptor.</em></span> + </p> +<p> + Perform an IO control command on the descriptor. + </p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> + <span class="keyword">typename</span> <a class="link" href="../../IoControlCommand.html" title="I/O control command requirements">IoControlCommand</a><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="identifier">io_control</span><span class="special">(</span> + <span class="identifier">IoControlCommand</span> <span class="special">&</span> <span class="identifier">command</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 execute an IO control command on the descriptor. + </p> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.io_control.overload2.h0"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.io_control.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.posix__basic_stream_descriptor.io_control.overload2.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">command</span></dt> +<dd><p> + The IO control command to be performed on the descriptor. + </p></dd> +<dt><span class="term">ec</span></dt> +<dd><p> + Set to indicate what error occurred, if any. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.io_control.overload2.h1"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.io_control.overload2.example"></a></span><a class="link" href="overload2.html#boost_asio.reference.posix__basic_stream_descriptor.io_control.overload2.example">Example</a> + </h6> +<p> + Getting the number of bytes ready to read: + </p> +<pre class="programlisting"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">posix</span><span class="special">::</span><span class="identifier">stream_descriptor</span> <span class="identifier">descriptor</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">);</span> +<span class="special">...</span> +<span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">posix</span><span class="special">::</span><span class="identifier">stream_descriptor</span><span class="special">::</span><span class="identifier">bytes_readable</span> <span class="identifier">command</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="identifier">ec</span><span class="special">;</span> +<span class="identifier">descriptor</span><span class="special">.</span><span class="identifier">io_control</span><span class="special">(</span><span class="identifier">command</span><span class="special">,</span> <span class="identifier">ec</span><span class="special">);</span> +<span class="keyword">if</span> <span class="special">(</span><span class="identifier">ec</span><span class="special">)</span> +<span class="special">{</span> + <span class="comment">// An error occurred.</span> +<span class="special">}</span> +<span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">bytes_readable</span> <span class="special">=</span> <span class="identifier">command</span><span class="special">.</span><span class="identifier">get</span><span class="special">();</span> +</pre> +</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="../io_control.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="../is_open.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/posix__basic_stream_descriptor/is_open.html b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/is_open.html new file mode 100755 index 0000000000..e2749230eb --- /dev/null +++ b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/is_open.html @@ -0,0 +1,53 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>posix::basic_stream_descriptor::is_open</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="../posix__basic_stream_descriptor.html" title="posix::basic_stream_descriptor"> +<link rel="prev" href="io_control/overload2.html" title="posix::basic_stream_descriptor::io_control (2 of 2 overloads)"> +<link rel="next" href="lowest_layer.html" title="posix::basic_stream_descriptor::lowest_layer"> +</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="io_control/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_stream_descriptor.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="lowest_layer.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.posix__basic_stream_descriptor.is_open"></a><a class="link" href="is_open.html" title="posix::basic_stream_descriptor::is_open">posix::basic_stream_descriptor::is_open</a> +</h4></div></div></div> +<p> + <span class="emphasis"><em>Inherited from posix::basic_descriptor.</em></span> + </p> +<p> + <a class="indexterm" name="id1472549"></a> +Determine whether the descriptor is + open. + </p> +<pre class="programlisting"><span class="keyword">bool</span> <span class="identifier">is_open</span><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span> +</pre> +</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="io_control/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_stream_descriptor.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="lowest_layer.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/posix__basic_stream_descriptor/lowest_layer.html b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/lowest_layer.html new file mode 100755 index 0000000000..b5a888c220 --- /dev/null +++ b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/lowest_layer.html @@ -0,0 +1,57 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>posix::basic_stream_descriptor::lowest_layer</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="../posix__basic_stream_descriptor.html" title="posix::basic_stream_descriptor"> +<link rel="prev" href="is_open.html" title="posix::basic_stream_descriptor::is_open"> +<link rel="next" href="lowest_layer/overload1.html" title="posix::basic_stream_descriptor::lowest_layer (1 of 2 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="is_open.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_stream_descriptor.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="lowest_layer/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.posix__basic_stream_descriptor.lowest_layer"></a><a class="link" href="lowest_layer.html" title="posix::basic_stream_descriptor::lowest_layer">posix::basic_stream_descriptor::lowest_layer</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1472613"></a> +Get a reference to the lowest + layer. + </p> +<pre class="programlisting"><span class="identifier">lowest_layer_type</span> <span class="special">&</span> <a class="link" href="lowest_layer/overload1.html" title="posix::basic_stream_descriptor::lowest_layer (1 of 2 overloads)">lowest_layer</a><span class="special">();</span> + <span class="emphasis"><em>» <a class="link" href="lowest_layer/overload1.html" title="posix::basic_stream_descriptor::lowest_layer (1 of 2 overloads)">more...</a></em></span> +</pre> +<p> + Get a const reference to the lowest layer. + </p> +<pre class="programlisting"><span class="keyword">const</span> <span class="identifier">lowest_layer_type</span> <span class="special">&</span> <a class="link" href="lowest_layer/overload2.html" title="posix::basic_stream_descriptor::lowest_layer (2 of 2 overloads)">lowest_layer</a><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span> + <span class="emphasis"><em>» <a class="link" href="lowest_layer/overload2.html" title="posix::basic_stream_descriptor::lowest_layer (2 of 2 overloads)">more...</a></em></span> +</pre> +</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="is_open.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_stream_descriptor.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="lowest_layer/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/posix__basic_stream_descriptor/lowest_layer/overload1.html b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/lowest_layer/overload1.html new file mode 100755 index 0000000000..66d3b52267 --- /dev/null +++ b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/lowest_layer/overload1.html @@ -0,0 +1,66 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>posix::basic_stream_descriptor::lowest_layer (1 of 2 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="../lowest_layer.html" title="posix::basic_stream_descriptor::lowest_layer"> +<link rel="prev" href="../lowest_layer.html" title="posix::basic_stream_descriptor::lowest_layer"> +<link rel="next" href="overload2.html" title="posix::basic_stream_descriptor::lowest_layer (2 of 2 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="../lowest_layer.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../lowest_layer.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_stream_descriptor.lowest_layer.overload1"></a><a class="link" href="overload1.html" title="posix::basic_stream_descriptor::lowest_layer (1 of 2 overloads)">posix::basic_stream_descriptor::lowest_layer + (1 of 2 overloads)</a> +</h5></div></div></div> +<p> + <span class="emphasis"><em>Inherited from posix::basic_descriptor.</em></span> + </p> +<p> + Get a reference to the lowest layer. + </p> +<pre class="programlisting"><span class="identifier">lowest_layer_type</span> <span class="special">&</span> <span class="identifier">lowest_layer</span><span class="special">();</span> +</pre> +<p> + This function returns a reference to the lowest layer in a stack of layers. + Since a <a class="link" href="../../posix__basic_descriptor.html" title="posix::basic_descriptor"><code class="computeroutput"><span class="identifier">posix</span><span class="special">::</span><span class="identifier">basic_descriptor</span></code></a> cannot contain + any further layers, it simply returns a reference to itself. + </p> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.lowest_layer.overload1.h0"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.lowest_layer.overload1.return_value"></a></span><a class="link" href="overload1.html#boost_asio.reference.posix__basic_stream_descriptor.lowest_layer.overload1.return_value">Return + Value</a> + </h6> +<p> + A reference to the lowest layer in the stack of layers. Ownership is + not transferred to the caller. + </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="../lowest_layer.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../lowest_layer.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_stream_descriptor/lowest_layer/overload2.html b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/lowest_layer/overload2.html new file mode 100755 index 0000000000..5a63ad83ec --- /dev/null +++ b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/lowest_layer/overload2.html @@ -0,0 +1,66 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>posix::basic_stream_descriptor::lowest_layer (2 of 2 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="../lowest_layer.html" title="posix::basic_stream_descriptor::lowest_layer"> +<link rel="prev" href="overload1.html" title="posix::basic_stream_descriptor::lowest_layer (1 of 2 overloads)"> +<link rel="next" href="../lowest_layer_type.html" title="posix::basic_stream_descriptor::lowest_layer_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="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../lowest_layer.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="../lowest_layer_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_stream_descriptor.lowest_layer.overload2"></a><a class="link" href="overload2.html" title="posix::basic_stream_descriptor::lowest_layer (2 of 2 overloads)">posix::basic_stream_descriptor::lowest_layer + (2 of 2 overloads)</a> +</h5></div></div></div> +<p> + <span class="emphasis"><em>Inherited from posix::basic_descriptor.</em></span> + </p> +<p> + Get a const reference to the lowest layer. + </p> +<pre class="programlisting"><span class="keyword">const</span> <span class="identifier">lowest_layer_type</span> <span class="special">&</span> <span class="identifier">lowest_layer</span><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span> +</pre> +<p> + This function returns a const reference to the lowest layer in a stack + of layers. Since a <a class="link" href="../../posix__basic_descriptor.html" title="posix::basic_descriptor"><code class="computeroutput"><span class="identifier">posix</span><span class="special">::</span><span class="identifier">basic_descriptor</span></code></a> cannot contain + any further layers, it simply returns a reference to itself. + </p> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.lowest_layer.overload2.h0"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.lowest_layer.overload2.return_value"></a></span><a class="link" href="overload2.html#boost_asio.reference.posix__basic_stream_descriptor.lowest_layer.overload2.return_value">Return + Value</a> + </h6> +<p> + A const reference to the lowest layer in the stack of layers. Ownership + is not transferred to the caller. + </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="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../lowest_layer.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="../lowest_layer_type.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/posix__basic_stream_descriptor/lowest_layer_type.html b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/lowest_layer_type.html new file mode 100755 index 0000000000..829966e009 --- /dev/null +++ b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/lowest_layer_type.html @@ -0,0 +1,512 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>posix::basic_stream_descriptor::lowest_layer_type</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="../posix__basic_stream_descriptor.html" title="posix::basic_stream_descriptor"> +<link rel="prev" href="lowest_layer/overload2.html" title="posix::basic_stream_descriptor::lowest_layer (2 of 2 overloads)"> +<link rel="next" href="native.html" title="posix::basic_stream_descriptor::native"> +</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="lowest_layer/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_stream_descriptor.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.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.posix__basic_stream_descriptor.lowest_layer_type"></a><a class="link" href="lowest_layer_type.html" title="posix::basic_stream_descriptor::lowest_layer_type">posix::basic_stream_descriptor::lowest_layer_type</a> +</h4></div></div></div> +<p> + <span class="emphasis"><em>Inherited from posix::basic_descriptor.</em></span> + </p> +<p> + <a class="indexterm" name="id1473022"></a> +A <a class="link" href="../posix__basic_descriptor.html" title="posix::basic_descriptor"><code class="computeroutput"><span class="identifier">posix</span><span class="special">::</span><span class="identifier">basic_descriptor</span></code></a> is always the + lowest layer. + </p> +<pre class="programlisting"><span class="keyword">typedef</span> <span class="identifier">basic_descriptor</span><span class="special"><</span> <span class="identifier">StreamDescriptorService</span> <span class="special">></span> <span class="identifier">lowest_layer_type</span><span class="special">;</span> +</pre> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.lowest_layer_type.h0"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.lowest_layer_type.types"></a></span><a class="link" href="lowest_layer_type.html#boost_asio.reference.posix__basic_stream_descriptor.lowest_layer_type.types">Types</a> + </h6> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Name + </p> + </th> +<th> + <p> + Description + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> + <a class="link" href="../posix__basic_descriptor/bytes_readable.html" title="posix::basic_descriptor::bytes_readable"><span class="bold"><strong>bytes_readable</strong></span></a> + </p> + </td> +<td> + <p> + IO control command to get the amount of data that can be read + without blocking. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="../posix__basic_descriptor/implementation_type.html" title="posix::basic_descriptor::implementation_type"><span class="bold"><strong>implementation_type</strong></span></a> + </p> + </td> +<td> + <p> + The underlying implementation type of I/O object. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="../posix__basic_descriptor/lowest_layer_type.html" title="posix::basic_descriptor::lowest_layer_type"><span class="bold"><strong>lowest_layer_type</strong></span></a> + </p> + </td> +<td> + <p> + A basic_descriptor is always the lowest layer. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="../posix__basic_descriptor/native_handle_type.html" title="posix::basic_descriptor::native_handle_type"><span class="bold"><strong>native_handle_type</strong></span></a> + </p> + </td> +<td> + <p> + The native representation of a descriptor. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="../posix__basic_descriptor/native_type.html" title="posix::basic_descriptor::native_type"><span class="bold"><strong>native_type</strong></span></a> + </p> + </td> +<td> + <p> + (Deprecated: Use native_handle_type.) The native representation + of a descriptor. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="../posix__basic_descriptor/non_blocking_io.html" title="posix::basic_descriptor::non_blocking_io"><span class="bold"><strong>non_blocking_io</strong></span></a> + </p> + </td> +<td> + <p> + (Deprecated: Use non_blocking().) IO control command to set the + blocking mode of the descriptor. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="../posix__basic_descriptor/service_type.html" title="posix::basic_descriptor::service_type"><span class="bold"><strong>service_type</strong></span></a> + </p> + </td> +<td> + <p> + The type of the service that will be used to provide I/O operations. + </p> + </td> +</tr> +</tbody> +</table></div> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.lowest_layer_type.h1"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.lowest_layer_type.member_functions"></a></span><a class="link" href="lowest_layer_type.html#boost_asio.reference.posix__basic_stream_descriptor.lowest_layer_type.member_functions">Member + Functions</a> + </h6> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Name + </p> + </th> +<th> + <p> + Description + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> + <a class="link" href="../posix__basic_descriptor/assign.html" title="posix::basic_descriptor::assign"><span class="bold"><strong>assign</strong></span></a> + </p> + </td> +<td> + <p> + Assign an existing native descriptor to the descriptor. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="../posix__basic_descriptor/basic_descriptor.html" title="posix::basic_descriptor::basic_descriptor"><span class="bold"><strong>basic_descriptor</strong></span></a> + </p> + </td> +<td> + <p> + Construct a basic_descriptor without opening it. + </p> + <p> + Construct a basic_descriptor on an existing native descriptor. + </p> + <p> + Move-construct a basic_descriptor from another. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="../posix__basic_descriptor/cancel.html" title="posix::basic_descriptor::cancel"><span class="bold"><strong>cancel</strong></span></a> + </p> + </td> +<td> + <p> + Cancel all asynchronous operations associated with the descriptor. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="../posix__basic_descriptor/close.html" title="posix::basic_descriptor::close"><span class="bold"><strong>close</strong></span></a> + </p> + </td> +<td> + <p> + Close the descriptor. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="../posix__basic_descriptor/get_io_service.html" title="posix::basic_descriptor::get_io_service"><span class="bold"><strong>get_io_service</strong></span></a> + </p> + </td> +<td> + <p> + Get the io_service associated with the object. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="../posix__basic_descriptor/io_control.html" title="posix::basic_descriptor::io_control"><span class="bold"><strong>io_control</strong></span></a> + </p> + </td> +<td> + <p> + Perform an IO control command on the descriptor. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="../posix__basic_descriptor/is_open.html" title="posix::basic_descriptor::is_open"><span class="bold"><strong>is_open</strong></span></a> + </p> + </td> +<td> + <p> + Determine whether the descriptor is open. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="../posix__basic_descriptor/lowest_layer.html" title="posix::basic_descriptor::lowest_layer"><span class="bold"><strong>lowest_layer</strong></span></a> + </p> + </td> +<td> + <p> + Get a reference to the lowest layer. + </p> + <p> + Get a const reference to the lowest layer. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="../posix__basic_descriptor/native.html" title="posix::basic_descriptor::native"><span class="bold"><strong>native</strong></span></a> + </p> + </td> +<td> + <p> + (Deprecated: Use native_handle().) Get the native descriptor + representation. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="../posix__basic_descriptor/native_handle.html" title="posix::basic_descriptor::native_handle"><span class="bold"><strong>native_handle</strong></span></a> + </p> + </td> +<td> + <p> + Get the native descriptor representation. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="../posix__basic_descriptor/native_non_blocking.html" title="posix::basic_descriptor::native_non_blocking"><span class="bold"><strong>native_non_blocking</strong></span></a> + </p> + </td> +<td> + <p> + Gets the non-blocking mode of the native descriptor implementation. + </p> + <p> + Sets the non-blocking mode of the native descriptor implementation. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="../posix__basic_descriptor/non_blocking.html" title="posix::basic_descriptor::non_blocking"><span class="bold"><strong>non_blocking</strong></span></a> + </p> + </td> +<td> + <p> + Gets the non-blocking mode of the descriptor. + </p> + <p> + Sets the non-blocking mode of the descriptor. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="../posix__basic_descriptor/operator_eq_.html" title="posix::basic_descriptor::operator="><span class="bold"><strong>operator=</strong></span></a> + </p> + </td> +<td> + <p> + Move-assign a basic_descriptor from another. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="../posix__basic_descriptor/release.html" title="posix::basic_descriptor::release"><span class="bold"><strong>release</strong></span></a> + </p> + </td> +<td> + <p> + Release ownership of the native descriptor implementation. + </p> + </td> +</tr> +</tbody> +</table></div> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.lowest_layer_type.h2"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.lowest_layer_type.protected_member_functions"></a></span><a class="link" href="lowest_layer_type.html#boost_asio.reference.posix__basic_stream_descriptor.lowest_layer_type.protected_member_functions">Protected + Member Functions</a> + </h6> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Name + </p> + </th> +<th> + <p> + Description + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> + <a class="link" href="../posix__basic_descriptor/get_implementation.html" title="posix::basic_descriptor::get_implementation"><span class="bold"><strong>get_implementation</strong></span></a> + </p> + </td> +<td> + <p> + Get the underlying implementation of the I/O object. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="../posix__basic_descriptor/get_service.html" title="posix::basic_descriptor::get_service"><span class="bold"><strong>get_service</strong></span></a> + </p> + </td> +<td> + <p> + Get the service associated with the I/O object. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="../posix__basic_descriptor/_basic_descriptor.html" title="posix::basic_descriptor::~basic_descriptor"><span class="bold"><strong>~basic_descriptor</strong></span></a> + </p> + </td> +<td> + <p> + Protected destructor to prevent deletion through this type. + </p> + </td> +</tr> +</tbody> +</table></div> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.lowest_layer_type.h3"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.lowest_layer_type.protected_data_members"></a></span><a class="link" href="lowest_layer_type.html#boost_asio.reference.posix__basic_stream_descriptor.lowest_layer_type.protected_data_members">Protected + Data Members</a> + </h6> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Name + </p> + </th> +<th> + <p> + Description + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> + <a class="link" href="../posix__basic_descriptor/implementation.html" title="posix::basic_descriptor::implementation"><span class="bold"><strong>implementation</strong></span></a> + </p> + </td> +<td> + <p> + (Deprecated: Use get_implementation().) The underlying implementation + of the I/O object. + </p> + </td> +</tr> +<tr> +<td> + <p> + <a class="link" href="../posix__basic_descriptor/service.html" title="posix::basic_descriptor::service"><span class="bold"><strong>service</strong></span></a> + </p> + </td> +<td> + <p> + (Deprecated: Use get_service().) The service associated with + the I/O object. + </p> + </td> +</tr> +</tbody> +</table></div> +<p> + The <a class="link" href="../posix__basic_descriptor.html" title="posix::basic_descriptor"><code class="computeroutput"><span class="identifier">posix</span><span class="special">::</span><span class="identifier">basic_descriptor</span></code></a> class template + provides the ability to wrap a POSIX descriptor. + </p> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.lowest_layer_type.h4"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.lowest_layer_type.thread_safety"></a></span><a class="link" href="lowest_layer_type.html#boost_asio.reference.posix__basic_stream_descriptor.lowest_layer_type.thread_safety">Thread + Safety</a> + </h6> +<p> + <span class="bold"><strong>Distinct</strong></span> <span class="bold"><strong>objects:</strong></span> + Safe. + </p> +<p> + <span class="bold"><strong>Shared</strong></span> <span class="bold"><strong>objects:</strong></span> + Unsafe. + </p> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.lowest_layer_type.h5"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.lowest_layer_type.requirements"></a></span><a class="link" href="lowest_layer_type.html#boost_asio.reference.posix__basic_stream_descriptor.lowest_layer_type.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>Header: </strong></span><code class="literal">boost/asio/posix/basic_stream_descriptor.hpp</code> + </p> +<p> + <span class="bold"><strong>Convenience header: </strong></span><code class="literal">boost/asio.hpp</code> + </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="lowest_layer/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_stream_descriptor.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.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/posix__basic_stream_descriptor/native.html b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/native.html new file mode 100755 index 0000000000..8a531fa25b --- /dev/null +++ b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/native.html @@ -0,0 +1,57 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>posix::basic_stream_descriptor::native</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="../posix__basic_stream_descriptor.html" title="posix::basic_stream_descriptor"> +<link rel="prev" href="lowest_layer_type.html" title="posix::basic_stream_descriptor::lowest_layer_type"> +<link rel="next" href="native_handle.html" title="posix::basic_stream_descriptor::native_handle"> +</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="lowest_layer_type.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_stream_descriptor.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_handle.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.posix__basic_stream_descriptor.native"></a><a class="link" href="native.html" title="posix::basic_stream_descriptor::native">posix::basic_stream_descriptor::native</a> +</h4></div></div></div> +<p> + <span class="emphasis"><em>Inherited from posix::basic_descriptor.</em></span> + </p> +<p> + <a class="indexterm" name="id1474315"></a> +(Deprecated: Use <code class="computeroutput"><span class="identifier">native_handle</span><span class="special">()</span></code>.) Get the native descriptor representation. + </p> +<pre class="programlisting"><span class="identifier">native_type</span> <span class="identifier">native</span><span class="special">();</span> +</pre> +<p> + This function may be used to obtain the underlying representation of the + descriptor. This is intended to allow access to native descriptor functionality + that is not otherwise provided. + </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="lowest_layer_type.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_stream_descriptor.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_handle.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/posix__basic_stream_descriptor/native_handle.html b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/native_handle.html new file mode 100755 index 0000000000..984c94b4d8 --- /dev/null +++ b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/native_handle.html @@ -0,0 +1,57 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>posix::basic_stream_descriptor::native_handle</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="../posix__basic_stream_descriptor.html" title="posix::basic_stream_descriptor"> +<link rel="prev" href="native.html" title="posix::basic_stream_descriptor::native"> +<link rel="next" href="native_handle_type.html" title="posix::basic_stream_descriptor::native_handle_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="native.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_stream_descriptor.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_handle_type.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.posix__basic_stream_descriptor.native_handle"></a><a class="link" href="native_handle.html" title="posix::basic_stream_descriptor::native_handle">posix::basic_stream_descriptor::native_handle</a> +</h4></div></div></div> +<p> + <span class="emphasis"><em>Inherited from posix::basic_descriptor.</em></span> + </p> +<p> + <a class="indexterm" name="id1474400"></a> +Get the native descriptor representation. + </p> +<pre class="programlisting"><span class="identifier">native_handle_type</span> <span class="identifier">native_handle</span><span class="special">();</span> +</pre> +<p> + This function may be used to obtain the underlying representation of the + descriptor. This is intended to allow access to native descriptor functionality + that is not otherwise provided. + </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.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_stream_descriptor.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_handle_type.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/posix__basic_stream_descriptor/native_handle_type.html b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/native_handle_type.html new file mode 100755 index 0000000000..6cd08f66cf --- /dev/null +++ b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/native_handle_type.html @@ -0,0 +1,60 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>posix::basic_stream_descriptor::native_handle_type</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="../posix__basic_stream_descriptor.html" title="posix::basic_stream_descriptor"> +<link rel="prev" href="native_handle.html" title="posix::basic_stream_descriptor::native_handle"> +<link rel="next" href="native_non_blocking.html" title="posix::basic_stream_descriptor::native_non_blocking"> +</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_handle.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_stream_descriptor.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_non_blocking.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.posix__basic_stream_descriptor.native_handle_type"></a><a class="link" href="native_handle_type.html" title="posix::basic_stream_descriptor::native_handle_type">posix::basic_stream_descriptor::native_handle_type</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1474461"></a> +The native representation + of a descriptor. + </p> +<pre class="programlisting"><span class="keyword">typedef</span> <span class="identifier">StreamDescriptorService</span><span class="special">::</span><span class="identifier">native_handle_type</span> <span class="identifier">native_handle_type</span><span class="special">;</span> +</pre> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.native_handle_type.h0"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.native_handle_type.requirements"></a></span><a class="link" href="native_handle_type.html#boost_asio.reference.posix__basic_stream_descriptor.native_handle_type.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>Header: </strong></span><code class="literal">boost/asio/posix/basic_stream_descriptor.hpp</code> + </p> +<p> + <span class="bold"><strong>Convenience header: </strong></span><code class="literal">boost/asio.hpp</code> + </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_handle.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_stream_descriptor.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_non_blocking.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/posix__basic_stream_descriptor/native_non_blocking.html b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/native_non_blocking.html new file mode 100755 index 0000000000..821179041b --- /dev/null +++ b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/native_non_blocking.html @@ -0,0 +1,63 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>posix::basic_stream_descriptor::native_non_blocking</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="../posix__basic_stream_descriptor.html" title="posix::basic_stream_descriptor"> +<link rel="prev" href="native_handle_type.html" title="posix::basic_stream_descriptor::native_handle_type"> +<link rel="next" href="native_non_blocking/overload1.html" title="posix::basic_stream_descriptor::native_non_blocking (1 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_handle_type.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_stream_descriptor.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_non_blocking/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.posix__basic_stream_descriptor.native_non_blocking"></a><a class="link" href="native_non_blocking.html" title="posix::basic_stream_descriptor::native_non_blocking">posix::basic_stream_descriptor::native_non_blocking</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1474587"></a> +Gets the non-blocking + mode of the native descriptor implementation. + </p> +<pre class="programlisting"><span class="keyword">bool</span> <a class="link" href="native_non_blocking/overload1.html" title="posix::basic_stream_descriptor::native_non_blocking (1 of 3 overloads)">native_non_blocking</a><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span> + <span class="emphasis"><em>» <a class="link" href="native_non_blocking/overload1.html" title="posix::basic_stream_descriptor::native_non_blocking (1 of 3 overloads)">more...</a></em></span> +</pre> +<p> + Sets the non-blocking mode of the native descriptor implementation. + </p> +<pre class="programlisting"><span class="keyword">void</span> <a class="link" href="native_non_blocking/overload2.html" title="posix::basic_stream_descriptor::native_non_blocking (2 of 3 overloads)">native_non_blocking</a><span class="special">(</span> + <span class="keyword">bool</span> <span class="identifier">mode</span><span class="special">);</span> + <span class="emphasis"><em>» <a class="link" href="native_non_blocking/overload2.html" title="posix::basic_stream_descriptor::native_non_blocking (2 of 3 overloads)">more...</a></em></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> <a class="link" href="native_non_blocking/overload3.html" title="posix::basic_stream_descriptor::native_non_blocking (3 of 3 overloads)">native_non_blocking</a><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> + <span class="emphasis"><em>» <a class="link" href="native_non_blocking/overload3.html" title="posix::basic_stream_descriptor::native_non_blocking (3 of 3 overloads)">more...</a></em></span> +</pre> +</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_handle_type.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_stream_descriptor.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_non_blocking/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/posix__basic_stream_descriptor/native_non_blocking/overload1.html b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/native_non_blocking/overload1.html new file mode 100755 index 0000000000..d6085a59bb --- /dev/null +++ b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/native_non_blocking/overload1.html @@ -0,0 +1,76 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>posix::basic_stream_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_stream_descriptor::native_non_blocking"> +<link rel="prev" href="../native_non_blocking.html" title="posix::basic_stream_descriptor::native_non_blocking"> +<link rel="next" href="overload2.html" title="posix::basic_stream_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_stream_descriptor.native_non_blocking.overload1"></a><a class="link" href="overload1.html" title="posix::basic_stream_descriptor::native_non_blocking (1 of 3 overloads)">posix::basic_stream_descriptor::native_non_blocking + (1 of 3 overloads)</a> +</h5></div></div></div> +<p> + <span class="emphasis"><em>Inherited from posix::basic_descriptor.</em></span> + </p> +<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_stream_descriptor.native_non_blocking.overload1.h0"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.native_non_blocking.overload1.return_value"></a></span><a class="link" href="overload1.html#boost_asio.reference.posix__basic_stream_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_stream_descriptor.native_non_blocking.overload1.h1"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.native_non_blocking.overload1.remarks"></a></span><a class="link" href="overload1.html#boost_asio.reference.posix__basic_stream_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_stream_descriptor/native_non_blocking/overload2.html b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/native_non_blocking/overload2.html new file mode 100755 index 0000000000..d63b4d7084 --- /dev/null +++ b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/native_non_blocking/overload2.html @@ -0,0 +1,91 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>posix::basic_stream_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_stream_descriptor::native_non_blocking"> +<link rel="prev" href="overload1.html" title="posix::basic_stream_descriptor::native_non_blocking (1 of 3 overloads)"> +<link rel="next" href="overload3.html" title="posix::basic_stream_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_stream_descriptor.native_non_blocking.overload2"></a><a class="link" href="overload2.html" title="posix::basic_stream_descriptor::native_non_blocking (2 of 3 overloads)">posix::basic_stream_descriptor::native_non_blocking + (2 of 3 overloads)</a> +</h5></div></div></div> +<p> + <span class="emphasis"><em>Inherited from posix::basic_descriptor.</em></span> + </p> +<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_stream_descriptor.native_non_blocking.overload2.h0"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.native_non_blocking.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.posix__basic_stream_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_stream_descriptor.native_non_blocking.overload2.h1"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.native_non_blocking.overload2.exceptions"></a></span><a class="link" href="overload2.html#boost_asio.reference.posix__basic_stream_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_stream_descriptor/native_non_blocking/overload3.html b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/native_non_blocking/overload3.html new file mode 100755 index 0000000000..78a6c3d5bd --- /dev/null +++ b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/native_non_blocking/overload3.html @@ -0,0 +1,82 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>posix::basic_stream_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_stream_descriptor::native_non_blocking"> +<link rel="prev" href="overload2.html" title="posix::basic_stream_descriptor::native_non_blocking (2 of 3 overloads)"> +<link rel="next" href="../native_type.html" title="posix::basic_stream_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_stream_descriptor.native_non_blocking.overload3"></a><a class="link" href="overload3.html" title="posix::basic_stream_descriptor::native_non_blocking (3 of 3 overloads)">posix::basic_stream_descriptor::native_non_blocking + (3 of 3 overloads)</a> +</h5></div></div></div> +<p> + <span class="emphasis"><em>Inherited from posix::basic_descriptor.</em></span> + </p> +<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_stream_descriptor.native_non_blocking.overload3.h0"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.native_non_blocking.overload3.parameters"></a></span><a class="link" href="overload3.html#boost_asio.reference.posix__basic_stream_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> diff --git a/doc/html/boost_asio/reference/posix__basic_stream_descriptor/native_type.html b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/native_type.html new file mode 100755 index 0000000000..46b1976cc4 --- /dev/null +++ b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/native_type.html @@ -0,0 +1,60 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>posix::basic_stream_descriptor::native_type</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="../posix__basic_stream_descriptor.html" title="posix::basic_stream_descriptor"> +<link rel="prev" href="native_non_blocking/overload3.html" title="posix::basic_stream_descriptor::native_non_blocking (3 of 3 overloads)"> +<link rel="next" href="non_blocking.html" title="posix::basic_stream_descriptor::non_blocking"> +</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/overload3.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_stream_descriptor.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="non_blocking.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.posix__basic_stream_descriptor.native_type"></a><a class="link" href="native_type.html" title="posix::basic_stream_descriptor::native_type">posix::basic_stream_descriptor::native_type</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1475657"></a> +(Deprecated: Use native_handle_type.) + The native representation of a descriptor. + </p> +<pre class="programlisting"><span class="keyword">typedef</span> <span class="identifier">StreamDescriptorService</span><span class="special">::</span><span class="identifier">native_handle_type</span> <span class="identifier">native_type</span><span class="special">;</span> +</pre> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.native_type.h0"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.native_type.requirements"></a></span><a class="link" href="native_type.html#boost_asio.reference.posix__basic_stream_descriptor.native_type.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>Header: </strong></span><code class="literal">boost/asio/posix/basic_stream_descriptor.hpp</code> + </p> +<p> + <span class="bold"><strong>Convenience header: </strong></span><code class="literal">boost/asio.hpp</code> + </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/overload3.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_stream_descriptor.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="non_blocking.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/posix__basic_stream_descriptor/non_blocking.html b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/non_blocking.html new file mode 100755 index 0000000000..eba6eb8fb6 --- /dev/null +++ b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/non_blocking.html @@ -0,0 +1,63 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>posix::basic_stream_descriptor::non_blocking</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="../posix__basic_stream_descriptor.html" title="posix::basic_stream_descriptor"> +<link rel="prev" href="native_type.html" title="posix::basic_stream_descriptor::native_type"> +<link rel="next" href="non_blocking/overload1.html" title="posix::basic_stream_descriptor::non_blocking (1 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_type.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_stream_descriptor.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="non_blocking/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.posix__basic_stream_descriptor.non_blocking"></a><a class="link" href="non_blocking.html" title="posix::basic_stream_descriptor::non_blocking">posix::basic_stream_descriptor::non_blocking</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1475783"></a> +Gets the non-blocking mode of + the descriptor. + </p> +<pre class="programlisting"><span class="keyword">bool</span> <a class="link" href="non_blocking/overload1.html" title="posix::basic_stream_descriptor::non_blocking (1 of 3 overloads)">non_blocking</a><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span> + <span class="emphasis"><em>» <a class="link" href="non_blocking/overload1.html" title="posix::basic_stream_descriptor::non_blocking (1 of 3 overloads)">more...</a></em></span> +</pre> +<p> + Sets the non-blocking mode of the descriptor. + </p> +<pre class="programlisting"><span class="keyword">void</span> <a class="link" href="non_blocking/overload2.html" title="posix::basic_stream_descriptor::non_blocking (2 of 3 overloads)">non_blocking</a><span class="special">(</span> + <span class="keyword">bool</span> <span class="identifier">mode</span><span class="special">);</span> + <span class="emphasis"><em>» <a class="link" href="non_blocking/overload2.html" title="posix::basic_stream_descriptor::non_blocking (2 of 3 overloads)">more...</a></em></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> <a class="link" href="non_blocking/overload3.html" title="posix::basic_stream_descriptor::non_blocking (3 of 3 overloads)">non_blocking</a><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> + <span class="emphasis"><em>» <a class="link" href="non_blocking/overload3.html" title="posix::basic_stream_descriptor::non_blocking (3 of 3 overloads)">more...</a></em></span> +</pre> +</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_type.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_stream_descriptor.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="non_blocking/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/posix__basic_stream_descriptor/non_blocking/overload1.html b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/non_blocking/overload1.html new file mode 100755 index 0000000000..efa7a2dfa8 --- /dev/null +++ b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/non_blocking/overload1.html @@ -0,0 +1,72 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>posix::basic_stream_descriptor::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="../non_blocking.html" title="posix::basic_stream_descriptor::non_blocking"> +<link rel="prev" href="../non_blocking.html" title="posix::basic_stream_descriptor::non_blocking"> +<link rel="next" href="overload2.html" title="posix::basic_stream_descriptor::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="../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> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.posix__basic_stream_descriptor.non_blocking.overload1"></a><a class="link" href="overload1.html" title="posix::basic_stream_descriptor::non_blocking (1 of 3 overloads)">posix::basic_stream_descriptor::non_blocking + (1 of 3 overloads)</a> +</h5></div></div></div> +<p> + <span class="emphasis"><em>Inherited from posix::basic_descriptor.</em></span> + </p> +<p> + Gets the non-blocking mode of the descriptor. + </p> +<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> +</pre> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.non_blocking.overload1.h0"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.non_blocking.overload1.return_value"></a></span><a class="link" href="overload1.html#boost_asio.reference.posix__basic_stream_descriptor.non_blocking.overload1.return_value">Return + Value</a> + </h6> +<p> + <code class="computeroutput"><span class="keyword">true</span></code> if the descriptor's + synchronous 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> + if they are unable to perform the requested operation immediately. If + <code class="computeroutput"><span class="keyword">false</span></code>, synchronous operations + will block until complete. + </p> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.non_blocking.overload1.h1"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.non_blocking.overload1.remarks"></a></span><a class="link" href="overload1.html#boost_asio.reference.posix__basic_stream_descriptor.non_blocking.overload1.remarks">Remarks</a> + </h6> +<p> + The non-blocking mode has no effect on the behaviour of asynchronous + 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>. + </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="../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> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/posix__basic_stream_descriptor/non_blocking/overload2.html b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/non_blocking/overload2.html new file mode 100755 index 0000000000..587703d692 --- /dev/null +++ b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/non_blocking/overload2.html @@ -0,0 +1,91 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>posix::basic_stream_descriptor::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="../non_blocking.html" title="posix::basic_stream_descriptor::non_blocking"> +<link rel="prev" href="overload1.html" title="posix::basic_stream_descriptor::non_blocking (1 of 3 overloads)"> +<link rel="next" href="overload3.html" title="posix::basic_stream_descriptor::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="../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_stream_descriptor.non_blocking.overload2"></a><a class="link" href="overload2.html" title="posix::basic_stream_descriptor::non_blocking (2 of 3 overloads)">posix::basic_stream_descriptor::non_blocking + (2 of 3 overloads)</a> +</h5></div></div></div> +<p> + <span class="emphasis"><em>Inherited from posix::basic_descriptor.</em></span> + </p> +<p> + Sets the non-blocking mode of the descriptor. + </p> +<pre class="programlisting"><span class="keyword">void</span> <span class="identifier">non_blocking</span><span class="special">(</span> + <span class="keyword">bool</span> <span class="identifier">mode</span><span class="special">);</span> +</pre> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.non_blocking.overload2.h0"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.non_blocking.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.posix__basic_stream_descriptor.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 descriptor's + synchronous 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> + if they are unable to perform the requested operation immediately. + If <code class="computeroutput"><span class="keyword">false</span></code>, synchronous + operations will block until complete. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.non_blocking.overload2.h1"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.non_blocking.overload2.exceptions"></a></span><a class="link" href="overload2.html#boost_asio.reference.posix__basic_stream_descriptor.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. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.non_blocking.overload2.h2"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.non_blocking.overload2.remarks"></a></span><a class="link" href="overload2.html#boost_asio.reference.posix__basic_stream_descriptor.non_blocking.overload2.remarks">Remarks</a> + </h6> +<p> + The non-blocking mode has no effect on the behaviour of asynchronous + 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>. + </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="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> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/posix__basic_stream_descriptor/non_blocking/overload3.html b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/non_blocking/overload3.html new file mode 100755 index 0000000000..9f87c510a7 --- /dev/null +++ b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/non_blocking/overload3.html @@ -0,0 +1,83 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>posix::basic_stream_descriptor::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="../non_blocking.html" title="posix::basic_stream_descriptor::non_blocking"> +<link rel="prev" href="overload2.html" title="posix::basic_stream_descriptor::non_blocking (2 of 3 overloads)"> +<link rel="next" href="../non_blocking_io.html" title="posix::basic_stream_descriptor::non_blocking_io"> +</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="../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="../non_blocking_io.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_stream_descriptor.non_blocking.overload3"></a><a class="link" href="overload3.html" title="posix::basic_stream_descriptor::non_blocking (3 of 3 overloads)">posix::basic_stream_descriptor::non_blocking + (3 of 3 overloads)</a> +</h5></div></div></div> +<p> + <span class="emphasis"><em>Inherited from posix::basic_descriptor.</em></span> + </p> +<p> + Sets the non-blocking mode of the descriptor. + </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">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> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.non_blocking.overload3.h0"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.non_blocking.overload3.parameters"></a></span><a class="link" href="overload3.html#boost_asio.reference.posix__basic_stream_descriptor.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 descriptor's + synchronous 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> + if they are unable to perform the requested operation immediately. + If <code class="computeroutput"><span class="keyword">false</span></code>, synchronous + operations will block until complete. + </p></dd> +<dt><span class="term">ec</span></dt> +<dd><p> + Set to indicate what error occurred, if any. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.non_blocking.overload3.h1"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.non_blocking.overload3.remarks"></a></span><a class="link" href="overload3.html#boost_asio.reference.posix__basic_stream_descriptor.non_blocking.overload3.remarks">Remarks</a> + </h6> +<p> + The non-blocking mode has no effect on the behaviour of asynchronous + 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>. + </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="overload2.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="../non_blocking_io.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/posix__basic_stream_descriptor/non_blocking_io.html b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/non_blocking_io.html new file mode 100755 index 0000000000..d458a8b381 --- /dev/null +++ b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/non_blocking_io.html @@ -0,0 +1,75 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>posix::basic_stream_descriptor::non_blocking_io</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="../posix__basic_stream_descriptor.html" title="posix::basic_stream_descriptor"> +<link rel="prev" href="non_blocking/overload3.html" title="posix::basic_stream_descriptor::non_blocking (3 of 3 overloads)"> +<link rel="next" href="operator_eq_.html" title="posix::basic_stream_descriptor::operator="> +</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="non_blocking/overload3.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_stream_descriptor.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="operator_eq_.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.posix__basic_stream_descriptor.non_blocking_io"></a><a class="link" href="non_blocking_io.html" title="posix::basic_stream_descriptor::non_blocking_io">posix::basic_stream_descriptor::non_blocking_io</a> +</h4></div></div></div> +<p> + <span class="emphasis"><em>Inherited from posix::descriptor_base.</em></span> + </p> +<p> + <a class="indexterm" name="id1476872"></a> +(Deprecated: Use non_blocking().) + IO control command to set the blocking mode of the descriptor. + </p> +<pre class="programlisting"><span class="keyword">typedef</span> <span class="identifier">implementation_defined</span> <span class="identifier">non_blocking_io</span><span class="special">;</span> +</pre> +<p> + Implements the FIONBIO IO control command. + </p> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.non_blocking_io.h0"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.non_blocking_io.example"></a></span><a class="link" href="non_blocking_io.html#boost_asio.reference.posix__basic_stream_descriptor.non_blocking_io.example">Example</a> + </h6> +<pre class="programlisting"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">posix</span><span class="special">::</span><span class="identifier">stream_descriptor</span> <span class="identifier">descriptor</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">);</span> +<span class="special">...</span> +<span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">descriptor_base</span><span class="special">::</span><span class="identifier">non_blocking_io</span> <span class="identifier">command</span><span class="special">(</span><span class="keyword">true</span><span class="special">);</span> +<span class="identifier">descriptor</span><span class="special">.</span><span class="identifier">io_control</span><span class="special">(</span><span class="identifier">command</span><span class="special">);</span> +</pre> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.non_blocking_io.h1"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.non_blocking_io.requirements"></a></span><a class="link" href="non_blocking_io.html#boost_asio.reference.posix__basic_stream_descriptor.non_blocking_io.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>Header: </strong></span><code class="literal">boost/asio/posix/basic_stream_descriptor.hpp</code> + </p> +<p> + <span class="bold"><strong>Convenience header: </strong></span><code class="literal">boost/asio.hpp</code> + </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="non_blocking/overload3.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_stream_descriptor.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="operator_eq_.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/posix__basic_stream_descriptor/operator_eq_.html b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/operator_eq_.html new file mode 100755 index 0000000000..9ef7ba77f1 --- /dev/null +++ b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/operator_eq_.html @@ -0,0 +1,75 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>posix::basic_stream_descriptor::operator=</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="../posix__basic_stream_descriptor.html" title="posix::basic_stream_descriptor"> +<link rel="prev" href="non_blocking_io.html" title="posix::basic_stream_descriptor::non_blocking_io"> +<link rel="next" href="read_some.html" title="posix::basic_stream_descriptor::read_some"> +</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="non_blocking_io.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_stream_descriptor.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="read_some.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.posix__basic_stream_descriptor.operator_eq_"></a><a class="link" href="operator_eq_.html" title="posix::basic_stream_descriptor::operator=">posix::basic_stream_descriptor::operator=</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1477161"></a> +Move-assign a <a class="link" href="../posix__basic_stream_descriptor.html" title="posix::basic_stream_descriptor"><code class="computeroutput"><span class="identifier">posix</span><span class="special">::</span><span class="identifier">basic_stream_descriptor</span></code></a> from another. + </p> +<pre class="programlisting"><span class="identifier">basic_stream_descriptor</span> <span class="special">&</span> <span class="keyword">operator</span><span class="special">=(</span> + <span class="identifier">basic_stream_descriptor</span> <span class="special">&&</span> <span class="identifier">other</span><span class="special">);</span> +</pre> +<p> + This assignment operator moves a stream descriptor from one object to another. + </p> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.operator_eq_.h0"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.operator_eq_.parameters"></a></span><a class="link" href="operator_eq_.html#boost_asio.reference.posix__basic_stream_descriptor.operator_eq_.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">other</span></dt> +<dd><p> + The other <a class="link" href="../posix__basic_stream_descriptor.html" title="posix::basic_stream_descriptor"><code class="computeroutput"><span class="identifier">posix</span><span class="special">::</span><span class="identifier">basic_stream_descriptor</span></code></a> + object from which the move will occur. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.operator_eq_.h1"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.operator_eq_.remarks"></a></span><a class="link" href="operator_eq_.html#boost_asio.reference.posix__basic_stream_descriptor.operator_eq_.remarks">Remarks</a> + </h6> +<p> + Following the move, the moved-from object is in the same state as if constructed + using the <code class="computeroutput"><span class="identifier">basic_stream_descriptor</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">&)</span> <span class="identifier">constructor</span></code>. + </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="non_blocking_io.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_stream_descriptor.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="read_some.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/posix__basic_stream_descriptor/read_some.html b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/read_some.html new file mode 100755 index 0000000000..d60dad3416 --- /dev/null +++ b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/read_some.html @@ -0,0 +1,60 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>posix::basic_stream_descriptor::read_some</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="../posix__basic_stream_descriptor.html" title="posix::basic_stream_descriptor"> +<link rel="prev" href="operator_eq_.html" title="posix::basic_stream_descriptor::operator="> +<link rel="next" href="read_some/overload1.html" title="posix::basic_stream_descriptor::read_some (1 of 2 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="operator_eq_.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_stream_descriptor.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="read_some/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.posix__basic_stream_descriptor.read_some"></a><a class="link" href="read_some.html" title="posix::basic_stream_descriptor::read_some">posix::basic_stream_descriptor::read_some</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1477405"></a> +Read some data from the descriptor. + </p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> + <span class="keyword">typename</span> <a class="link" href="../MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a><span class="special">></span> +<span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="read_some/overload1.html" title="posix::basic_stream_descriptor::read_some (1 of 2 overloads)">read_some</a><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">MutableBufferSequence</span> <span class="special">&</span> <span class="identifier">buffers</span><span class="special">);</span> + <span class="emphasis"><em>» <a class="link" href="read_some/overload1.html" title="posix::basic_stream_descriptor::read_some (1 of 2 overloads)">more...</a></em></span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="keyword">typename</span> <a class="link" href="../MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a><span class="special">></span> +<span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="read_some/overload2.html" title="posix::basic_stream_descriptor::read_some (2 of 2 overloads)">read_some</a><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">MutableBufferSequence</span> <span class="special">&</span> <span class="identifier">buffers</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> + <span class="emphasis"><em>» <a class="link" href="read_some/overload2.html" title="posix::basic_stream_descriptor::read_some (2 of 2 overloads)">more...</a></em></span> +</pre> +</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="operator_eq_.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_stream_descriptor.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="read_some/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/posix__basic_stream_descriptor/read_some/overload1.html b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/read_some/overload1.html new file mode 100755 index 0000000000..2776747aeb --- /dev/null +++ b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/read_some/overload1.html @@ -0,0 +1,116 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>posix::basic_stream_descriptor::read_some (1 of 2 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="../read_some.html" title="posix::basic_stream_descriptor::read_some"> +<link rel="prev" href="../read_some.html" title="posix::basic_stream_descriptor::read_some"> +<link rel="next" href="overload2.html" title="posix::basic_stream_descriptor::read_some (2 of 2 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="../read_some.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../read_some.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_stream_descriptor.read_some.overload1"></a><a class="link" href="overload1.html" title="posix::basic_stream_descriptor::read_some (1 of 2 overloads)">posix::basic_stream_descriptor::read_some + (1 of 2 overloads)</a> +</h5></div></div></div> +<p> + Read some data from the descriptor. + </p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> + <span class="keyword">typename</span> <a class="link" href="../../MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a><span class="special">></span> +<span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">read_some</span><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">MutableBufferSequence</span> <span class="special">&</span> <span class="identifier">buffers</span><span class="special">);</span> +</pre> +<p> + This function is used to read data from the stream descriptor. The function + call will block until one or more bytes of data has been read successfully, + or until an error occurs. + </p> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.read_some.overload1.h0"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.read_some.overload1.parameters"></a></span><a class="link" href="overload1.html#boost_asio.reference.posix__basic_stream_descriptor.read_some.overload1.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">buffers</span></dt> +<dd><p> + One or more buffers into which the data will be read. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.read_some.overload1.h1"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.read_some.overload1.return_value"></a></span><a class="link" href="overload1.html#boost_asio.reference.posix__basic_stream_descriptor.read_some.overload1.return_value">Return + Value</a> + </h6> +<p> + The number of bytes read. + </p> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.read_some.overload1.h2"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.read_some.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.posix__basic_stream_descriptor.read_some.overload1.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. An error code of <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">eof</span></code> + indicates that the connection was closed by the peer. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.read_some.overload1.h3"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.read_some.overload1.remarks"></a></span><a class="link" href="overload1.html#boost_asio.reference.posix__basic_stream_descriptor.read_some.overload1.remarks">Remarks</a> + </h6> +<p> + The read_some operation may not read all of the requested number of bytes. + Consider using the <a class="link" href="../../read.html" title="read"><code class="computeroutput"><span class="identifier">read</span></code></a> function if you need to + ensure that the requested amount of data is read before the blocking + operation completes. + </p> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.read_some.overload1.h4"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.read_some.overload1.example"></a></span><a class="link" href="overload1.html#boost_asio.reference.posix__basic_stream_descriptor.read_some.overload1.example">Example</a> + </h6> +<p> + To read into a single data buffer use the <a class="link" href="../../buffer.html" title="buffer"><code class="computeroutput"><span class="identifier">buffer</span></code></a> function as follows: + </p> +<pre class="programlisting"><span class="identifier">descriptor</span><span class="special">.</span><span class="identifier">read_some</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">buffer</span><span class="special">(</span><span class="identifier">data</span><span class="special">,</span> <span class="identifier">size</span><span class="special">));</span> +</pre> +<p> + See the <a class="link" href="../../buffer.html" title="buffer"><code class="computeroutput"><span class="identifier">buffer</span></code></a> + documentation for information on reading into multiple buffers in one + go, and how to use it with arrays, boost::array or std::vector. + </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="../read_some.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../read_some.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_stream_descriptor/read_some/overload2.html b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/read_some/overload2.html new file mode 100755 index 0000000000..cb9dedca7b --- /dev/null +++ b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/read_some/overload2.html @@ -0,0 +1,93 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>posix::basic_stream_descriptor::read_some (2 of 2 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="../read_some.html" title="posix::basic_stream_descriptor::read_some"> +<link rel="prev" href="overload1.html" title="posix::basic_stream_descriptor::read_some (1 of 2 overloads)"> +<link rel="next" href="../release.html" title="posix::basic_stream_descriptor::release"> +</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="../read_some.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="../release.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_stream_descriptor.read_some.overload2"></a><a class="link" href="overload2.html" title="posix::basic_stream_descriptor::read_some (2 of 2 overloads)">posix::basic_stream_descriptor::read_some + (2 of 2 overloads)</a> +</h5></div></div></div> +<p> + Read some data from the descriptor. + </p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> + <span class="keyword">typename</span> <a class="link" href="../../MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a><span class="special">></span> +<span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">read_some</span><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">MutableBufferSequence</span> <span class="special">&</span> <span class="identifier">buffers</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 read data from the stream descriptor. The function + call will block until one or more bytes of data has been read successfully, + or until an error occurs. + </p> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.read_some.overload2.h0"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.read_some.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.posix__basic_stream_descriptor.read_some.overload2.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">buffers</span></dt> +<dd><p> + One or more buffers into which the data will be read. + </p></dd> +<dt><span class="term">ec</span></dt> +<dd><p> + Set to indicate what error occurred, if any. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.read_some.overload2.h1"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.read_some.overload2.return_value"></a></span><a class="link" href="overload2.html#boost_asio.reference.posix__basic_stream_descriptor.read_some.overload2.return_value">Return + Value</a> + </h6> +<p> + The number of bytes read. Returns 0 if an error occurred. + </p> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.read_some.overload2.h2"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.read_some.overload2.remarks"></a></span><a class="link" href="overload2.html#boost_asio.reference.posix__basic_stream_descriptor.read_some.overload2.remarks">Remarks</a> + </h6> +<p> + The read_some operation may not read all of the requested number of bytes. + Consider using the <a class="link" href="../../read.html" title="read"><code class="computeroutput"><span class="identifier">read</span></code></a> function if you need to + ensure that the requested amount of data is read before the blocking + operation completes. + </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="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../read_some.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="../release.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/posix__basic_stream_descriptor/release.html b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/release.html new file mode 100755 index 0000000000..4180c90c88 --- /dev/null +++ b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/release.html @@ -0,0 +1,62 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>posix::basic_stream_descriptor::release</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="../posix__basic_stream_descriptor.html" title="posix::basic_stream_descriptor"> +<link rel="prev" href="read_some/overload2.html" title="posix::basic_stream_descriptor::read_some (2 of 2 overloads)"> +<link rel="next" href="service.html" title="posix::basic_stream_descriptor::service"> +</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="read_some/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_stream_descriptor.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="service.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.posix__basic_stream_descriptor.release"></a><a class="link" href="release.html" title="posix::basic_stream_descriptor::release">posix::basic_stream_descriptor::release</a> +</h4></div></div></div> +<p> + <span class="emphasis"><em>Inherited from posix::basic_descriptor.</em></span> + </p> +<p> + <a class="indexterm" name="id1478450"></a> +Release ownership of the native descriptor + implementation. + </p> +<pre class="programlisting"><span class="identifier">native_handle_type</span> <span class="identifier">release</span><span class="special">();</span> +</pre> +<p> + This function may be used to obtain the underlying representation of the + descriptor. After calling this function, <code class="computeroutput"><span class="identifier">is_open</span><span class="special">()</span></code> returns false. The caller is responsible + for closing the descriptor. + </p> +<p> + All outstanding asynchronous read or write operations will finish immediately, + and the handlers for cancelled operations will be passed the <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">operation_aborted</span></code> error. + </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="read_some/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_stream_descriptor.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="service.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/posix__basic_stream_descriptor/service.html b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/service.html new file mode 100755 index 0000000000..81988f23ea --- /dev/null +++ b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/service.html @@ -0,0 +1,60 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>posix::basic_stream_descriptor::service</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="../posix__basic_stream_descriptor.html" title="posix::basic_stream_descriptor"> +<link rel="prev" href="release.html" title="posix::basic_stream_descriptor::release"> +<link rel="next" href="service_type.html" title="posix::basic_stream_descriptor::service_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="release.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_stream_descriptor.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="service_type.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.posix__basic_stream_descriptor.service"></a><a class="link" href="service.html" title="posix::basic_stream_descriptor::service">posix::basic_stream_descriptor::service</a> +</h4></div></div></div> +<p> + <span class="emphasis"><em>Inherited from basic_io_object.</em></span> + </p> +<p> + <a class="indexterm" name="id1478575"></a> +(Deprecated: Use <code class="computeroutput"><span class="identifier">get_service</span><span class="special">()</span></code>.) The service associated with the I/O + object. + </p> +<pre class="programlisting"><span class="identifier">service_type</span> <span class="special">&</span> <span class="identifier">service</span><span class="special">;</span> +</pre> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.service.h0"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.service.remarks"></a></span><a class="link" href="service.html#boost_asio.reference.posix__basic_stream_descriptor.service.remarks">Remarks</a> + </h6> +<p> + Available only for services that do not support movability. + </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="release.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_stream_descriptor.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="service_type.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/posix__basic_stream_descriptor/service_type.html b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/service_type.html new file mode 100755 index 0000000000..2c6f82e91e --- /dev/null +++ b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/service_type.html @@ -0,0 +1,63 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>posix::basic_stream_descriptor::service_type</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="../posix__basic_stream_descriptor.html" title="posix::basic_stream_descriptor"> +<link rel="prev" href="service.html" title="posix::basic_stream_descriptor::service"> +<link rel="next" href="write_some.html" title="posix::basic_stream_descriptor::write_some"> +</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="service.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_stream_descriptor.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="write_some.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.posix__basic_stream_descriptor.service_type"></a><a class="link" href="service_type.html" title="posix::basic_stream_descriptor::service_type">posix::basic_stream_descriptor::service_type</a> +</h4></div></div></div> +<p> + <span class="emphasis"><em>Inherited from basic_io_object.</em></span> + </p> +<p> + <a class="indexterm" name="id1478690"></a> +The type of the service that + will be used to provide I/O operations. + </p> +<pre class="programlisting"><span class="keyword">typedef</span> <span class="identifier">StreamDescriptorService</span> <span class="identifier">service_type</span><span class="special">;</span> +</pre> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.service_type.h0"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.service_type.requirements"></a></span><a class="link" href="service_type.html#boost_asio.reference.posix__basic_stream_descriptor.service_type.requirements">Requirements</a> + </h6> +<p> + <span class="bold"><strong>Header: </strong></span><code class="literal">boost/asio/posix/basic_stream_descriptor.hpp</code> + </p> +<p> + <span class="bold"><strong>Convenience header: </strong></span><code class="literal">boost/asio.hpp</code> + </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="service.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_stream_descriptor.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="write_some.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/posix__basic_stream_descriptor/write_some.html b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/write_some.html new file mode 100755 index 0000000000..db6fbe8594 --- /dev/null +++ b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/write_some.html @@ -0,0 +1,60 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>posix::basic_stream_descriptor::write_some</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="../posix__basic_stream_descriptor.html" title="posix::basic_stream_descriptor"> +<link rel="prev" href="service_type.html" title="posix::basic_stream_descriptor::service_type"> +<link rel="next" href="write_some/overload1.html" title="posix::basic_stream_descriptor::write_some (1 of 2 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="service_type.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_stream_descriptor.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="write_some/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.posix__basic_stream_descriptor.write_some"></a><a class="link" href="write_some.html" title="posix::basic_stream_descriptor::write_some">posix::basic_stream_descriptor::write_some</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id1478804"></a> +Write some data to the descriptor. + </p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> + <span class="keyword">typename</span> <a class="link" href="../ConstBufferSequence.html" title="Constant buffer sequence requirements">ConstBufferSequence</a><span class="special">></span> +<span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="write_some/overload1.html" title="posix::basic_stream_descriptor::write_some (1 of 2 overloads)">write_some</a><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">ConstBufferSequence</span> <span class="special">&</span> <span class="identifier">buffers</span><span class="special">);</span> + <span class="emphasis"><em>» <a class="link" href="write_some/overload1.html" title="posix::basic_stream_descriptor::write_some (1 of 2 overloads)">more...</a></em></span> + +<span class="keyword">template</span><span class="special"><</span> + <span class="keyword">typename</span> <a class="link" href="../ConstBufferSequence.html" title="Constant buffer sequence requirements">ConstBufferSequence</a><span class="special">></span> +<span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="write_some/overload2.html" title="posix::basic_stream_descriptor::write_some (2 of 2 overloads)">write_some</a><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">ConstBufferSequence</span> <span class="special">&</span> <span class="identifier">buffers</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> + <span class="emphasis"><em>» <a class="link" href="write_some/overload2.html" title="posix::basic_stream_descriptor::write_some (2 of 2 overloads)">more...</a></em></span> +</pre> +</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="service_type.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_stream_descriptor.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="write_some/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/posix__basic_stream_descriptor/write_some/overload1.html b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/write_some/overload1.html new file mode 100755 index 0000000000..4510538055 --- /dev/null +++ b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/write_some/overload1.html @@ -0,0 +1,115 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>posix::basic_stream_descriptor::write_some (1 of 2 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="../write_some.html" title="posix::basic_stream_descriptor::write_some"> +<link rel="prev" href="../write_some.html" title="posix::basic_stream_descriptor::write_some"> +<link rel="next" href="overload2.html" title="posix::basic_stream_descriptor::write_some (2 of 2 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="../write_some.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../write_some.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_stream_descriptor.write_some.overload1"></a><a class="link" href="overload1.html" title="posix::basic_stream_descriptor::write_some (1 of 2 overloads)">posix::basic_stream_descriptor::write_some + (1 of 2 overloads)</a> +</h5></div></div></div> +<p> + Write some data to the descriptor. + </p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> + <span class="keyword">typename</span> <a class="link" href="../../ConstBufferSequence.html" title="Constant buffer sequence requirements">ConstBufferSequence</a><span class="special">></span> +<span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">write_some</span><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">ConstBufferSequence</span> <span class="special">&</span> <span class="identifier">buffers</span><span class="special">);</span> +</pre> +<p> + This function is used to write data to the stream descriptor. The function + call will block until one or more bytes of the data has been written + successfully, or until an error occurs. + </p> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.write_some.overload1.h0"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.write_some.overload1.parameters"></a></span><a class="link" href="overload1.html#boost_asio.reference.posix__basic_stream_descriptor.write_some.overload1.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">buffers</span></dt> +<dd><p> + One or more data buffers to be written to the descriptor. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.write_some.overload1.h1"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.write_some.overload1.return_value"></a></span><a class="link" href="overload1.html#boost_asio.reference.posix__basic_stream_descriptor.write_some.overload1.return_value">Return + Value</a> + </h6> +<p> + The number of bytes written. + </p> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.write_some.overload1.h2"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.write_some.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.posix__basic_stream_descriptor.write_some.overload1.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. An error code of <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">eof</span></code> + indicates that the connection was closed by the peer. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.write_some.overload1.h3"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.write_some.overload1.remarks"></a></span><a class="link" href="overload1.html#boost_asio.reference.posix__basic_stream_descriptor.write_some.overload1.remarks">Remarks</a> + </h6> +<p> + The write_some operation may not transmit all of the data to the peer. + Consider using the <a class="link" href="../../write.html" title="write"><code class="computeroutput"><span class="identifier">write</span></code></a> function if you need to + ensure that all data is written before the blocking operation completes. + </p> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.write_some.overload1.h4"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.write_some.overload1.example"></a></span><a class="link" href="overload1.html#boost_asio.reference.posix__basic_stream_descriptor.write_some.overload1.example">Example</a> + </h6> +<p> + To write a single data buffer use the <a class="link" href="../../buffer.html" title="buffer"><code class="computeroutput"><span class="identifier">buffer</span></code></a> function as follows: + </p> +<pre class="programlisting"><span class="identifier">descriptor</span><span class="special">.</span><span class="identifier">write_some</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">buffer</span><span class="special">(</span><span class="identifier">data</span><span class="special">,</span> <span class="identifier">size</span><span class="special">));</span> +</pre> +<p> + See the <a class="link" href="../../buffer.html" title="buffer"><code class="computeroutput"><span class="identifier">buffer</span></code></a> + documentation for information on writing multiple buffers in one go, + and how to use it with arrays, boost::array or std::vector. + </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="../write_some.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../write_some.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_stream_descriptor/write_some/overload2.html b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/write_some/overload2.html new file mode 100755 index 0000000000..76154394db --- /dev/null +++ b/doc/html/boost_asio/reference/posix__basic_stream_descriptor/write_some/overload2.html @@ -0,0 +1,92 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>posix::basic_stream_descriptor::write_some (2 of 2 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="../write_some.html" title="posix::basic_stream_descriptor::write_some"> +<link rel="prev" href="overload1.html" title="posix::basic_stream_descriptor::write_some (1 of 2 overloads)"> +<link rel="next" href="../../posix__descriptor_base.html" title="posix::descriptor_base"> +</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="../write_some.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="../../posix__descriptor_base.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_stream_descriptor.write_some.overload2"></a><a class="link" href="overload2.html" title="posix::basic_stream_descriptor::write_some (2 of 2 overloads)">posix::basic_stream_descriptor::write_some + (2 of 2 overloads)</a> +</h5></div></div></div> +<p> + Write some data to the descriptor. + </p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> + <span class="keyword">typename</span> <a class="link" href="../../ConstBufferSequence.html" title="Constant buffer sequence requirements">ConstBufferSequence</a><span class="special">></span> +<span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">write_some</span><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">ConstBufferSequence</span> <span class="special">&</span> <span class="identifier">buffers</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 write data to the stream descriptor. The function + call will block until one or more bytes of the data has been written + successfully, or until an error occurs. + </p> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.write_some.overload2.h0"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.write_some.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.posix__basic_stream_descriptor.write_some.overload2.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl> +<dt><span class="term">buffers</span></dt> +<dd><p> + One or more data buffers to be written to the descriptor. + </p></dd> +<dt><span class="term">ec</span></dt> +<dd><p> + Set to indicate what error occurred, if any. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.write_some.overload2.h1"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.write_some.overload2.return_value"></a></span><a class="link" href="overload2.html#boost_asio.reference.posix__basic_stream_descriptor.write_some.overload2.return_value">Return + Value</a> + </h6> +<p> + The number of bytes written. Returns 0 if an error occurred. + </p> +<h6> +<a name="boost_asio.reference.posix__basic_stream_descriptor.write_some.overload2.h2"></a> + <span><a name="boost_asio.reference.posix__basic_stream_descriptor.write_some.overload2.remarks"></a></span><a class="link" href="overload2.html#boost_asio.reference.posix__basic_stream_descriptor.write_some.overload2.remarks">Remarks</a> + </h6> +<p> + The write_some operation may not transmit all of the data to the peer. + Consider using the <a class="link" href="../../write.html" title="write"><code class="computeroutput"><span class="identifier">write</span></code></a> function if you need to + ensure that all data is written before the blocking operation completes. + </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="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../write_some.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="../../posix__descriptor_base.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> |