Adds asio library and Storage Module

This commit is contained in:
Suraxius committed 2020-12-01 22:41:04 +01:00
1 parent 79a6ee5779
commit 30439acd43
4869 files changed
+618801 -903

No files matched your search

@@ -0,0 +1,48 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>posix::basic_descriptor::~basic_descriptor</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../index.html" title="Asio">
<link rel="up" href="../posix__basic_descriptor.html" title="posix::basic_descriptor">
<link rel="prev" href="wait_type.html" title="posix::basic_descriptor::wait_type">
<link rel="next" href="../posix__basic_descriptor__rebind_executor.html" title="posix::basic_descriptor::rebind_executor">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="wait_type.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_descriptor.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="../posix__basic_descriptor__rebind_executor.html"><img src="../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="asio.reference.posix__basic_descriptor._basic_descriptor"></a><a class="link" href="_basic_descriptor.html" title="posix::basic_descriptor::~basic_descriptor">posix::basic_descriptor::~basic_descriptor</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.posix__basic_descriptor._basic_descriptor"></a>
Protected
destructor to prevent deletion through this type.
</p>
<pre class="programlisting">~basic_descriptor();
</pre>
<p>
This function destroys the descriptor, cancelling any outstanding asynchronous
wait operations associated with the descriptor as if by calling <code class="computeroutput">cancel</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-2020 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="wait_type.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_descriptor.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="../posix__basic_descriptor__rebind_executor.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,51 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>posix::basic_descriptor::assign</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../index.html" title="Asio">
<link rel="up" href="../posix__basic_descriptor.html" title="posix::basic_descriptor">
<link rel="prev" href="../posix__basic_descriptor.html" title="posix::basic_descriptor">
<link rel="next" href="assign/overload1.html" title="posix::basic_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="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../posix__basic_descriptor.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_descriptor.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="assign/overload1.html"><img src="../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="asio.reference.posix__basic_descriptor.assign"></a><a class="link" href="assign.html" title="posix::basic_descriptor::assign">posix::basic_descriptor::assign</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.posix__basic_descriptor.assign"></a>
Assign
an existing native descriptor to the descriptor.
</p>
<pre class="programlisting">void <a class="link" href="assign/overload1.html" title="posix::basic_descriptor::assign (1 of 2 overloads)">assign</a>(
const native_handle_type &amp; native_descriptor);
<span class="emphasis"><em>» <a class="link" href="assign/overload1.html" title="posix::basic_descriptor::assign (1 of 2 overloads)">more...</a></em></span>
void <a class="link" href="assign/overload2.html" title="posix::basic_descriptor::assign (2 of 2 overloads)">assign</a>(
const native_handle_type &amp; native_descriptor,
asio::error_code &amp; ec);
<span class="emphasis"><em>» <a class="link" href="assign/overload2.html" title="posix::basic_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-2020 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_descriptor.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_descriptor.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="assign/overload1.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,44 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>posix::basic_descriptor::assign (1 of 2 overloads)</title>
<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../../index.html" title="Asio">
<link rel="up" href="../assign.html" title="posix::basic_descriptor::assign">
<link rel="prev" href="../assign.html" title="posix::basic_descriptor::assign">
<link rel="next" href="overload2.html" title="posix::basic_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="asio C++ library" width="250" height="60" src="../../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../assign.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../assign.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.posix__basic_descriptor.assign.overload1"></a><a class="link" href="overload1.html" title="posix::basic_descriptor::assign (1 of 2 overloads)">posix::basic_descriptor::assign
(1 of 2 overloads)</a>
</h5></div></div></div>
<p>
Assign an existing native descriptor to the descriptor.
</p>
<pre class="programlisting">void assign(
const native_handle_type &amp; native_descriptor);
</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-2020 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="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../assign.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,45 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>posix::basic_descriptor::assign (2 of 2 overloads)</title>
<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../../index.html" title="Asio">
<link rel="up" href="../assign.html" title="posix::basic_descriptor::assign">
<link rel="prev" href="overload1.html" title="posix::basic_descriptor::assign (1 of 2 overloads)">
<link rel="next" href="../async_wait.html" title="posix::basic_descriptor::async_wait">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="overload1.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../assign.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="../async_wait.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.posix__basic_descriptor.assign.overload2"></a><a class="link" href="overload2.html" title="posix::basic_descriptor::assign (2 of 2 overloads)">posix::basic_descriptor::assign
(2 of 2 overloads)</a>
</h5></div></div></div>
<p>
Assign an existing native descriptor to the descriptor.
</p>
<pre class="programlisting">void assign(
const native_handle_type &amp; native_descriptor,
asio::error_code &amp; ec);
</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-2020 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="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../assign.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="../async_wait.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,104 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>posix::basic_descriptor::async_wait</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../index.html" title="Asio">
<link rel="up" href="../posix__basic_descriptor.html" title="posix::basic_descriptor">
<link rel="prev" href="assign/overload2.html" title="posix::basic_descriptor::assign (2 of 2 overloads)">
<link rel="next" href="basic_descriptor.html" title="posix::basic_descriptor::basic_descriptor">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="assign/overload2.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_descriptor.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="basic_descriptor.html"><img src="../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="asio.reference.posix__basic_descriptor.async_wait"></a><a class="link" href="async_wait.html" title="posix::basic_descriptor::async_wait">posix::basic_descriptor::async_wait</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.posix__basic_descriptor.async_wait"></a>
Asynchronously
wait for the descriptor to become ready to read, ready to write, or to
have pending error conditions.
</p>
<pre class="programlisting">template&lt;
typename <a class="link" href="../WaitHandler.html" title="Wait handler requirements">WaitHandler</a> = <a class="link" href="../asynchronous_operations.html#asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>&gt;
<a class="link" href="../asynchronous_operations.html#asio.reference.asynchronous_operations.automatic_deduction_of_initiating_function_return_type"><span class="emphasis"><em>DEDUCED</em></span></a> async_wait(
wait_type w,
WaitHandler &amp;&amp; handler = <a class="link" href="../asynchronous_operations.html#asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>);
</pre>
<p>
This function is used to perform an asynchronous wait for a descriptor
to enter a ready to read, write or error condition state.
</p>
<h6>
<a name="asio.reference.posix__basic_descriptor.async_wait.h0"></a>
<span><a name="asio.reference.posix__basic_descriptor.async_wait.parameters"></a></span><a class="link" href="async_wait.html#asio.reference.posix__basic_descriptor.async_wait.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">w</span></dt>
<dd><p>
Specifies the desired descriptor state.
</p></dd>
<dt><span class="term">handler</span></dt>
<dd>
<p>
The handler to be called when the wait operation completes. Copies
will be made of the handler as required. The function signature of
the handler must be:
</p>
<pre class="programlisting">void handler(
const asio::error_code&amp; error // Result of operation
);
</pre>
<p>
Regardless of whether the asynchronous operation completes immediately
or not, the handler will not be invoked from within this function.
On immediate completion, invocation of the handler will be performed
in a manner equivalent to using <a class="link" href="../post.html" title="post"><code class="computeroutput">post</code></a>.
</p>
</dd>
</dl>
</div>
<h6>
<a name="asio.reference.posix__basic_descriptor.async_wait.h1"></a>
<span><a name="asio.reference.posix__basic_descriptor.async_wait.example"></a></span><a class="link" href="async_wait.html#asio.reference.posix__basic_descriptor.async_wait.example">Example</a>
</h6>
<pre class="programlisting">void wait_handler(const asio::error_code&amp; error)
{
if (!error)
{
// Wait succeeded.
}
}
...
asio::posix::stream_descriptor descriptor(my_context);
...
descriptor.async_wait(
asio::posix::stream_descriptor::wait_read,
wait_handler);
</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-2020 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="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_descriptor.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="basic_descriptor.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,76 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>posix::basic_descriptor::basic_descriptor</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../index.html" title="Asio">
<link rel="up" href="../posix__basic_descriptor.html" title="posix::basic_descriptor">
<link rel="prev" href="async_wait.html" title="posix::basic_descriptor::async_wait">
<link rel="next" href="basic_descriptor/overload1.html" title="posix::basic_descriptor::basic_descriptor (1 of 5 overloads)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="async_wait.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_descriptor.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="basic_descriptor/overload1.html"><img src="../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="asio.reference.posix__basic_descriptor.basic_descriptor"></a><a class="link" href="basic_descriptor.html" title="posix::basic_descriptor::basic_descriptor">posix::basic_descriptor::basic_descriptor</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.posix__basic_descriptor.basic_descriptor"></a>
Construct
a descriptor without opening it.
</p>
<pre class="programlisting">explicit <a class="link" href="basic_descriptor/overload1.html" title="posix::basic_descriptor::basic_descriptor (1 of 5 overloads)">basic_descriptor</a>(
const executor_type &amp; ex);
<span class="emphasis"><em>» <a class="link" href="basic_descriptor/overload1.html" title="posix::basic_descriptor::basic_descriptor (1 of 5 overloads)">more...</a></em></span>
template&lt;
typename ExecutionContext&gt;
explicit <a class="link" href="basic_descriptor/overload2.html" title="posix::basic_descriptor::basic_descriptor (2 of 5 overloads)">basic_descriptor</a>(
ExecutionContext &amp; context,
typename enable_if&lt; is_convertible&lt; ExecutionContext &amp;, execution_context &amp; &gt;::value &gt;::type * = 0);
<span class="emphasis"><em>» <a class="link" href="basic_descriptor/overload2.html" title="posix::basic_descriptor::basic_descriptor (2 of 5 overloads)">more...</a></em></span>
</pre>
<p>
Construct a descriptor on an existing native descriptor.
</p>
<pre class="programlisting"><a class="link" href="basic_descriptor/overload3.html" title="posix::basic_descriptor::basic_descriptor (3 of 5 overloads)">basic_descriptor</a>(
const executor_type &amp; ex,
const native_handle_type &amp; native_descriptor);
<span class="emphasis"><em>» <a class="link" href="basic_descriptor/overload3.html" title="posix::basic_descriptor::basic_descriptor (3 of 5 overloads)">more...</a></em></span>
template&lt;
typename ExecutionContext&gt;
<a class="link" href="basic_descriptor/overload4.html" title="posix::basic_descriptor::basic_descriptor (4 of 5 overloads)">basic_descriptor</a>(
ExecutionContext &amp; context,
const native_handle_type &amp; native_descriptor,
typename enable_if&lt; is_convertible&lt; ExecutionContext &amp;, execution_context &amp; &gt;::value &gt;::type * = 0);
<span class="emphasis"><em>» <a class="link" href="basic_descriptor/overload4.html" title="posix::basic_descriptor::basic_descriptor (4 of 5 overloads)">more...</a></em></span>
</pre>
<p>
Move-construct a descriptor from another.
</p>
<pre class="programlisting"><a class="link" href="basic_descriptor/overload5.html" title="posix::basic_descriptor::basic_descriptor (5 of 5 overloads)">basic_descriptor</a>(
basic_descriptor &amp;&amp; other);
<span class="emphasis"><em>» <a class="link" href="basic_descriptor/overload5.html" title="posix::basic_descriptor::basic_descriptor (5 of 5 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-2020 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_wait.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_descriptor.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="basic_descriptor/overload1.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,61 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>posix::basic_descriptor::basic_descriptor (1 of 5 overloads)</title>
<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../../index.html" title="Asio">
<link rel="up" href="../basic_descriptor.html" title="posix::basic_descriptor::basic_descriptor">
<link rel="prev" href="../basic_descriptor.html" title="posix::basic_descriptor::basic_descriptor">
<link rel="next" href="overload2.html" title="posix::basic_descriptor::basic_descriptor (2 of 5 overloads)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../basic_descriptor.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_descriptor.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.posix__basic_descriptor.basic_descriptor.overload1"></a><a class="link" href="overload1.html" title="posix::basic_descriptor::basic_descriptor (1 of 5 overloads)">posix::basic_descriptor::basic_descriptor
(1 of 5 overloads)</a>
</h5></div></div></div>
<p>
Construct a descriptor without opening it.
</p>
<pre class="programlisting">basic_descriptor(
const executor_type &amp; ex);
</pre>
<p>
This constructor creates a descriptor without opening it.
</p>
<h6>
<a name="asio.reference.posix__basic_descriptor.basic_descriptor.overload1.h0"></a>
<span><a name="asio.reference.posix__basic_descriptor.basic_descriptor.overload1.parameters"></a></span><a class="link" href="overload1.html#asio.reference.posix__basic_descriptor.basic_descriptor.overload1.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">ex</span></dt>
<dd><p>
The I/O executor that the descriptor will use, by default, 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-2020 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_descriptor.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_descriptor.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,65 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>posix::basic_descriptor::basic_descriptor (2 of 5 overloads)</title>
<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../../index.html" title="Asio">
<link rel="up" href="../basic_descriptor.html" title="posix::basic_descriptor::basic_descriptor">
<link rel="prev" href="overload1.html" title="posix::basic_descriptor::basic_descriptor (1 of 5 overloads)">
<link rel="next" href="overload3.html" title="posix::basic_descriptor::basic_descriptor (3 of 5 overloads)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="overload1.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_descriptor.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="overload3.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.posix__basic_descriptor.basic_descriptor.overload2"></a><a class="link" href="overload2.html" title="posix::basic_descriptor::basic_descriptor (2 of 5 overloads)">posix::basic_descriptor::basic_descriptor
(2 of 5 overloads)</a>
</h5></div></div></div>
<p>
Construct a descriptor without opening it.
</p>
<pre class="programlisting">template&lt;
typename ExecutionContext&gt;
basic_descriptor(
ExecutionContext &amp; context,
typename enable_if&lt; is_convertible&lt; ExecutionContext &amp;, execution_context &amp; &gt;::value &gt;::type * = 0);
</pre>
<p>
This constructor creates a descriptor without opening it.
</p>
<h6>
<a name="asio.reference.posix__basic_descriptor.basic_descriptor.overload2.h0"></a>
<span><a name="asio.reference.posix__basic_descriptor.basic_descriptor.overload2.parameters"></a></span><a class="link" href="overload2.html#asio.reference.posix__basic_descriptor.basic_descriptor.overload2.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">context</span></dt>
<dd><p>
An execution context which provides the I/O executor that the descriptor
will use, by default, 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-2020 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="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_descriptor.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="overload3.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,80 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>posix::basic_descriptor::basic_descriptor (3 of 5 overloads)</title>
<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../../index.html" title="Asio">
<link rel="up" href="../basic_descriptor.html" title="posix::basic_descriptor::basic_descriptor">
<link rel="prev" href="overload2.html" title="posix::basic_descriptor::basic_descriptor (2 of 5 overloads)">
<link rel="next" href="overload4.html" title="posix::basic_descriptor::basic_descriptor (4 of 5 overloads)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="overload2.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_descriptor.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="overload4.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.posix__basic_descriptor.basic_descriptor.overload3"></a><a class="link" href="overload3.html" title="posix::basic_descriptor::basic_descriptor (3 of 5 overloads)">posix::basic_descriptor::basic_descriptor
(3 of 5 overloads)</a>
</h5></div></div></div>
<p>
Construct a descriptor on an existing native descriptor.
</p>
<pre class="programlisting">basic_descriptor(
const executor_type &amp; ex,
const native_handle_type &amp; native_descriptor);
</pre>
<p>
This constructor creates a descriptor object to hold an existing native
descriptor.
</p>
<h6>
<a name="asio.reference.posix__basic_descriptor.basic_descriptor.overload3.h0"></a>
<span><a name="asio.reference.posix__basic_descriptor.basic_descriptor.overload3.parameters"></a></span><a class="link" href="overload3.html#asio.reference.posix__basic_descriptor.basic_descriptor.overload3.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">ex</span></dt>
<dd><p>
The I/O executor that the descriptor will use, by default, to dispatch
handlers for any asynchronous operations performed on the descriptor.
</p></dd>
<dt><span class="term">native_descriptor</span></dt>
<dd><p>
A native descriptor.
</p></dd>
</dl>
</div>
<h6>
<a name="asio.reference.posix__basic_descriptor.basic_descriptor.overload3.h1"></a>
<span><a name="asio.reference.posix__basic_descriptor.basic_descriptor.overload3.exceptions"></a></span><a class="link" href="overload3.html#asio.reference.posix__basic_descriptor.basic_descriptor.overload3.exceptions">Exceptions</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">asio::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-2020 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="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_descriptor.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="overload4.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,84 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>posix::basic_descriptor::basic_descriptor (4 of 5 overloads)</title>
<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../../index.html" title="Asio">
<link rel="up" href="../basic_descriptor.html" title="posix::basic_descriptor::basic_descriptor">
<link rel="prev" href="overload3.html" title="posix::basic_descriptor::basic_descriptor (3 of 5 overloads)">
<link rel="next" href="overload5.html" title="posix::basic_descriptor::basic_descriptor (5 of 5 overloads)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="overload3.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_descriptor.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="overload5.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.posix__basic_descriptor.basic_descriptor.overload4"></a><a class="link" href="overload4.html" title="posix::basic_descriptor::basic_descriptor (4 of 5 overloads)">posix::basic_descriptor::basic_descriptor
(4 of 5 overloads)</a>
</h5></div></div></div>
<p>
Construct a descriptor on an existing native descriptor.
</p>
<pre class="programlisting">template&lt;
typename ExecutionContext&gt;
basic_descriptor(
ExecutionContext &amp; context,
const native_handle_type &amp; native_descriptor,
typename enable_if&lt; is_convertible&lt; ExecutionContext &amp;, execution_context &amp; &gt;::value &gt;::type * = 0);
</pre>
<p>
This constructor creates a descriptor object to hold an existing native
descriptor.
</p>
<h6>
<a name="asio.reference.posix__basic_descriptor.basic_descriptor.overload4.h0"></a>
<span><a name="asio.reference.posix__basic_descriptor.basic_descriptor.overload4.parameters"></a></span><a class="link" href="overload4.html#asio.reference.posix__basic_descriptor.basic_descriptor.overload4.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">context</span></dt>
<dd><p>
An execution context which provides the I/O executor that the descriptor
will use, by default, to dispatch handlers for any asynchronous
operations performed on the descriptor.
</p></dd>
<dt><span class="term">native_descriptor</span></dt>
<dd><p>
A native descriptor.
</p></dd>
</dl>
</div>
<h6>
<a name="asio.reference.posix__basic_descriptor.basic_descriptor.overload4.h1"></a>
<span><a name="asio.reference.posix__basic_descriptor.basic_descriptor.overload4.exceptions"></a></span><a class="link" href="overload4.html#asio.reference.posix__basic_descriptor.basic_descriptor.overload4.exceptions">Exceptions</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">asio::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-2020 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="overload3.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_descriptor.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="overload5.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,69 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>posix::basic_descriptor::basic_descriptor (5 of 5 overloads)</title>
<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../../index.html" title="Asio">
<link rel="up" href="../basic_descriptor.html" title="posix::basic_descriptor::basic_descriptor">
<link rel="prev" href="overload4.html" title="posix::basic_descriptor::basic_descriptor (4 of 5 overloads)">
<link rel="next" href="../bytes_readable.html" title="posix::basic_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="asio C++ library" width="250" height="60" src="../../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="overload4.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_descriptor.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="../bytes_readable.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.posix__basic_descriptor.basic_descriptor.overload5"></a><a class="link" href="overload5.html" title="posix::basic_descriptor::basic_descriptor (5 of 5 overloads)">posix::basic_descriptor::basic_descriptor
(5 of 5 overloads)</a>
</h5></div></div></div>
<p>
Move-construct a descriptor from another.
</p>
<pre class="programlisting">basic_descriptor(
basic_descriptor &amp;&amp; other);
</pre>
<p>
This constructor moves a descriptor from one object to another.
</p>
<h6>
<a name="asio.reference.posix__basic_descriptor.basic_descriptor.overload5.h0"></a>
<span><a name="asio.reference.posix__basic_descriptor.basic_descriptor.overload5.parameters"></a></span><a class="link" href="overload5.html#asio.reference.posix__basic_descriptor.basic_descriptor.overload5.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 descriptor object from which the move will occur.
</p></dd>
</dl>
</div>
<h6>
<a name="asio.reference.posix__basic_descriptor.basic_descriptor.overload5.h1"></a>
<span><a name="asio.reference.posix__basic_descriptor.basic_descriptor.overload5.remarks"></a></span><a class="link" href="overload5.html#asio.reference.posix__basic_descriptor.basic_descriptor.overload5.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">basic_descriptor(const executor_type&amp;)</code>
constructor.
</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-2020 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="overload4.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_descriptor.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="../bytes_readable.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,70 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>posix::basic_descriptor::bytes_readable</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../index.html" title="Asio">
<link rel="up" href="../posix__basic_descriptor.html" title="posix::basic_descriptor">
<link rel="prev" href="basic_descriptor/overload5.html" title="posix::basic_descriptor::basic_descriptor (5 of 5 overloads)">
<link rel="next" href="cancel.html" title="posix::basic_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="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="basic_descriptor/overload5.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_descriptor.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="cancel.html"><img src="../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="asio.reference.posix__basic_descriptor.bytes_readable"></a><a class="link" href="bytes_readable.html" title="posix::basic_descriptor::bytes_readable">posix::basic_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="asio.indexterm.posix__basic_descriptor.bytes_readable"></a>
IO
control command to get the amount of data that can be read without blocking.
</p>
<pre class="programlisting">typedef implementation_defined bytes_readable;
</pre>
<p>
Implements the FIONREAD IO control command.
</p>
<h6>
<a name="asio.reference.posix__basic_descriptor.bytes_readable.h0"></a>
<span><a name="asio.reference.posix__basic_descriptor.bytes_readable.example"></a></span><a class="link" href="bytes_readable.html#asio.reference.posix__basic_descriptor.bytes_readable.example">Example</a>
</h6>
<pre class="programlisting">asio::posix::stream_descriptor descriptor(my_context);
...
asio::descriptor_base::bytes_readable command(true);
descriptor.io_control(command);
std::size_t bytes_readable = command.get();
</pre>
<h6>
<a name="asio.reference.posix__basic_descriptor.bytes_readable.h1"></a>
<span><a name="asio.reference.posix__basic_descriptor.bytes_readable.requirements"></a></span><a class="link" href="bytes_readable.html#asio.reference.posix__basic_descriptor.bytes_readable.requirements">Requirements</a>
</h6>
<p>
<span class="emphasis"><em>Header: </em></span><code class="literal">asio/posix/basic_descriptor.hpp</code>
</p>
<p>
<span class="emphasis"><em>Convenience header: </em></span><code class="literal">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-2020 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_descriptor/overload5.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_descriptor.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="cancel.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,49 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>posix::basic_descriptor::cancel</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../index.html" title="Asio">
<link rel="up" href="../posix__basic_descriptor.html" title="posix::basic_descriptor">
<link rel="prev" href="bytes_readable.html" title="posix::basic_descriptor::bytes_readable">
<link rel="next" href="cancel/overload1.html" title="posix::basic_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="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="bytes_readable.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_descriptor.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="cancel/overload1.html"><img src="../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="asio.reference.posix__basic_descriptor.cancel"></a><a class="link" href="cancel.html" title="posix::basic_descriptor::cancel">posix::basic_descriptor::cancel</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.posix__basic_descriptor.cancel"></a>
Cancel
all asynchronous operations associated with the descriptor.
</p>
<pre class="programlisting">void <a class="link" href="cancel/overload1.html" title="posix::basic_descriptor::cancel (1 of 2 overloads)">cancel</a>();
<span class="emphasis"><em>» <a class="link" href="cancel/overload1.html" title="posix::basic_descriptor::cancel (1 of 2 overloads)">more...</a></em></span>
void <a class="link" href="cancel/overload2.html" title="posix::basic_descriptor::cancel (2 of 2 overloads)">cancel</a>(
asio::error_code &amp; ec);
<span class="emphasis"><em>» <a class="link" href="cancel/overload2.html" title="posix::basic_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-2020 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="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_descriptor.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="cancel/overload1.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,61 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>posix::basic_descriptor::cancel (1 of 2 overloads)</title>
<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../../index.html" title="Asio">
<link rel="up" href="../cancel.html" title="posix::basic_descriptor::cancel">
<link rel="prev" href="../cancel.html" title="posix::basic_descriptor::cancel">
<link rel="next" href="overload2.html" title="posix::basic_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="asio C++ library" width="250" height="60" src="../../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../cancel.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../cancel.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.posix__basic_descriptor.cancel.overload1"></a><a class="link" href="overload1.html" title="posix::basic_descriptor::cancel (1 of 2 overloads)">posix::basic_descriptor::cancel
(1 of 2 overloads)</a>
</h5></div></div></div>
<p>
Cancel all asynchronous operations associated with the descriptor.
</p>
<pre class="programlisting">void cancel();
</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">asio::error::operation_aborted</code> error.
</p>
<h6>
<a name="asio.reference.posix__basic_descriptor.cancel.overload1.h0"></a>
<span><a name="asio.reference.posix__basic_descriptor.cancel.overload1.exceptions"></a></span><a class="link" href="overload1.html#asio.reference.posix__basic_descriptor.cancel.overload1.exceptions">Exceptions</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">asio::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-2020 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="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../cancel.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,62 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>posix::basic_descriptor::cancel (2 of 2 overloads)</title>
<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../../index.html" title="Asio">
<link rel="up" href="../cancel.html" title="posix::basic_descriptor::cancel">
<link rel="prev" href="overload1.html" title="posix::basic_descriptor::cancel (1 of 2 overloads)">
<link rel="next" href="../close.html" title="posix::basic_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="asio C++ library" width="250" height="60" src="../../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="overload1.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../cancel.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="../close.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.posix__basic_descriptor.cancel.overload2"></a><a class="link" href="overload2.html" title="posix::basic_descriptor::cancel (2 of 2 overloads)">posix::basic_descriptor::cancel
(2 of 2 overloads)</a>
</h5></div></div></div>
<p>
Cancel all asynchronous operations associated with the descriptor.
</p>
<pre class="programlisting">void cancel(
asio::error_code &amp; ec);
</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">asio::error::operation_aborted</code> error.
</p>
<h6>
<a name="asio.reference.posix__basic_descriptor.cancel.overload2.h0"></a>
<span><a name="asio.reference.posix__basic_descriptor.cancel.overload2.parameters"></a></span><a class="link" href="overload2.html#asio.reference.posix__basic_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-2020 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="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../cancel.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="../close.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,49 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>posix::basic_descriptor::close</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../index.html" title="Asio">
<link rel="up" href="../posix__basic_descriptor.html" title="posix::basic_descriptor">
<link rel="prev" href="cancel/overload2.html" title="posix::basic_descriptor::cancel (2 of 2 overloads)">
<link rel="next" href="close/overload1.html" title="posix::basic_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="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="cancel/overload2.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_descriptor.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="close/overload1.html"><img src="../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="asio.reference.posix__basic_descriptor.close"></a><a class="link" href="close.html" title="posix::basic_descriptor::close">posix::basic_descriptor::close</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.posix__basic_descriptor.close"></a>
Close
the descriptor.
</p>
<pre class="programlisting">void <a class="link" href="close/overload1.html" title="posix::basic_descriptor::close (1 of 2 overloads)">close</a>();
<span class="emphasis"><em>» <a class="link" href="close/overload1.html" title="posix::basic_descriptor::close (1 of 2 overloads)">more...</a></em></span>
void <a class="link" href="close/overload2.html" title="posix::basic_descriptor::close (2 of 2 overloads)">close</a>(
asio::error_code &amp; ec);
<span class="emphasis"><em>» <a class="link" href="close/overload2.html" title="posix::basic_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-2020 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="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_descriptor.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="close/overload1.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,62 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>posix::basic_descriptor::close (1 of 2 overloads)</title>
<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../../index.html" title="Asio">
<link rel="up" href="../close.html" title="posix::basic_descriptor::close">
<link rel="prev" href="../close.html" title="posix::basic_descriptor::close">
<link rel="next" href="overload2.html" title="posix::basic_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="asio C++ library" width="250" height="60" src="../../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../close.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../close.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.posix__basic_descriptor.close.overload1"></a><a class="link" href="overload1.html" title="posix::basic_descriptor::close (1 of 2 overloads)">posix::basic_descriptor::close
(1 of 2 overloads)</a>
</h5></div></div></div>
<p>
Close the descriptor.
</p>
<pre class="programlisting">void close();
</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">asio::error::operation_aborted</code> error.
</p>
<h6>
<a name="asio.reference.posix__basic_descriptor.close.overload1.h0"></a>
<span><a name="asio.reference.posix__basic_descriptor.close.overload1.exceptions"></a></span><a class="link" href="overload1.html#asio.reference.posix__basic_descriptor.close.overload1.exceptions">Exceptions</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">asio::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-2020 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="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../close.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,63 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>posix::basic_descriptor::close (2 of 2 overloads)</title>
<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../../index.html" title="Asio">
<link rel="up" href="../close.html" title="posix::basic_descriptor::close">
<link rel="prev" href="overload1.html" title="posix::basic_descriptor::close (1 of 2 overloads)">
<link rel="next" href="../executor_type.html" title="posix::basic_descriptor::executor_type">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="overload1.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../close.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="../executor_type.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.posix__basic_descriptor.close.overload2"></a><a class="link" href="overload2.html" title="posix::basic_descriptor::close (2 of 2 overloads)">posix::basic_descriptor::close
(2 of 2 overloads)</a>
</h5></div></div></div>
<p>
Close the descriptor.
</p>
<pre class="programlisting">void close(
asio::error_code &amp; ec);
</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">asio::error::operation_aborted</code> error.
</p>
<h6>
<a name="asio.reference.posix__basic_descriptor.close.overload2.h0"></a>
<span><a name="asio.reference.posix__basic_descriptor.close.overload2.parameters"></a></span><a class="link" href="overload2.html#asio.reference.posix__basic_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-2020 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="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../close.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="../executor_type.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,54 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>posix::basic_descriptor::executor_type</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../index.html" title="Asio">
<link rel="up" href="../posix__basic_descriptor.html" title="posix::basic_descriptor">
<link rel="prev" href="close/overload2.html" title="posix::basic_descriptor::close (2 of 2 overloads)">
<link rel="next" href="get_executor.html" title="posix::basic_descriptor::get_executor">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="close/overload2.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_descriptor.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="get_executor.html"><img src="../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="asio.reference.posix__basic_descriptor.executor_type"></a><a class="link" href="executor_type.html" title="posix::basic_descriptor::executor_type">posix::basic_descriptor::executor_type</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.posix__basic_descriptor.executor_type"></a>
The
type of the executor associated with the object.
</p>
<pre class="programlisting">typedef Executor executor_type;
</pre>
<h6>
<a name="asio.reference.posix__basic_descriptor.executor_type.h0"></a>
<span><a name="asio.reference.posix__basic_descriptor.executor_type.requirements"></a></span><a class="link" href="executor_type.html#asio.reference.posix__basic_descriptor.executor_type.requirements">Requirements</a>
</h6>
<p>
<span class="emphasis"><em>Header: </em></span><code class="literal">asio/posix/basic_descriptor.hpp</code>
</p>
<p>
<span class="emphasis"><em>Convenience header: </em></span><code class="literal">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-2020 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="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_descriptor.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="get_executor.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,44 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>posix::basic_descriptor::get_executor</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../index.html" title="Asio">
<link rel="up" href="../posix__basic_descriptor.html" title="posix::basic_descriptor">
<link rel="prev" href="executor_type.html" title="posix::basic_descriptor::executor_type">
<link rel="next" href="io_control.html" title="posix::basic_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="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="executor_type.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_descriptor.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="io_control.html"><img src="../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="asio.reference.posix__basic_descriptor.get_executor"></a><a class="link" href="get_executor.html" title="posix::basic_descriptor::get_executor">posix::basic_descriptor::get_executor</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.posix__basic_descriptor.get_executor"></a>
Get
the executor associated with the object.
</p>
<pre class="programlisting">executor_type get_executor();
</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-2020 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="executor_type.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_descriptor.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="io_control.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,55 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>posix::basic_descriptor::io_control</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../index.html" title="Asio">
<link rel="up" href="../posix__basic_descriptor.html" title="posix::basic_descriptor">
<link rel="prev" href="get_executor.html" title="posix::basic_descriptor::get_executor">
<link rel="next" href="io_control/overload1.html" title="posix::basic_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="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="get_executor.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_descriptor.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="io_control/overload1.html"><img src="../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="asio.reference.posix__basic_descriptor.io_control"></a><a class="link" href="io_control.html" title="posix::basic_descriptor::io_control">posix::basic_descriptor::io_control</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.posix__basic_descriptor.io_control"></a>
Perform
an IO control command on the descriptor.
</p>
<pre class="programlisting">template&lt;
typename <a class="link" href="../IoControlCommand.html" title="I/O control command requirements">IoControlCommand</a>&gt;
void <a class="link" href="io_control/overload1.html" title="posix::basic_descriptor::io_control (1 of 2 overloads)">io_control</a>(
IoControlCommand &amp; command);
<span class="emphasis"><em>» <a class="link" href="io_control/overload1.html" title="posix::basic_descriptor::io_control (1 of 2 overloads)">more...</a></em></span>
template&lt;
typename <a class="link" href="../IoControlCommand.html" title="I/O control command requirements">IoControlCommand</a>&gt;
void <a class="link" href="io_control/overload2.html" title="posix::basic_descriptor::io_control (2 of 2 overloads)">io_control</a>(
IoControlCommand &amp; command,
asio::error_code &amp; ec);
<span class="emphasis"><em>» <a class="link" href="io_control/overload2.html" title="posix::basic_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-2020 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_executor.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_descriptor.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="io_control/overload1.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,88 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>posix::basic_descriptor::io_control (1 of 2 overloads)</title>
<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../../index.html" title="Asio">
<link rel="up" href="../io_control.html" title="posix::basic_descriptor::io_control">
<link rel="prev" href="../io_control.html" title="posix::basic_descriptor::io_control">
<link rel="next" href="overload2.html" title="posix::basic_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="asio C++ library" width="250" height="60" src="../../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../io_control.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../io_control.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.posix__basic_descriptor.io_control.overload1"></a><a class="link" href="overload1.html" title="posix::basic_descriptor::io_control (1 of 2 overloads)">posix::basic_descriptor::io_control
(1 of 2 overloads)</a>
</h5></div></div></div>
<p>
Perform an IO control command on the descriptor.
</p>
<pre class="programlisting">template&lt;
typename <a class="link" href="../../IoControlCommand.html" title="I/O control command requirements">IoControlCommand</a>&gt;
void io_control(
IoControlCommand &amp; command);
</pre>
<p>
This function is used to execute an IO control command on the descriptor.
</p>
<h6>
<a name="asio.reference.posix__basic_descriptor.io_control.overload1.h0"></a>
<span><a name="asio.reference.posix__basic_descriptor.io_control.overload1.parameters"></a></span><a class="link" href="overload1.html#asio.reference.posix__basic_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="asio.reference.posix__basic_descriptor.io_control.overload1.h1"></a>
<span><a name="asio.reference.posix__basic_descriptor.io_control.overload1.exceptions"></a></span><a class="link" href="overload1.html#asio.reference.posix__basic_descriptor.io_control.overload1.exceptions">Exceptions</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">asio::system_error</span></dt>
<dd><p>
Thrown on failure.
</p></dd>
</dl>
</div>
<h6>
<a name="asio.reference.posix__basic_descriptor.io_control.overload1.h2"></a>
<span><a name="asio.reference.posix__basic_descriptor.io_control.overload1.example"></a></span><a class="link" href="overload1.html#asio.reference.posix__basic_descriptor.io_control.overload1.example">Example</a>
</h6>
<p>
Getting the number of bytes ready to read:
</p>
<pre class="programlisting">asio::posix::stream_descriptor descriptor(my_context);
...
asio::posix::stream_descriptor::bytes_readable command;
descriptor.io_control(command);
std::size_t bytes_readable = command.get();
</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-2020 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="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../io_control.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,85 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>posix::basic_descriptor::io_control (2 of 2 overloads)</title>
<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../../index.html" title="Asio">
<link rel="up" href="../io_control.html" title="posix::basic_descriptor::io_control">
<link rel="prev" href="overload1.html" title="posix::basic_descriptor::io_control (1 of 2 overloads)">
<link rel="next" href="../is_open.html" title="posix::basic_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="asio C++ library" width="250" height="60" src="../../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="overload1.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../io_control.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="../is_open.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.posix__basic_descriptor.io_control.overload2"></a><a class="link" href="overload2.html" title="posix::basic_descriptor::io_control (2 of 2 overloads)">posix::basic_descriptor::io_control
(2 of 2 overloads)</a>
</h5></div></div></div>
<p>
Perform an IO control command on the descriptor.
</p>
<pre class="programlisting">template&lt;
typename <a class="link" href="../../IoControlCommand.html" title="I/O control command requirements">IoControlCommand</a>&gt;
void io_control(
IoControlCommand &amp; command,
asio::error_code &amp; ec);
</pre>
<p>
This function is used to execute an IO control command on the descriptor.
</p>
<h6>
<a name="asio.reference.posix__basic_descriptor.io_control.overload2.h0"></a>
<span><a name="asio.reference.posix__basic_descriptor.io_control.overload2.parameters"></a></span><a class="link" href="overload2.html#asio.reference.posix__basic_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="asio.reference.posix__basic_descriptor.io_control.overload2.h1"></a>
<span><a name="asio.reference.posix__basic_descriptor.io_control.overload2.example"></a></span><a class="link" href="overload2.html#asio.reference.posix__basic_descriptor.io_control.overload2.example">Example</a>
</h6>
<p>
Getting the number of bytes ready to read:
</p>
<pre class="programlisting">asio::posix::stream_descriptor descriptor(my_context);
...
asio::posix::stream_descriptor::bytes_readable command;
asio::error_code ec;
descriptor.io_control(command, ec);
if (ec)
{
// An error occurred.
}
std::size_t bytes_readable = command.get();
</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-2020 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="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../io_control.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="../is_open.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,44 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>posix::basic_descriptor::is_open</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../index.html" title="Asio">
<link rel="up" href="../posix__basic_descriptor.html" title="posix::basic_descriptor">
<link rel="prev" href="io_control/overload2.html" title="posix::basic_descriptor::io_control (2 of 2 overloads)">
<link rel="next" href="lowest_layer.html" title="posix::basic_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="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="io_control/overload2.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_descriptor.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="lowest_layer.html"><img src="../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="asio.reference.posix__basic_descriptor.is_open"></a><a class="link" href="is_open.html" title="posix::basic_descriptor::is_open">posix::basic_descriptor::is_open</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.posix__basic_descriptor.is_open"></a>
Determine
whether the descriptor is open.
</p>
<pre class="programlisting">bool is_open() const;
</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-2020 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="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_descriptor.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="lowest_layer.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,51 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>posix::basic_descriptor::lowest_layer</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../index.html" title="Asio">
<link rel="up" href="../posix__basic_descriptor.html" title="posix::basic_descriptor">
<link rel="prev" href="is_open.html" title="posix::basic_descriptor::is_open">
<link rel="next" href="lowest_layer/overload1.html" title="posix::basic_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="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="is_open.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_descriptor.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="lowest_layer/overload1.html"><img src="../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="asio.reference.posix__basic_descriptor.lowest_layer"></a><a class="link" href="lowest_layer.html" title="posix::basic_descriptor::lowest_layer">posix::basic_descriptor::lowest_layer</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.posix__basic_descriptor.lowest_layer"></a>
Get
a reference to the lowest layer.
</p>
<pre class="programlisting">lowest_layer_type &amp; <a class="link" href="lowest_layer/overload1.html" title="posix::basic_descriptor::lowest_layer (1 of 2 overloads)">lowest_layer</a>();
<span class="emphasis"><em>» <a class="link" href="lowest_layer/overload1.html" title="posix::basic_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">const lowest_layer_type &amp; <a class="link" href="lowest_layer/overload2.html" title="posix::basic_descriptor::lowest_layer (2 of 2 overloads)">lowest_layer</a>() const;
<span class="emphasis"><em>» <a class="link" href="lowest_layer/overload2.html" title="posix::basic_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-2020 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="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_descriptor.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="lowest_layer/overload1.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,57 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>posix::basic_descriptor::lowest_layer (1 of 2 overloads)</title>
<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../../index.html" title="Asio">
<link rel="up" href="../lowest_layer.html" title="posix::basic_descriptor::lowest_layer">
<link rel="prev" href="../lowest_layer.html" title="posix::basic_descriptor::lowest_layer">
<link rel="next" href="overload2.html" title="posix::basic_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="asio C++ library" width="250" height="60" src="../../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../lowest_layer.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../lowest_layer.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.posix__basic_descriptor.lowest_layer.overload1"></a><a class="link" href="overload1.html" title="posix::basic_descriptor::lowest_layer (1 of 2 overloads)">posix::basic_descriptor::lowest_layer
(1 of 2 overloads)</a>
</h5></div></div></div>
<p>
Get a reference to the lowest layer.
</p>
<pre class="programlisting">lowest_layer_type &amp; lowest_layer();
</pre>
<p>
This function returns a reference to the lowest layer in a stack of layers.
Since a descriptor cannot contain any further layers, it simply returns
a reference to itself.
</p>
<h6>
<a name="asio.reference.posix__basic_descriptor.lowest_layer.overload1.h0"></a>
<span><a name="asio.reference.posix__basic_descriptor.lowest_layer.overload1.return_value"></a></span><a class="link" href="overload1.html#asio.reference.posix__basic_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-2020 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="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../lowest_layer.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,57 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>posix::basic_descriptor::lowest_layer (2 of 2 overloads)</title>
<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../../index.html" title="Asio">
<link rel="up" href="../lowest_layer.html" title="posix::basic_descriptor::lowest_layer">
<link rel="prev" href="overload1.html" title="posix::basic_descriptor::lowest_layer (1 of 2 overloads)">
<link rel="next" href="../lowest_layer_type.html" title="posix::basic_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="asio C++ library" width="250" height="60" src="../../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="overload1.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../lowest_layer.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="../lowest_layer_type.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.posix__basic_descriptor.lowest_layer.overload2"></a><a class="link" href="overload2.html" title="posix::basic_descriptor::lowest_layer (2 of 2 overloads)">posix::basic_descriptor::lowest_layer
(2 of 2 overloads)</a>
</h5></div></div></div>
<p>
Get a const reference to the lowest layer.
</p>
<pre class="programlisting">const lowest_layer_type &amp; lowest_layer() const;
</pre>
<p>
This function returns a const reference to the lowest layer in a stack
of layers. Since a descriptor cannot contain any further layers, it simply
returns a reference to itself.
</p>
<h6>
<a name="asio.reference.posix__basic_descriptor.lowest_layer.overload2.h0"></a>
<span><a name="asio.reference.posix__basic_descriptor.lowest_layer.overload2.return_value"></a></span><a class="link" href="overload2.html#asio.reference.posix__basic_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-2020 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="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../lowest_layer.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="../lowest_layer_type.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,414 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>posix::basic_descriptor::lowest_layer_type</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../index.html" title="Asio">
<link rel="up" href="../posix__basic_descriptor.html" title="posix::basic_descriptor">
<link rel="prev" href="lowest_layer/overload2.html" title="posix::basic_descriptor::lowest_layer (2 of 2 overloads)">
<link rel="next" href="native_handle.html" title="posix::basic_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="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="lowest_layer/overload2.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_descriptor.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="native_handle.html"><img src="../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="asio.reference.posix__basic_descriptor.lowest_layer_type"></a><a class="link" href="lowest_layer_type.html" title="posix::basic_descriptor::lowest_layer_type">posix::basic_descriptor::lowest_layer_type</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.posix__basic_descriptor.lowest_layer_type"></a>
A
descriptor is always the lowest layer.
</p>
<pre class="programlisting">typedef basic_descriptor lowest_layer_type;
</pre>
<h6>
<a name="asio.reference.posix__basic_descriptor.lowest_layer_type.h0"></a>
<span><a name="asio.reference.posix__basic_descriptor.lowest_layer_type.types"></a></span><a class="link" href="lowest_layer_type.html#asio.reference.posix__basic_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__rebind_executor.html" title="posix::basic_descriptor::rebind_executor"><span class="bold"><strong>rebind_executor</strong></span></a>
</p>
</td>
<td>
<p>
Rebinds the descriptor type to another executor.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="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="executor_type.html" title="posix::basic_descriptor::executor_type"><span class="bold"><strong>executor_type</strong></span></a>
</p>
</td>
<td>
<p>
The type of the executor associated with the object.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="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 descriptor is always the lowest layer.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="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="wait_type.html" title="posix::basic_descriptor::wait_type"><span class="bold"><strong>wait_type</strong></span></a>
</p>
</td>
<td>
<p>
Wait types.
</p>
</td>
</tr>
</tbody>
</table></div>
<h6>
<a name="asio.reference.posix__basic_descriptor.lowest_layer_type.h1"></a>
<span><a name="asio.reference.posix__basic_descriptor.lowest_layer_type.member_functions"></a></span><a class="link" href="lowest_layer_type.html#asio.reference.posix__basic_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="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="async_wait.html" title="posix::basic_descriptor::async_wait"><span class="bold"><strong>async_wait</strong></span></a>
</p>
</td>
<td>
<p>
Asynchronously wait for the descriptor to become ready to read,
ready to write, or to have pending error conditions.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="basic_descriptor.html" title="posix::basic_descriptor::basic_descriptor"><span class="bold"><strong>basic_descriptor</strong></span></a> <span class="silver">[constructor]</span>
</p>
</td>
<td>
<p>
Construct a descriptor without opening it. <br> <span class="silver"> —</span><br> Construct
a descriptor on an existing native descriptor. <br> <span class="silver"> —</span><br>
Move-construct a descriptor from another.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="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="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="get_executor.html" title="posix::basic_descriptor::get_executor"><span class="bold"><strong>get_executor</strong></span></a>
</p>
</td>
<td>
<p>
Get the executor associated with the object.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="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="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="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. <br> <span class="silver"> —</span><br> Get a const
reference to the lowest layer.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="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="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.
<br> <span class="silver"> —</span><br> Sets the non-blocking mode of the native descriptor
implementation.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="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. <br> <span class="silver"> —</span><br> Sets
the non-blocking mode of the descriptor.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="operator_eq_.html" title="posix::basic_descriptor::operator="><span class="bold"><strong>operator=</strong></span></a>
</p>
</td>
<td>
<p>
Move-assign a descriptor from another.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="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>
<tr>
<td>
<p>
<a class="link" href="wait.html" title="posix::basic_descriptor::wait"><span class="bold"><strong>wait</strong></span></a>
</p>
</td>
<td>
<p>
Wait for the descriptor to become ready to read, ready to write,
or to have pending error conditions.
</p>
</td>
</tr>
</tbody>
</table></div>
<h6>
<a name="asio.reference.posix__basic_descriptor.lowest_layer_type.h2"></a>
<span><a name="asio.reference.posix__basic_descriptor.lowest_layer_type.protected_member_functions"></a></span><a class="link" href="lowest_layer_type.html#asio.reference.posix__basic_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="_basic_descriptor.html" title="posix::basic_descriptor::~basic_descriptor"><span class="bold"><strong>~basic_descriptor</strong></span></a> <span class="silver">[destructor]</span>
</p>
</td>
<td>
<p>
Protected destructor to prevent deletion through this type.
</p>
</td>
</tr></tbody>
</table></div>
<p>
The <a class="link" href="../posix__basic_descriptor.html" title="posix::basic_descriptor"><code class="computeroutput">posix::basic_descriptor</code></a>
class template provides the ability to wrap a POSIX descriptor.
</p>
<h6>
<a name="asio.reference.posix__basic_descriptor.lowest_layer_type.h3"></a>
<span><a name="asio.reference.posix__basic_descriptor.lowest_layer_type.thread_safety"></a></span><a class="link" href="lowest_layer_type.html#asio.reference.posix__basic_descriptor.lowest_layer_type.thread_safety">Thread
Safety</a>
</h6>
<p>
<span class="emphasis"><em>Distinct</em></span> <span class="emphasis"><em>objects:</em></span> Safe.
</p>
<p>
<span class="emphasis"><em>Shared</em></span> <span class="emphasis"><em>objects:</em></span> Unsafe.
</p>
<h6>
<a name="asio.reference.posix__basic_descriptor.lowest_layer_type.h4"></a>
<span><a name="asio.reference.posix__basic_descriptor.lowest_layer_type.requirements"></a></span><a class="link" href="lowest_layer_type.html#asio.reference.posix__basic_descriptor.lowest_layer_type.requirements">Requirements</a>
</h6>
<p>
<span class="emphasis"><em>Header: </em></span><code class="literal">asio/posix/basic_descriptor.hpp</code>
</p>
<p>
<span class="emphasis"><em>Convenience header: </em></span><code class="literal">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-2020 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="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_descriptor.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="native_handle.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,49 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>posix::basic_descriptor::native_handle</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../index.html" title="Asio">
<link rel="up" href="../posix__basic_descriptor.html" title="posix::basic_descriptor">
<link rel="prev" href="lowest_layer_type.html" title="posix::basic_descriptor::lowest_layer_type">
<link rel="next" href="native_handle_type.html" title="posix::basic_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="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="lowest_layer_type.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_descriptor.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="native_handle_type.html"><img src="../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="asio.reference.posix__basic_descriptor.native_handle"></a><a class="link" href="native_handle.html" title="posix::basic_descriptor::native_handle">posix::basic_descriptor::native_handle</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.posix__basic_descriptor.native_handle"></a>
Get
the native descriptor representation.
</p>
<pre class="programlisting">native_handle_type native_handle();
</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-2020 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="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_descriptor.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="native_handle_type.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,54 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>posix::basic_descriptor::native_handle_type</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../index.html" title="Asio">
<link rel="up" href="../posix__basic_descriptor.html" title="posix::basic_descriptor">
<link rel="prev" href="native_handle.html" title="posix::basic_descriptor::native_handle">
<link rel="next" href="native_non_blocking.html" title="posix::basic_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="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="native_handle.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_descriptor.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="native_non_blocking.html"><img src="../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="asio.reference.posix__basic_descriptor.native_handle_type"></a><a class="link" href="native_handle_type.html" title="posix::basic_descriptor::native_handle_type">posix::basic_descriptor::native_handle_type</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.posix__basic_descriptor.native_handle_type"></a>
The
native representation of a descriptor.
</p>
<pre class="programlisting">typedef implementation_defined native_handle_type;
</pre>
<h6>
<a name="asio.reference.posix__basic_descriptor.native_handle_type.h0"></a>
<span><a name="asio.reference.posix__basic_descriptor.native_handle_type.requirements"></a></span><a class="link" href="native_handle_type.html#asio.reference.posix__basic_descriptor.native_handle_type.requirements">Requirements</a>
</h6>
<p>
<span class="emphasis"><em>Header: </em></span><code class="literal">asio/posix/basic_descriptor.hpp</code>
</p>
<p>
<span class="emphasis"><em>Convenience header: </em></span><code class="literal">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-2020 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="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_descriptor.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="native_non_blocking.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,57 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>posix::basic_descriptor::native_non_blocking</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../index.html" title="Asio">
<link rel="up" href="../posix__basic_descriptor.html" title="posix::basic_descriptor">
<link rel="prev" href="native_handle_type.html" title="posix::basic_descriptor::native_handle_type">
<link rel="next" href="native_non_blocking/overload1.html" title="posix::basic_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="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="native_handle_type.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_descriptor.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="native_non_blocking/overload1.html"><img src="../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="asio.reference.posix__basic_descriptor.native_non_blocking"></a><a class="link" href="native_non_blocking.html" title="posix::basic_descriptor::native_non_blocking">posix::basic_descriptor::native_non_blocking</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.posix__basic_descriptor.native_non_blocking"></a>
Gets
the non-blocking mode of the native descriptor implementation.
</p>
<pre class="programlisting">bool <a class="link" href="native_non_blocking/overload1.html" title="posix::basic_descriptor::native_non_blocking (1 of 3 overloads)">native_non_blocking</a>() const;
<span class="emphasis"><em>» <a class="link" href="native_non_blocking/overload1.html" title="posix::basic_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">void <a class="link" href="native_non_blocking/overload2.html" title="posix::basic_descriptor::native_non_blocking (2 of 3 overloads)">native_non_blocking</a>(
bool mode);
<span class="emphasis"><em>» <a class="link" href="native_non_blocking/overload2.html" title="posix::basic_descriptor::native_non_blocking (2 of 3 overloads)">more...</a></em></span>
void <a class="link" href="native_non_blocking/overload3.html" title="posix::basic_descriptor::native_non_blocking (3 of 3 overloads)">native_non_blocking</a>(
bool mode,
asio::error_code &amp; ec);
<span class="emphasis"><em>» <a class="link" href="native_non_blocking/overload3.html" title="posix::basic_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-2020 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="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_descriptor.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="native_non_blocking/overload1.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,67 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>posix::basic_descriptor::native_non_blocking (1 of 3 overloads)</title>
<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../../index.html" title="Asio">
<link rel="up" href="../native_non_blocking.html" title="posix::basic_descriptor::native_non_blocking">
<link rel="prev" href="../native_non_blocking.html" title="posix::basic_descriptor::native_non_blocking">
<link rel="next" href="overload2.html" title="posix::basic_descriptor::native_non_blocking (2 of 3 overloads)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../native_non_blocking.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../native_non_blocking.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.posix__basic_descriptor.native_non_blocking.overload1"></a><a class="link" href="overload1.html" title="posix::basic_descriptor::native_non_blocking (1 of 3 overloads)">posix::basic_descriptor::native_non_blocking
(1 of 3 overloads)</a>
</h5></div></div></div>
<p>
Gets the non-blocking mode of the native descriptor implementation.
</p>
<pre class="programlisting">bool native_non_blocking() const;
</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="asio.reference.posix__basic_descriptor.native_non_blocking.overload1.h0"></a>
<span><a name="asio.reference.posix__basic_descriptor.native_non_blocking.overload1.return_value"></a></span><a class="link" href="overload1.html#asio.reference.posix__basic_descriptor.native_non_blocking.overload1.return_value">Return
Value</a>
</h6>
<p>
<code class="computeroutput">true</code> if the underlying descriptor is in non-blocking mode
and direct system calls may fail with <code class="computeroutput">asio::error::would_block</code>
(or the equivalent system error).
</p>
<h6>
<a name="asio.reference.posix__basic_descriptor.native_non_blocking.overload1.h1"></a>
<span><a name="asio.reference.posix__basic_descriptor.native_non_blocking.overload1.remarks"></a></span><a class="link" href="overload1.html#asio.reference.posix__basic_descriptor.native_non_blocking.overload1.remarks">Remarks</a>
</h6>
<p>
The current non-blocking mode is cached by the descriptor object. Consequently,
the return value may be incorrect if the non-blocking mode was set directly
on the native descriptor.
</p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright © 2003-2020 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="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../native_non_blocking.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,80 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>posix::basic_descriptor::native_non_blocking (2 of 3 overloads)</title>
<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../../index.html" title="Asio">
<link rel="up" href="../native_non_blocking.html" title="posix::basic_descriptor::native_non_blocking">
<link rel="prev" href="overload1.html" title="posix::basic_descriptor::native_non_blocking (1 of 3 overloads)">
<link rel="next" href="overload3.html" title="posix::basic_descriptor::native_non_blocking (3 of 3 overloads)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="overload1.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../native_non_blocking.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="overload3.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.posix__basic_descriptor.native_non_blocking.overload2"></a><a class="link" href="overload2.html" title="posix::basic_descriptor::native_non_blocking (2 of 3 overloads)">posix::basic_descriptor::native_non_blocking
(2 of 3 overloads)</a>
</h5></div></div></div>
<p>
Sets the non-blocking mode of the native descriptor implementation.
</p>
<pre class="programlisting">void native_non_blocking(
bool mode);
</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="asio.reference.posix__basic_descriptor.native_non_blocking.overload2.h0"></a>
<span><a name="asio.reference.posix__basic_descriptor.native_non_blocking.overload2.parameters"></a></span><a class="link" href="overload2.html#asio.reference.posix__basic_descriptor.native_non_blocking.overload2.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">mode</span></dt>
<dd><p>
If <code class="computeroutput">true</code>, the underlying descriptor is put into non-blocking
mode and direct system calls may fail with <code class="computeroutput">asio::error::would_block</code>
(or the equivalent system error).
</p></dd>
</dl>
</div>
<h6>
<a name="asio.reference.posix__basic_descriptor.native_non_blocking.overload2.h1"></a>
<span><a name="asio.reference.posix__basic_descriptor.native_non_blocking.overload2.exceptions"></a></span><a class="link" href="overload2.html#asio.reference.posix__basic_descriptor.native_non_blocking.overload2.exceptions">Exceptions</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">asio::system_error</span></dt>
<dd><p>
Thrown on failure. If the <code class="computeroutput">mode</code> is <code class="computeroutput">false</code>,
but the current value of <code class="computeroutput">non_blocking()</code> is <code class="computeroutput">true</code>,
this function fails with <code class="computeroutput">asio::error::invalid_argument</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-2020 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="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../native_non_blocking.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="overload3.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,72 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>posix::basic_descriptor::native_non_blocking (3 of 3 overloads)</title>
<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../../index.html" title="Asio">
<link rel="up" href="../native_non_blocking.html" title="posix::basic_descriptor::native_non_blocking">
<link rel="prev" href="overload2.html" title="posix::basic_descriptor::native_non_blocking (2 of 3 overloads)">
<link rel="next" href="../non_blocking.html" title="posix::basic_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="asio C++ library" width="250" height="60" src="../../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="overload2.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../native_non_blocking.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="../non_blocking.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.posix__basic_descriptor.native_non_blocking.overload3"></a><a class="link" href="overload3.html" title="posix::basic_descriptor::native_non_blocking (3 of 3 overloads)">posix::basic_descriptor::native_non_blocking
(3 of 3 overloads)</a>
</h5></div></div></div>
<p>
Sets the non-blocking mode of the native descriptor implementation.
</p>
<pre class="programlisting">void native_non_blocking(
bool mode,
asio::error_code &amp; ec);
</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="asio.reference.posix__basic_descriptor.native_non_blocking.overload3.h0"></a>
<span><a name="asio.reference.posix__basic_descriptor.native_non_blocking.overload3.parameters"></a></span><a class="link" href="overload3.html#asio.reference.posix__basic_descriptor.native_non_blocking.overload3.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">mode</span></dt>
<dd><p>
If <code class="computeroutput">true</code>, the underlying descriptor is put into non-blocking
mode and direct system calls may fail with <code class="computeroutput">asio::error::would_block</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">mode</code>
is <code class="computeroutput">false</code>, but the current value of <code class="computeroutput">non_blocking()</code>
is <code class="computeroutput">true</code>, this function fails with <code class="computeroutput">asio::error::invalid_argument</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-2020 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="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../native_non_blocking.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="../non_blocking.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,57 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>posix::basic_descriptor::non_blocking</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../index.html" title="Asio">
<link rel="up" href="../posix__basic_descriptor.html" title="posix::basic_descriptor">
<link rel="prev" href="native_non_blocking/overload3.html" title="posix::basic_descriptor::native_non_blocking (3 of 3 overloads)">
<link rel="next" href="non_blocking/overload1.html" title="posix::basic_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="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="native_non_blocking/overload3.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_descriptor.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="non_blocking/overload1.html"><img src="../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="asio.reference.posix__basic_descriptor.non_blocking"></a><a class="link" href="non_blocking.html" title="posix::basic_descriptor::non_blocking">posix::basic_descriptor::non_blocking</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.posix__basic_descriptor.non_blocking"></a>
Gets
the non-blocking mode of the descriptor.
</p>
<pre class="programlisting">bool <a class="link" href="non_blocking/overload1.html" title="posix::basic_descriptor::non_blocking (1 of 3 overloads)">non_blocking</a>() const;
<span class="emphasis"><em>» <a class="link" href="non_blocking/overload1.html" title="posix::basic_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">void <a class="link" href="non_blocking/overload2.html" title="posix::basic_descriptor::non_blocking (2 of 3 overloads)">non_blocking</a>(
bool mode);
<span class="emphasis"><em>» <a class="link" href="non_blocking/overload2.html" title="posix::basic_descriptor::non_blocking (2 of 3 overloads)">more...</a></em></span>
void <a class="link" href="non_blocking/overload3.html" title="posix::basic_descriptor::non_blocking (3 of 3 overloads)">non_blocking</a>(
bool mode,
asio::error_code &amp; ec);
<span class="emphasis"><em>» <a class="link" href="non_blocking/overload3.html" title="posix::basic_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-2020 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="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_descriptor.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="non_blocking/overload1.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,62 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>posix::basic_descriptor::non_blocking (1 of 3 overloads)</title>
<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../../index.html" title="Asio">
<link rel="up" href="../non_blocking.html" title="posix::basic_descriptor::non_blocking">
<link rel="prev" href="../non_blocking.html" title="posix::basic_descriptor::non_blocking">
<link rel="next" href="overload2.html" title="posix::basic_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="asio C++ library" width="250" height="60" src="../../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../non_blocking.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../non_blocking.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.posix__basic_descriptor.non_blocking.overload1"></a><a class="link" href="overload1.html" title="posix::basic_descriptor::non_blocking (1 of 3 overloads)">posix::basic_descriptor::non_blocking
(1 of 3 overloads)</a>
</h5></div></div></div>
<p>
Gets the non-blocking mode of the descriptor.
</p>
<pre class="programlisting">bool non_blocking() const;
</pre>
<h6>
<a name="asio.reference.posix__basic_descriptor.non_blocking.overload1.h0"></a>
<span><a name="asio.reference.posix__basic_descriptor.non_blocking.overload1.return_value"></a></span><a class="link" href="overload1.html#asio.reference.posix__basic_descriptor.non_blocking.overload1.return_value">Return
Value</a>
</h6>
<p>
<code class="computeroutput">true</code> if the descriptor's synchronous operations will fail
with <code class="computeroutput">asio::error::would_block</code> if they are unable to perform
the requested operation immediately. If <code class="computeroutput">false</code>, synchronous
operations will block until complete.
</p>
<h6>
<a name="asio.reference.posix__basic_descriptor.non_blocking.overload1.h1"></a>
<span><a name="asio.reference.posix__basic_descriptor.non_blocking.overload1.remarks"></a></span><a class="link" href="overload1.html#asio.reference.posix__basic_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">asio::error::would_block</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-2020 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="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../non_blocking.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,81 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>posix::basic_descriptor::non_blocking (2 of 3 overloads)</title>
<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../../index.html" title="Asio">
<link rel="up" href="../non_blocking.html" title="posix::basic_descriptor::non_blocking">
<link rel="prev" href="overload1.html" title="posix::basic_descriptor::non_blocking (1 of 3 overloads)">
<link rel="next" href="overload3.html" title="posix::basic_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="asio C++ library" width="250" height="60" src="../../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="overload1.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../non_blocking.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="overload3.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.posix__basic_descriptor.non_blocking.overload2"></a><a class="link" href="overload2.html" title="posix::basic_descriptor::non_blocking (2 of 3 overloads)">posix::basic_descriptor::non_blocking
(2 of 3 overloads)</a>
</h5></div></div></div>
<p>
Sets the non-blocking mode of the descriptor.
</p>
<pre class="programlisting">void non_blocking(
bool mode);
</pre>
<h6>
<a name="asio.reference.posix__basic_descriptor.non_blocking.overload2.h0"></a>
<span><a name="asio.reference.posix__basic_descriptor.non_blocking.overload2.parameters"></a></span><a class="link" href="overload2.html#asio.reference.posix__basic_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">true</code>, the descriptor's synchronous operations will
fail with <code class="computeroutput">asio::error::would_block</code> if they are unable
to perform the requested operation immediately. If <code class="computeroutput">false</code>,
synchronous operations will block until complete.
</p></dd>
</dl>
</div>
<h6>
<a name="asio.reference.posix__basic_descriptor.non_blocking.overload2.h1"></a>
<span><a name="asio.reference.posix__basic_descriptor.non_blocking.overload2.exceptions"></a></span><a class="link" href="overload2.html#asio.reference.posix__basic_descriptor.non_blocking.overload2.exceptions">Exceptions</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">asio::system_error</span></dt>
<dd><p>
Thrown on failure.
</p></dd>
</dl>
</div>
<h6>
<a name="asio.reference.posix__basic_descriptor.non_blocking.overload2.h2"></a>
<span><a name="asio.reference.posix__basic_descriptor.non_blocking.overload2.remarks"></a></span><a class="link" href="overload2.html#asio.reference.posix__basic_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">asio::error::would_block</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-2020 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="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../non_blocking.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="overload3.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,73 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>posix::basic_descriptor::non_blocking (3 of 3 overloads)</title>
<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../../index.html" title="Asio">
<link rel="up" href="../non_blocking.html" title="posix::basic_descriptor::non_blocking">
<link rel="prev" href="overload2.html" title="posix::basic_descriptor::non_blocking (2 of 3 overloads)">
<link rel="next" href="../operator_eq_.html" title="posix::basic_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="asio C++ library" width="250" height="60" src="../../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="overload2.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../non_blocking.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="../operator_eq_.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.posix__basic_descriptor.non_blocking.overload3"></a><a class="link" href="overload3.html" title="posix::basic_descriptor::non_blocking (3 of 3 overloads)">posix::basic_descriptor::non_blocking
(3 of 3 overloads)</a>
</h5></div></div></div>
<p>
Sets the non-blocking mode of the descriptor.
</p>
<pre class="programlisting">void non_blocking(
bool mode,
asio::error_code &amp; ec);
</pre>
<h6>
<a name="asio.reference.posix__basic_descriptor.non_blocking.overload3.h0"></a>
<span><a name="asio.reference.posix__basic_descriptor.non_blocking.overload3.parameters"></a></span><a class="link" href="overload3.html#asio.reference.posix__basic_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">true</code>, the descriptor's synchronous operations will
fail with <code class="computeroutput">asio::error::would_block</code> if they are unable
to perform the requested operation immediately. If <code class="computeroutput">false</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="asio.reference.posix__basic_descriptor.non_blocking.overload3.h1"></a>
<span><a name="asio.reference.posix__basic_descriptor.non_blocking.overload3.remarks"></a></span><a class="link" href="overload3.html#asio.reference.posix__basic_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">asio::error::would_block</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-2020 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="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../non_blocking.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="../operator_eq_.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,69 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>posix::basic_descriptor::operator=</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../index.html" title="Asio">
<link rel="up" href="../posix__basic_descriptor.html" title="posix::basic_descriptor">
<link rel="prev" href="non_blocking/overload3.html" title="posix::basic_descriptor::non_blocking (3 of 3 overloads)">
<link rel="next" href="release.html" title="posix::basic_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="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="non_blocking/overload3.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_descriptor.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="release.html"><img src="../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="asio.reference.posix__basic_descriptor.operator_eq_"></a><a class="link" href="operator_eq_.html" title="posix::basic_descriptor::operator=">posix::basic_descriptor::operator=</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.posix__basic_descriptor.operator_eq_"></a>
Move-assign
a descriptor from another.
</p>
<pre class="programlisting">basic_descriptor &amp; operator=(
basic_descriptor &amp;&amp; other);
</pre>
<p>
This assignment operator moves a descriptor from one object to another.
</p>
<h6>
<a name="asio.reference.posix__basic_descriptor.operator_eq_.h0"></a>
<span><a name="asio.reference.posix__basic_descriptor.operator_eq_.parameters"></a></span><a class="link" href="operator_eq_.html#asio.reference.posix__basic_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 descriptor object from which the move will occur.
</p></dd>
</dl>
</div>
<h6>
<a name="asio.reference.posix__basic_descriptor.operator_eq_.h1"></a>
<span><a name="asio.reference.posix__basic_descriptor.operator_eq_.remarks"></a></span><a class="link" href="operator_eq_.html#asio.reference.posix__basic_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">basic_descriptor(const executor_type&amp;)</code> constructor.
</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-2020 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="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_descriptor.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="release.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,54 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>posix::basic_descriptor::release</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../index.html" title="Asio">
<link rel="up" href="../posix__basic_descriptor.html" title="posix::basic_descriptor">
<link rel="prev" href="operator_eq_.html" title="posix::basic_descriptor::operator=">
<link rel="next" href="wait.html" title="posix::basic_descriptor::wait">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="operator_eq_.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_descriptor.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="wait.html"><img src="../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="asio.reference.posix__basic_descriptor.release"></a><a class="link" href="release.html" title="posix::basic_descriptor::release">posix::basic_descriptor::release</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.posix__basic_descriptor.release"></a>
Release
ownership of the native descriptor implementation.
</p>
<pre class="programlisting">native_handle_type release();
</pre>
<p>
This function may be used to obtain the underlying representation of the
descriptor. After calling this function, <code class="computeroutput">is_open()</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">asio::error::operation_aborted</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-2020 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="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_descriptor.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="wait.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,52 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>posix::basic_descriptor::wait</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../index.html" title="Asio">
<link rel="up" href="../posix__basic_descriptor.html" title="posix::basic_descriptor">
<link rel="prev" href="release.html" title="posix::basic_descriptor::release">
<link rel="next" href="wait/overload1.html" title="posix::basic_descriptor::wait (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="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="release.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_descriptor.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="wait/overload1.html"><img src="../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="asio.reference.posix__basic_descriptor.wait"></a><a class="link" href="wait.html" title="posix::basic_descriptor::wait">posix::basic_descriptor::wait</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.posix__basic_descriptor.wait"></a>
Wait
for the descriptor to become ready to read, ready to write, or to have
pending error conditions.
</p>
<pre class="programlisting">void <a class="link" href="wait/overload1.html" title="posix::basic_descriptor::wait (1 of 2 overloads)">wait</a>(
wait_type w);
<span class="emphasis"><em>» <a class="link" href="wait/overload1.html" title="posix::basic_descriptor::wait (1 of 2 overloads)">more...</a></em></span>
void <a class="link" href="wait/overload2.html" title="posix::basic_descriptor::wait (2 of 2 overloads)">wait</a>(
wait_type w,
asio::error_code &amp; ec);
<span class="emphasis"><em>» <a class="link" href="wait/overload2.html" title="posix::basic_descriptor::wait (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-2020 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="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_descriptor.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="wait/overload1.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,73 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>posix::basic_descriptor::wait (1 of 2 overloads)</title>
<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../../index.html" title="Asio">
<link rel="up" href="../wait.html" title="posix::basic_descriptor::wait">
<link rel="prev" href="../wait.html" title="posix::basic_descriptor::wait">
<link rel="next" href="overload2.html" title="posix::basic_descriptor::wait (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="asio C++ library" width="250" height="60" src="../../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../wait.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../wait.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.posix__basic_descriptor.wait.overload1"></a><a class="link" href="overload1.html" title="posix::basic_descriptor::wait (1 of 2 overloads)">posix::basic_descriptor::wait
(1 of 2 overloads)</a>
</h5></div></div></div>
<p>
Wait for the descriptor to become ready to read, ready to write, or to
have pending error conditions.
</p>
<pre class="programlisting">void wait(
wait_type w);
</pre>
<p>
This function is used to perform a blocking wait for a descriptor to
enter a ready to read, write or error condition state.
</p>
<h6>
<a name="asio.reference.posix__basic_descriptor.wait.overload1.h0"></a>
<span><a name="asio.reference.posix__basic_descriptor.wait.overload1.parameters"></a></span><a class="link" href="overload1.html#asio.reference.posix__basic_descriptor.wait.overload1.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">w</span></dt>
<dd><p>
Specifies the desired descriptor state.
</p></dd>
</dl>
</div>
<h6>
<a name="asio.reference.posix__basic_descriptor.wait.overload1.h1"></a>
<span><a name="asio.reference.posix__basic_descriptor.wait.overload1.example"></a></span><a class="link" href="overload1.html#asio.reference.posix__basic_descriptor.wait.overload1.example">Example</a>
</h6>
<p>
Waiting for a descriptor to become readable.
</p>
<pre class="programlisting">asio::posix::stream_descriptor descriptor(my_context);
...
descriptor.wait(asio::posix::stream_descriptor::wait_read);
</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-2020 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="../wait.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../wait.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,79 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>posix::basic_descriptor::wait (2 of 2 overloads)</title>
<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../../index.html" title="Asio">
<link rel="up" href="../wait.html" title="posix::basic_descriptor::wait">
<link rel="prev" href="overload1.html" title="posix::basic_descriptor::wait (1 of 2 overloads)">
<link rel="next" href="../wait_type.html" title="posix::basic_descriptor::wait_type">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="overload1.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../wait.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="../wait_type.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.posix__basic_descriptor.wait.overload2"></a><a class="link" href="overload2.html" title="posix::basic_descriptor::wait (2 of 2 overloads)">posix::basic_descriptor::wait
(2 of 2 overloads)</a>
</h5></div></div></div>
<p>
Wait for the descriptor to become ready to read, ready to write, or to
have pending error conditions.
</p>
<pre class="programlisting">void wait(
wait_type w,
asio::error_code &amp; ec);
</pre>
<p>
This function is used to perform a blocking wait for a descriptor to
enter a ready to read, write or error condition state.
</p>
<h6>
<a name="asio.reference.posix__basic_descriptor.wait.overload2.h0"></a>
<span><a name="asio.reference.posix__basic_descriptor.wait.overload2.parameters"></a></span><a class="link" href="overload2.html#asio.reference.posix__basic_descriptor.wait.overload2.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">w</span></dt>
<dd><p>
Specifies the desired descriptor state.
</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="asio.reference.posix__basic_descriptor.wait.overload2.h1"></a>
<span><a name="asio.reference.posix__basic_descriptor.wait.overload2.example"></a></span><a class="link" href="overload2.html#asio.reference.posix__basic_descriptor.wait.overload2.example">Example</a>
</h6>
<p>
Waiting for a descriptor to become readable.
</p>
<pre class="programlisting">asio::posix::stream_descriptor descriptor(my_context);
...
asio::error_code ec;
descriptor.wait(asio::posix::stream_descriptor::wait_read, ec);
</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-2020 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="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../wait.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="../wait_type.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,76 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>posix::basic_descriptor::wait_type</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../index.html" title="Asio">
<link rel="up" href="../posix__basic_descriptor.html" title="posix::basic_descriptor">
<link rel="prev" href="wait/overload2.html" title="posix::basic_descriptor::wait (2 of 2 overloads)">
<link rel="next" href="_basic_descriptor.html" title="posix::basic_descriptor::~basic_descriptor">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="wait/overload2.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_descriptor.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="_basic_descriptor.html"><img src="../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="asio.reference.posix__basic_descriptor.wait_type"></a><a class="link" href="wait_type.html" title="posix::basic_descriptor::wait_type">posix::basic_descriptor::wait_type</a>
</h4></div></div></div>
<p>
<span class="emphasis"><em>Inherited from posix::descriptor_base.</em></span>
</p>
<p>
<a class="indexterm" name="asio.indexterm.posix__basic_descriptor.wait_type"></a>
Wait
types.
</p>
<pre class="programlisting">enum wait_type
</pre>
<p>
<a class="indexterm" name="asio.indexterm.posix__basic_descriptor.wait_type.wait_read"></a>
<a class="indexterm" name="asio.indexterm.posix__basic_descriptor.wait_type.wait_write"></a>
<a class="indexterm" name="asio.indexterm.posix__basic_descriptor.wait_type.wait_error"></a>
</p>
<h6>
<a name="asio.reference.posix__basic_descriptor.wait_type.h0"></a>
<span><a name="asio.reference.posix__basic_descriptor.wait_type.values"></a></span><a class="link" href="wait_type.html#asio.reference.posix__basic_descriptor.wait_type.values">Values</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">wait_read</span></dt>
<dd><p>
Wait for a descriptor to become ready to read.
</p></dd>
<dt><span class="term">wait_write</span></dt>
<dd><p>
Wait for a descriptor to become ready to write.
</p></dd>
<dt><span class="term">wait_error</span></dt>
<dd><p>
Wait for a descriptor to have error conditions pending.
</p></dd>
</dl>
</div>
<p>
For use with <code class="computeroutput">descriptor::wait()</code> and <code class="computeroutput">descriptor::async_wait()</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-2020 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="wait/overload2.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../posix__basic_descriptor.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="_basic_descriptor.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>