diff options
Diffstat (limited to 'doc/html/boost_asio/reference/posix__stream_descriptor/async_wait.html')
| -rw-r--r-- | doc/html/boost_asio/reference/posix__stream_descriptor/async_wait.html | 113 |
1 files changed, 0 insertions, 113 deletions
diff --git a/doc/html/boost_asio/reference/posix__stream_descriptor/async_wait.html b/doc/html/boost_asio/reference/posix__stream_descriptor/async_wait.html deleted file mode 100644 index 093f4168a1..0000000000 --- a/doc/html/boost_asio/reference/posix__stream_descriptor/async_wait.html +++ /dev/null @@ -1,113 +0,0 @@ -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>posix::stream_descriptor::async_wait</title> -<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> -<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> -<link rel="up" href="../posix__stream_descriptor.html" title="posix::stream_descriptor"> -<link rel="prev" href="async_read_some.html" title="posix::stream_descriptor::async_read_some"> -<link rel="next" href="async_write_some.html" title="posix::stream_descriptor::async_write_some"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> -<td align="center"><a href="../../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="async_read_some.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__stream_descriptor.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="async_write_some.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="section"> -<div class="titlepage"><div><div><h4 class="title"> -<a name="boost_asio.reference.posix__stream_descriptor.async_wait"></a><a class="link" href="async_wait.html" title="posix::stream_descriptor::async_wait">posix::stream_descriptor::async_wait</a> -</h4></div></div></div> -<p> - <span class="emphasis"><em>Inherited from posix::descriptor.</em></span> - </p> -<p> - <a class="indexterm" name="boost_asio.indexterm.posix__stream_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< - typename <a class="link" href="../WaitHandler.html" title="Wait handler requirements">WaitHandler</a>> -<a class="link" href="../asynchronous_operations.html#boost_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 && handler); -</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="boost_asio.reference.posix__stream_descriptor.async_wait.h0"></a> - <span class="phrase"><a name="boost_asio.reference.posix__stream_descriptor.async_wait.parameters"></a></span><a class="link" href="async_wait.html#boost_asio.reference.posix__stream_descriptor.async_wait.parameters">Parameters</a> - </h6> -<div class="variablelist"> -<p class="title"><b></b></p> -<dl class="variablelist"> -<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 boost::system::error_code& 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. - Invocation of the handler will be performed in a manner equivalent - to using <code class="computeroutput">boost::asio::io_context::post()</code>. - </p> -</dd> -</dl> -</div> -<h6> -<a name="boost_asio.reference.posix__stream_descriptor.async_wait.h1"></a> - <span class="phrase"><a name="boost_asio.reference.posix__stream_descriptor.async_wait.example"></a></span><a class="link" href="async_wait.html#boost_asio.reference.posix__stream_descriptor.async_wait.example">Example</a> - </h6> -<pre class="programlisting">void wait_handler(const boost::system::error_code& error) -{ - if (!error) - { - // Wait succeeded. - } -} - -... - -boost::asio::posix::stream_descriptor descriptor(io_context); -... -descriptor.async_wait( - boost::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-2018 Christopher M. Kohlhoff<p> - Distributed under the Boost Software License, Version 1.0. (See accompanying - file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="async_read_some.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../posix__stream_descriptor.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="async_write_some.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> |