3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4 <title>steady_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="ssl__verify_peer.html" title="ssl::verify_peer">
10 <link rel="next" href="strand.html" title="strand">
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="ssl__verify_peer.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="strand.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.steady_timer"></a><a class="link" href="steady_timer.html" title="steady_timer">steady_timer</a>
28 </h3></div></div></div>
30 <a class="indexterm" name="idp197826176"></a>
31 Typedef for a timer based on the steady clock.
33 <pre class="programlisting"><span class="keyword">typedef</span> <span class="identifier">basic_waitable_timer</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">steady_timer</span><span class="special">;</span>
36 <a name="boost_asio.reference.steady_timer.h0"></a>
37 <span class="phrase"><a name="boost_asio.reference.steady_timer.types"></a></span><a class="link" href="steady_timer.html#boost_asio.reference.steady_timer.types">Types</a>
39 <div class="informaltable"><table class="table">
60 <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>
72 <a class="link" href="basic_waitable_timer/duration.html" title="basic_waitable_timer::duration"><span class="bold"><strong>duration</strong></span></a>
77 The duration type of the clock.
84 <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>
89 The underlying implementation type of I/O object.
96 <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>
101 The type of the service that will be used to provide I/O operations.
108 <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>
113 The time point type of the clock.
120 <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>
125 The wait traits type.
132 <a name="boost_asio.reference.steady_timer.h1"></a>
133 <span class="phrase"><a name="boost_asio.reference.steady_timer.member_functions"></a></span><a class="link" href="steady_timer.html#boost_asio.reference.steady_timer.member_functions">Member
136 <div class="informaltable"><table class="table">
157 <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>
162 Start an asynchronous wait on the timer.
169 <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>
177 Constructor to set a particular expiry time as an absolute time.
180 Constructor to set a particular expiry time relative to now.
187 <a class="link" href="basic_waitable_timer/cancel.html" title="basic_waitable_timer::cancel"><span class="bold"><strong>cancel</strong></span></a>
192 Cancel any asynchronous operations that are waiting on the timer.
199 <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>
204 Cancels one asynchronous operation that is waiting on the timer.
211 <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>
216 Get the timer's expiry time as an absolute time.
219 Set the timer's expiry time as an absolute time.
226 <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>
231 Get the timer's expiry time relative to now.
234 Set the timer's expiry time relative to now.
241 <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>
246 Get the io_service associated with the object.
253 <a class="link" href="basic_waitable_timer/wait.html" title="basic_waitable_timer::wait"><span class="bold"><strong>wait</strong></span></a>
258 Perform a blocking wait on the timer.
265 <a name="boost_asio.reference.steady_timer.h2"></a>
266 <span class="phrase"><a name="boost_asio.reference.steady_timer.protected_member_functions"></a></span><a class="link" href="steady_timer.html#boost_asio.reference.steady_timer.protected_member_functions">Protected
269 <div class="informaltable"><table class="table">
290 <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>
295 Get the underlying implementation of the I/O object.
302 <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>
307 Get the service associated with the I/O object.
314 <a name="boost_asio.reference.steady_timer.h3"></a>
315 <span class="phrase"><a name="boost_asio.reference.steady_timer.protected_data_members"></a></span><a class="link" href="steady_timer.html#boost_asio.reference.steady_timer.protected_data_members">Protected
318 <div class="informaltable"><table class="table">
339 <a class="link" href="basic_waitable_timer/implementation.html" title="basic_waitable_timer::implementation"><span class="bold"><strong>implementation</strong></span></a>
344 (Deprecated: Use get_implementation().) The underlying implementation
352 <a class="link" href="basic_waitable_timer/service.html" title="basic_waitable_timer::service"><span class="bold"><strong>service</strong></span></a>
357 (Deprecated: Use get_service().) The service associated with the
365 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
366 provides the ability to perform a blocking or asynchronous wait for a timer
370 A waitable timer is always in one of two states: "expired" or "not
371 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,
372 the wait operation will complete immediately.
375 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.
378 <a name="boost_asio.reference.steady_timer.h4"></a>
379 <span class="phrase"><a name="boost_asio.reference.steady_timer.remarks"></a></span><a class="link" href="steady_timer.html#boost_asio.reference.steady_timer.remarks">Remarks</a>
382 This waitable timer functionality is for use with the C++11 standard library's
383 <code class="computeroutput"><span class="special"><</span><span class="identifier">chrono</span><span class="special">></span></code> facility, or with the Boost.Chrono library.
386 <a name="boost_asio.reference.steady_timer.h5"></a>
387 <span class="phrase"><a name="boost_asio.reference.steady_timer.thread_safety"></a></span><a class="link" href="steady_timer.html#boost_asio.reference.steady_timer.thread_safety">Thread
391 <span class="emphasis"><em>Distinct</em></span> <span class="emphasis"><em>objects:</em></span> Safe.
394 <span class="emphasis"><em>Shared</em></span> <span class="emphasis"><em>objects:</em></span> Unsafe.
397 <a name="boost_asio.reference.steady_timer.h6"></a>
398 <span class="phrase"><a name="boost_asio.reference.steady_timer.examples"></a></span><a class="link" href="steady_timer.html#boost_asio.reference.steady_timer.examples">Examples</a>
401 Performing a blocking wait (C++11):
403 <pre class="programlisting"><span class="comment">// Construct a timer without setting an expiry time.</span>
404 <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>
406 <span class="comment">// Set an expiry time relative to now.</span>
407 <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>
409 <span class="comment">// Wait for the timer to expire.</span>
410 <span class="identifier">timer</span><span class="special">.</span><span class="identifier">wait</span><span class="special">();</span>
413 Performing an asynchronous wait (C++11):
415 <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>
416 <span class="special">{</span>
417 <span class="keyword">if</span> <span class="special">(!</span><span class="identifier">error</span><span class="special">)</span>
418 <span class="special">{</span>
419 <span class="comment">// Timer expired.</span>
420 <span class="special">}</span>
421 <span class="special">}</span>
423 <span class="special">...</span>
425 <span class="comment">// Construct a timer with an absolute expiry time.</span>
426 <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>
427 <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>
429 <span class="comment">// Start an asynchronous wait.</span>
430 <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>
433 <a name="boost_asio.reference.steady_timer.h7"></a>
434 <span class="phrase"><a name="boost_asio.reference.steady_timer.changing_an_active_waitable_timer_s_expiry_time"></a></span><a class="link" href="steady_timer.html#boost_asio.reference.steady_timer.changing_an_active_waitable_timer_s_expiry_time">Changing
435 an active waitable timer's expiry time</a>
438 Changing the expiry time of a timer while there are pending asynchronous
439 waits causes those wait operations to be cancelled. To ensure that the action
440 associated with the timer is performed only once, use something like this:
443 <pre class="programlisting"><span class="keyword">void</span> <span class="identifier">on_some_event</span><span class="special">()</span>
444 <span class="special">{</span>
445 <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>
446 <span class="special">{</span>
447 <span class="comment">// We managed to cancel the timer. Start new asynchronous wait.</span>
448 <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>
449 <span class="special">}</span>
450 <span class="keyword">else</span>
451 <span class="special">{</span>
452 <span class="comment">// Too late, timer has already expired!</span>
453 <span class="special">}</span>
454 <span class="special">}</span>
456 <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>
457 <span class="special">{</span>
458 <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>
459 <span class="special">{</span>
460 <span class="comment">// Timer was not cancelled, take necessary action.</span>
461 <span class="special">}</span>
462 <span class="special">}</span>
464 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
465 <li class="listitem">
466 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>
467 function cancels any pending asynchronous waits, and returns the number
468 of asynchronous waits that were cancelled. If it returns 0 then you were
469 too late and the wait handler has already been executed, or will soon
470 be executed. If it returns 1 then the wait handler was successfully cancelled.
472 <li class="listitem">
473 If a wait handler is cancelled, the boost::system::error_code passed
474 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>.
478 This typedef uses the C++11 <code class="computeroutput"><span class="special"><</span><span class="identifier">chrono</span><span class="special">></span></code>
479 standard library facility, if available. Otherwise, it may use the Boost.Chrono
480 library. To explicitly utilise Boost.Chrono, use 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> template directly:
482 <pre class="programlisting"><span class="keyword">typedef</span> <span class="identifier">basic_waitable_timer</span><span class="special"><</span><span class="identifier">boost</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">timer</span><span class="special">;</span>
485 <a name="boost_asio.reference.steady_timer.h8"></a>
486 <span class="phrase"><a name="boost_asio.reference.steady_timer.requirements"></a></span><a class="link" href="steady_timer.html#boost_asio.reference.steady_timer.requirements">Requirements</a>
489 <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/steady_timer.hpp</code>
492 <span class="emphasis"><em>Convenience header: </em></span>None
495 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
496 <td align="left"></td>
497 <td align="right"><div class="copyright-footer">Copyright © 2003-2014 Christopher M. Kohlhoff<p>
498 Distributed under the Boost Software License, Version 1.0. (See accompanying
499 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>)
504 <div class="spirit-nav">
505 <a accesskey="p" href="ssl__verify_peer.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="strand.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>