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