3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4 <title>basic_waitable_timer</title>
5 <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7 <link rel="home" href="../../boost_asio.html" title="Boost.Asio">
8 <link rel="up" href="../reference.html" title="Reference">
9 <link rel="prev" href="basic_streambuf/underflow.html" title="basic_streambuf::underflow">
10 <link rel="next" href="basic_waitable_timer/async_wait.html" title="basic_waitable_timer::async_wait">
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>
22 <div class="spirit-nav">
23 <a accesskey="p" href="basic_streambuf/underflow.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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_waitable_timer/async_wait.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
26 <div class="titlepage"><div><div><h3 class="title">
27 <a name="boost_asio.reference.basic_waitable_timer"></a><a class="link" href="basic_waitable_timer.html" title="basic_waitable_timer">basic_waitable_timer</a>
28 </h3></div></div></div>
30 Provides waitable timer functionality.
32 <pre class="programlisting"><span class="keyword">template</span><span class="special"><</span>
33 <span class="keyword">typename</span> <span class="identifier">Clock</span><span class="special">,</span>
34 <span class="keyword">typename</span> <a class="link" href="WaitTraits.html" title="Wait traits requirements">WaitTraits</a> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">wait_traits</span><span class="special"><</span><span class="identifier">Clock</span><span class="special">>,</span>
35 <span class="keyword">typename</span> <a class="link" href="WaitableTimerService.html" title="Waitable timer service requirements">WaitableTimerService</a> <span class="special">=</span> <span class="identifier">waitable_timer_service</span><span class="special"><</span><span class="identifier">Clock</span><span class="special">,</span> <span class="identifier">WaitTraits</span><span class="special">>></span>
36 <span class="keyword">class</span> <span class="identifier">basic_waitable_timer</span> <span class="special">:</span>
37 <span class="keyword">public</span> <span class="identifier">basic_io_object</span><span class="special"><</span> <span class="identifier">WaitableTimerService</span> <span class="special">></span>
40 <a name="boost_asio.reference.basic_waitable_timer.h0"></a>
41 <span class="phrase"><a name="boost_asio.reference.basic_waitable_timer.types"></a></span><a class="link" href="basic_waitable_timer.html#boost_asio.reference.basic_waitable_timer.types">Types</a>
43 <div class="informaltable"><table class="table">
64 <a class="link" href="basic_waitable_timer/clock_type.html" title="basic_waitable_timer::clock_type"><span class="bold"><strong>clock_type</strong></span></a>
76 <a class="link" href="basic_waitable_timer/duration.html" title="basic_waitable_timer::duration"><span class="bold"><strong>duration</strong></span></a>
81 The duration type of the clock.
88 <a class="link" href="basic_waitable_timer/implementation_type.html" title="basic_waitable_timer::implementation_type"><span class="bold"><strong>implementation_type</strong></span></a>
93 The underlying implementation type of I/O object.
100 <a class="link" href="basic_waitable_timer/service_type.html" title="basic_waitable_timer::service_type"><span class="bold"><strong>service_type</strong></span></a>
105 The type of the service that will be used to provide I/O operations.
112 <a class="link" href="basic_waitable_timer/time_point.html" title="basic_waitable_timer::time_point"><span class="bold"><strong>time_point</strong></span></a>
117 The time point type of the clock.
124 <a class="link" href="basic_waitable_timer/traits_type.html" title="basic_waitable_timer::traits_type"><span class="bold"><strong>traits_type</strong></span></a>
129 The wait traits type.
136 <a name="boost_asio.reference.basic_waitable_timer.h1"></a>
137 <span class="phrase"><a name="boost_asio.reference.basic_waitable_timer.member_functions"></a></span><a class="link" href="basic_waitable_timer.html#boost_asio.reference.basic_waitable_timer.member_functions">Member
140 <div class="informaltable"><table class="table">
161 <a class="link" href="basic_waitable_timer/async_wait.html" title="basic_waitable_timer::async_wait"><span class="bold"><strong>async_wait</strong></span></a>
166 Start an asynchronous wait on the timer.
173 <a class="link" href="basic_waitable_timer/basic_waitable_timer.html" title="basic_waitable_timer::basic_waitable_timer"><span class="bold"><strong>basic_waitable_timer</strong></span></a>
181 Constructor to set a particular expiry time as an absolute time.
184 Constructor to set a particular expiry time relative to now.
191 <a class="link" href="basic_waitable_timer/cancel.html" title="basic_waitable_timer::cancel"><span class="bold"><strong>cancel</strong></span></a>
196 Cancel any asynchronous operations that are waiting on the timer.
203 <a class="link" href="basic_waitable_timer/cancel_one.html" title="basic_waitable_timer::cancel_one"><span class="bold"><strong>cancel_one</strong></span></a>
208 Cancels one asynchronous operation that is waiting on the timer.
215 <a class="link" href="basic_waitable_timer/expires_at.html" title="basic_waitable_timer::expires_at"><span class="bold"><strong>expires_at</strong></span></a>
220 Get the timer's expiry time as an absolute time.
223 Set the timer's expiry time as an absolute time.
230 <a class="link" href="basic_waitable_timer/expires_from_now.html" title="basic_waitable_timer::expires_from_now"><span class="bold"><strong>expires_from_now</strong></span></a>
235 Get the timer's expiry time relative to now.
238 Set the timer's expiry time relative to now.
245 <a class="link" href="basic_waitable_timer/get_io_service.html" title="basic_waitable_timer::get_io_service"><span class="bold"><strong>get_io_service</strong></span></a>
250 Get the io_service associated with the object.
257 <a class="link" href="basic_waitable_timer/wait.html" title="basic_waitable_timer::wait"><span class="bold"><strong>wait</strong></span></a>
262 Perform a blocking wait on the timer.
269 <a name="boost_asio.reference.basic_waitable_timer.h2"></a>
270 <span class="phrase"><a name="boost_asio.reference.basic_waitable_timer.protected_member_functions"></a></span><a class="link" href="basic_waitable_timer.html#boost_asio.reference.basic_waitable_timer.protected_member_functions">Protected
273 <div class="informaltable"><table class="table">
294 <a class="link" href="basic_waitable_timer/get_implementation.html" title="basic_waitable_timer::get_implementation"><span class="bold"><strong>get_implementation</strong></span></a>
299 Get the underlying implementation of the I/O object.
306 <a class="link" href="basic_waitable_timer/get_service.html" title="basic_waitable_timer::get_service"><span class="bold"><strong>get_service</strong></span></a>
311 Get the service associated with the I/O object.
318 <a name="boost_asio.reference.basic_waitable_timer.h3"></a>
319 <span class="phrase"><a name="boost_asio.reference.basic_waitable_timer.protected_data_members"></a></span><a class="link" href="basic_waitable_timer.html#boost_asio.reference.basic_waitable_timer.protected_data_members">Protected
322 <div class="informaltable"><table class="table">
343 <a class="link" href="basic_waitable_timer/implementation.html" title="basic_waitable_timer::implementation"><span class="bold"><strong>implementation</strong></span></a>
348 (Deprecated: Use get_implementation().) The underlying implementation
356 <a class="link" href="basic_waitable_timer/service.html" title="basic_waitable_timer::service"><span class="bold"><strong>service</strong></span></a>
361 (Deprecated: Use get_service().) The service associated with the
369 The <a class="link" href="basic_waitable_timer.html" title="basic_waitable_timer"><code class="computeroutput"><span class="identifier">basic_waitable_timer</span></code></a> class template
370 provides the ability to perform a blocking or asynchronous wait for a timer
374 A waitable timer is always in one of two states: "expired" or "not
375 expired". If the <code class="computeroutput"><span class="identifier">wait</span><span class="special">()</span></code> or <code class="computeroutput"><span class="identifier">async_wait</span><span class="special">()</span></code> function is called on an expired timer,
376 the wait operation will complete immediately.
379 Most applications will use one of the <a class="link" href="steady_timer.html" title="steady_timer"><code class="computeroutput"><span class="identifier">steady_timer</span></code></a>, <a class="link" href="system_timer.html" title="system_timer"><code class="computeroutput"><span class="identifier">system_timer</span></code></a> or <a class="link" href="high_resolution_timer.html" title="high_resolution_timer"><code class="computeroutput"><span class="identifier">high_resolution_timer</span></code></a> typedefs.
382 <a name="boost_asio.reference.basic_waitable_timer.h4"></a>
383 <span class="phrase"><a name="boost_asio.reference.basic_waitable_timer.remarks"></a></span><a class="link" href="basic_waitable_timer.html#boost_asio.reference.basic_waitable_timer.remarks">Remarks</a>
386 This waitable timer functionality is for use with the C++11 standard library's
387 <code class="computeroutput"><span class="special"><</span><span class="identifier">chrono</span><span class="special">></span></code> facility, or with the Boost.Chrono library.
390 <a name="boost_asio.reference.basic_waitable_timer.h5"></a>
391 <span class="phrase"><a name="boost_asio.reference.basic_waitable_timer.thread_safety"></a></span><a class="link" href="basic_waitable_timer.html#boost_asio.reference.basic_waitable_timer.thread_safety">Thread
395 <span class="emphasis"><em>Distinct</em></span> <span class="emphasis"><em>objects:</em></span> Safe.
398 <span class="emphasis"><em>Shared</em></span> <span class="emphasis"><em>objects:</em></span> Unsafe.
401 <a name="boost_asio.reference.basic_waitable_timer.h6"></a>
402 <span class="phrase"><a name="boost_asio.reference.basic_waitable_timer.examples"></a></span><a class="link" href="basic_waitable_timer.html#boost_asio.reference.basic_waitable_timer.examples">Examples</a>
405 Performing a blocking wait (C++11):
407 <pre class="programlisting"><span class="comment">// Construct a timer without setting an expiry time.</span>
408 <span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">steady_timer</span> <span class="identifier">timer</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">);</span>
410 <span class="comment">// Set an expiry time relative to now.</span>
411 <span class="identifier">timer</span><span class="special">.</span><span class="identifier">expires_from_now</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">chrono</span><span class="special">::</span><span class="identifier">seconds</span><span class="special">(</span><span class="number">5</span><span class="special">));</span>
413 <span class="comment">// Wait for the timer to expire.</span>
414 <span class="identifier">timer</span><span class="special">.</span><span class="identifier">wait</span><span class="special">();</span>
417 Performing an asynchronous wait (C++11):
419 <pre class="programlisting"><span class="keyword">void</span> <span class="identifier">handler</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span><span class="special">&</span> <span class="identifier">error</span><span class="special">)</span>
420 <span class="special">{</span>
421 <span class="keyword">if</span> <span class="special">(!</span><span class="identifier">error</span><span class="special">)</span>
422 <span class="special">{</span>
423 <span class="comment">// Timer expired.</span>
424 <span class="special">}</span>
425 <span class="special">}</span>
427 <span class="special">...</span>
429 <span class="comment">// Construct a timer with an absolute expiry time.</span>
430 <span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">steady_timer</span> <span class="identifier">timer</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">,</span>
431 <span class="identifier">std</span><span class="special">::</span><span class="identifier">chrono</span><span class="special">::</span><span class="identifier">steady_clock</span><span class="special">::</span><span class="identifier">now</span><span class="special">()</span> <span class="special">+</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">chrono</span><span class="special">::</span><span class="identifier">seconds</span><span class="special">(</span><span class="number">60</span><span class="special">));</span>
433 <span class="comment">// Start an asynchronous wait.</span>
434 <span class="identifier">timer</span><span class="special">.</span><span class="identifier">async_wait</span><span class="special">(</span><span class="identifier">handler</span><span class="special">);</span>
437 <a name="boost_asio.reference.basic_waitable_timer.h7"></a>
438 <span class="phrase"><a name="boost_asio.reference.basic_waitable_timer.changing_an_active_waitable_timer_s_expiry_time"></a></span><a class="link" href="basic_waitable_timer.html#boost_asio.reference.basic_waitable_timer.changing_an_active_waitable_timer_s_expiry_time">Changing
439 an active waitable timer's expiry time</a>
442 Changing the expiry time of a timer while there are pending asynchronous
443 waits causes those wait operations to be cancelled. To ensure that the action
444 associated with the timer is performed only once, use something like this:
447 <pre class="programlisting"><span class="keyword">void</span> <span class="identifier">on_some_event</span><span class="special">()</span>
448 <span class="special">{</span>
449 <span class="keyword">if</span> <span class="special">(</span><span class="identifier">my_timer</span><span class="special">.</span><span class="identifier">expires_from_now</span><span class="special">(</span><span class="identifier">seconds</span><span class="special">(</span><span class="number">5</span><span class="special">))</span> <span class="special">></span> <span class="number">0</span><span class="special">)</span>
450 <span class="special">{</span>
451 <span class="comment">// We managed to cancel the timer. Start new asynchronous wait.</span>
452 <span class="identifier">my_timer</span><span class="special">.</span><span class="identifier">async_wait</span><span class="special">(</span><span class="identifier">on_timeout</span><span class="special">);</span>
453 <span class="special">}</span>
454 <span class="keyword">else</span>
455 <span class="special">{</span>
456 <span class="comment">// Too late, timer has already expired!</span>
457 <span class="special">}</span>
458 <span class="special">}</span>
460 <span class="keyword">void</span> <span class="identifier">on_timeout</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span><span class="special">&</span> <span class="identifier">e</span><span class="special">)</span>
461 <span class="special">{</span>
462 <span class="keyword">if</span> <span class="special">(</span><span class="identifier">e</span> <span class="special">!=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">error</span><span class="special">::</span><span class="identifier">operation_aborted</span><span class="special">)</span>
463 <span class="special">{</span>
464 <span class="comment">// Timer was not cancelled, take necessary action.</span>
465 <span class="special">}</span>
466 <span class="special">}</span>
468 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
469 <li class="listitem">
470 The <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">basic_waitable_timer</span><span class="special">::</span><span class="identifier">expires_from_now</span><span class="special">()</span></code>
471 function cancels any pending asynchronous waits, and returns the number
472 of asynchronous waits that were cancelled. If it returns 0 then you were
473 too late and the wait handler has already been executed, or will soon
474 be executed. If it returns 1 then the wait handler was successfully cancelled.
476 <li class="listitem">
477 If a wait handler is cancelled, the boost::system::error_code passed
478 to it contains the value <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">error</span><span class="special">::</span><span class="identifier">operation_aborted</span></code>.
482 <a name="boost_asio.reference.basic_waitable_timer.h8"></a>
483 <span class="phrase"><a name="boost_asio.reference.basic_waitable_timer.requirements"></a></span><a class="link" href="basic_waitable_timer.html#boost_asio.reference.basic_waitable_timer.requirements">Requirements</a>
486 <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/basic_waitable_timer.hpp</code>
489 <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code>
492 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
493 <td align="left"></td>
494 <td align="right"><div class="copyright-footer">Copyright © 2003-2014 Christopher M. Kohlhoff<p>
495 Distributed under the Boost Software License, Version 1.0. (See accompanying
496 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>)
501 <div class="spirit-nav">
502 <a accesskey="p" href="basic_streambuf/underflow.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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_waitable_timer/async_wait.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>