1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>basic_waitable_timer::expires_at (2 of 3 overloads)</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="../expires_at.html" title="basic_waitable_timer::expires_at"> 9<link rel="prev" href="overload1.html" title="basic_waitable_timer::expires_at (1 of 3 overloads)"> 10<link rel="next" href="overload3.html" title="basic_waitable_timer::expires_at (3 of 3 overloads)"> 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="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../expires_at.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload3.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="section"> 26<div class="titlepage"><div><div><h5 class="title"> 27<a name="boost_asio.reference.basic_waitable_timer.expires_at.overload2"></a><a class="link" href="overload2.html" title="basic_waitable_timer::expires_at (2 of 3 overloads)">basic_waitable_timer::expires_at 28 (2 of 3 overloads)</a> 29</h5></div></div></div> 30<p> 31 Set the timer's expiry time as an absolute time. 32 </p> 33<pre class="programlisting">std::size_t expires_at( 34 const time_point & expiry_time); 35</pre> 36<p> 37 This function sets the expiry time. Any pending asynchronous wait operations 38 will be cancelled. The handler for each cancelled operation will be invoked 39 with the <code class="computeroutput">boost::asio::error::operation_aborted</code> error code. 40 </p> 41<h6> 42<a name="boost_asio.reference.basic_waitable_timer.expires_at.overload2.h0"></a> 43 <span class="phrase"><a name="boost_asio.reference.basic_waitable_timer.expires_at.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_waitable_timer.expires_at.overload2.parameters">Parameters</a> 44 </h6> 45<div class="variablelist"> 46<p class="title"><b></b></p> 47<dl class="variablelist"> 48<dt><span class="term">expiry_time</span></dt> 49<dd><p> 50 The expiry time to be used for the timer. 51 </p></dd> 52</dl> 53</div> 54<h6> 55<a name="boost_asio.reference.basic_waitable_timer.expires_at.overload2.h1"></a> 56 <span class="phrase"><a name="boost_asio.reference.basic_waitable_timer.expires_at.overload2.return_value"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_waitable_timer.expires_at.overload2.return_value">Return 57 Value</a> 58 </h6> 59<p> 60 The number of asynchronous operations that were cancelled. 61 </p> 62<h6> 63<a name="boost_asio.reference.basic_waitable_timer.expires_at.overload2.h2"></a> 64 <span class="phrase"><a name="boost_asio.reference.basic_waitable_timer.expires_at.overload2.exceptions"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_waitable_timer.expires_at.overload2.exceptions">Exceptions</a> 65 </h6> 66<div class="variablelist"> 67<p class="title"><b></b></p> 68<dl class="variablelist"> 69<dt><span class="term">boost::system::system_error</span></dt> 70<dd><p> 71 Thrown on failure. 72 </p></dd> 73</dl> 74</div> 75<h6> 76<a name="boost_asio.reference.basic_waitable_timer.expires_at.overload2.h3"></a> 77 <span class="phrase"><a name="boost_asio.reference.basic_waitable_timer.expires_at.overload2.remarks"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_waitable_timer.expires_at.overload2.remarks">Remarks</a> 78 </h6> 79<p> 80 If the timer has already expired when <code class="computeroutput">expires_at()</code> is called, 81 then the handlers for asynchronous wait operations will: 82 </p> 83<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> 84<li class="listitem"> 85 have already been invoked; or 86 </li> 87<li class="listitem"> 88 have been queued for invocation in the near future. 89 </li> 90</ul></div> 91<p> 92 These handlers can no longer be cancelled, and therefore are passed an 93 error code that indicates the successful completion of the wait operation. 94 </p> 95</div> 96<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 97<td align="left"></td> 98<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M. 99 Kohlhoff<p> 100 Distributed under the Boost Software License, Version 1.0. (See accompanying 101 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>) 102 </p> 103</div></td> 104</tr></table> 105<hr> 106<div class="spirit-nav"> 107<a accesskey="p" href="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../expires_at.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload3.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 108</div> 109</body> 110</html> 111
