1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>windows::basic_object_handle::async_wait</title> 5<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> 8<link rel="up" href="../windows__basic_object_handle.html" title="windows::basic_object_handle"> 9<link rel="prev" href="assign/overload2.html" title="windows::basic_object_handle::assign (2 of 2 overloads)"> 10<link rel="next" href="basic_object_handle.html" title="windows::basic_object_handle::basic_object_handle"> 11</head> 12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 13<table cellpadding="2" width="100%"><tr> 14<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> 15<td align="center"><a href="../../../../../index.html">Home</a></td> 16<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> 17<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> 18<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> 19<td align="center"><a href="../../../../../more/index.htm">More</a></td> 20</tr></table> 21<hr> 22<div class="spirit-nav"> 23<a accesskey="p" href="assign/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_object_handle.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="basic_object_handle.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="section"> 26<div class="titlepage"><div><div><h4 class="title"> 27<a name="boost_asio.reference.windows__basic_object_handle.async_wait"></a><a class="link" href="async_wait.html" title="windows::basic_object_handle::async_wait">windows::basic_object_handle::async_wait</a> 28</h4></div></div></div> 29<p> 30 <a class="indexterm" name="boost_asio.indexterm.windows__basic_object_handle.async_wait"></a> 31Start 32 an asynchronous wait on the object handle. 33 </p> 34<pre class="programlisting">template< 35 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.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>> 36<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( 37 WaitHandler && handler = <a class="link" href="../asynchronous_operations.html#boost_asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>); 38</pre> 39<p> 40 This function is be used to initiate an asynchronous wait against the object 41 handle. It always returns immediately. 42 </p> 43<h6> 44<a name="boost_asio.reference.windows__basic_object_handle.async_wait.h0"></a> 45 <span class="phrase"><a name="boost_asio.reference.windows__basic_object_handle.async_wait.parameters"></a></span><a class="link" href="async_wait.html#boost_asio.reference.windows__basic_object_handle.async_wait.parameters">Parameters</a> 46 </h6> 47<div class="variablelist"> 48<p class="title"><b></b></p> 49<dl class="variablelist"> 50<dt><span class="term">handler</span></dt> 51<dd> 52<p> 53 The handler to be called when the object handle is set to the signalled 54 state. Copies will be made of the handler as required. The function 55 signature of the handler must be: 56</p> 57<pre class="programlisting">void handler( 58 const boost::system::error_code& error // Result of operation. 59); 60</pre> 61<p> 62 Regardless of whether the asynchronous operation completes immediately 63 or not, the handler will not be invoked from within this function. 64 On immediate completion, invocation of the handler will be performed 65 in a manner equivalent to using <a class="link" href="../post.html" title="post"><code class="computeroutput">post</code></a>. 66 </p> 67</dd> 68</dl> 69</div> 70</div> 71<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 72<td align="left"></td> 73<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M. 74 Kohlhoff<p> 75 Distributed under the Boost Software License, Version 1.0. (See accompanying 76 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>) 77 </p> 78</div></td> 79</tr></table> 80<hr> 81<div class="spirit-nav"> 82<a accesskey="p" href="assign/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../windows__basic_object_handle.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="basic_object_handle.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> 83</div> 84</body> 85</html> 86
