Imported Upstream version 1.57.0
[platform/upstream/boost.git] / doc / html / boost_asio / reference / steady_timer.html
1 <html>
2 <head>
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">
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="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>
24 </div>
25 <div class="section">
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>
29 <p>
30         <a class="indexterm" name="idp197826176"></a> 
31 Typedef for a timer based on the steady clock.
32       </p>
33 <pre class="programlisting"><span class="keyword">typedef</span> <span class="identifier">basic_waitable_timer</span><span class="special">&lt;</span> <span class="identifier">chrono</span><span class="special">::</span><span class="identifier">steady_clock</span> <span class="special">&gt;</span> <span class="identifier">steady_timer</span><span class="special">;</span>
34 </pre>
35 <h5>
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>
38       </h5>
39 <div class="informaltable"><table class="table">
40 <colgroup>
41 <col>
42 <col>
43 </colgroup>
44 <thead><tr>
45 <th>
46                 <p>
47                   Name
48                 </p>
49               </th>
50 <th>
51                 <p>
52                   Description
53                 </p>
54               </th>
55 </tr></thead>
56 <tbody>
57 <tr>
58 <td>
59                 <p>
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>
61                 </p>
62               </td>
63 <td>
64                 <p>
65                   The clock type.
66                 </p>
67               </td>
68 </tr>
69 <tr>
70 <td>
71                 <p>
72                   <a class="link" href="basic_waitable_timer/duration.html" title="basic_waitable_timer::duration"><span class="bold"><strong>duration</strong></span></a>
73                 </p>
74               </td>
75 <td>
76                 <p>
77                   The duration type of the clock.
78                 </p>
79               </td>
80 </tr>
81 <tr>
82 <td>
83                 <p>
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>
85                 </p>
86               </td>
87 <td>
88                 <p>
89                   The underlying implementation type of I/O object.
90                 </p>
91               </td>
92 </tr>
93 <tr>
94 <td>
95                 <p>
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>
97                 </p>
98               </td>
99 <td>
100                 <p>
101                   The type of the service that will be used to provide I/O operations.
102                 </p>
103               </td>
104 </tr>
105 <tr>
106 <td>
107                 <p>
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>
109                 </p>
110               </td>
111 <td>
112                 <p>
113                   The time point type of the clock.
114                 </p>
115               </td>
116 </tr>
117 <tr>
118 <td>
119                 <p>
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>
121                 </p>
122               </td>
123 <td>
124                 <p>
125                   The wait traits type.
126                 </p>
127               </td>
128 </tr>
129 </tbody>
130 </table></div>
131 <h5>
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
134         Functions</a>
135       </h5>
136 <div class="informaltable"><table class="table">
137 <colgroup>
138 <col>
139 <col>
140 </colgroup>
141 <thead><tr>
142 <th>
143                 <p>
144                   Name
145                 </p>
146               </th>
147 <th>
148                 <p>
149                   Description
150                 </p>
151               </th>
152 </tr></thead>
153 <tbody>
154 <tr>
155 <td>
156                 <p>
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>
158                 </p>
159               </td>
160 <td>
161                 <p>
162                   Start an asynchronous wait on the timer.
163                 </p>
164               </td>
165 </tr>
166 <tr>
167 <td>
168                 <p>
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>
170                 </p>
171               </td>
172 <td>
173                 <p>
174                   Constructor.
175                 </p>
176                 <p>
177                   Constructor to set a particular expiry time as an absolute time.
178                 </p>
179                 <p>
180                   Constructor to set a particular expiry time relative to now.
181                 </p>
182               </td>
183 </tr>
184 <tr>
185 <td>
186                 <p>
187                   <a class="link" href="basic_waitable_timer/cancel.html" title="basic_waitable_timer::cancel"><span class="bold"><strong>cancel</strong></span></a>
188                 </p>
189               </td>
190 <td>
191                 <p>
192                   Cancel any asynchronous operations that are waiting on the timer.
193                 </p>
194               </td>
195 </tr>
196 <tr>
197 <td>
198                 <p>
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>
200                 </p>
201               </td>
202 <td>
203                 <p>
204                   Cancels one asynchronous operation that is waiting on the timer.
205                 </p>
206               </td>
207 </tr>
208 <tr>
209 <td>
210                 <p>
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>
212                 </p>
213               </td>
214 <td>
215                 <p>
216                   Get the timer's expiry time as an absolute time.
217                 </p>
218                 <p>
219                   Set the timer's expiry time as an absolute time.
220                 </p>
221               </td>
222 </tr>
223 <tr>
224 <td>
225                 <p>
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>
227                 </p>
228               </td>
229 <td>
230                 <p>
231                   Get the timer's expiry time relative to now.
232                 </p>
233                 <p>
234                   Set the timer's expiry time relative to now.
235                 </p>
236               </td>
237 </tr>
238 <tr>
239 <td>
240                 <p>
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>
242                 </p>
243               </td>
244 <td>
245                 <p>
246                   Get the io_service associated with the object.
247                 </p>
248               </td>
249 </tr>
250 <tr>
251 <td>
252                 <p>
253                   <a class="link" href="basic_waitable_timer/wait.html" title="basic_waitable_timer::wait"><span class="bold"><strong>wait</strong></span></a>
254                 </p>
255               </td>
256 <td>
257                 <p>
258                   Perform a blocking wait on the timer.
259                 </p>
260               </td>
261 </tr>
262 </tbody>
263 </table></div>
264 <h5>
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
267         Member Functions</a>
268       </h5>
269 <div class="informaltable"><table class="table">
270 <colgroup>
271 <col>
272 <col>
273 </colgroup>
274 <thead><tr>
275 <th>
276                 <p>
277                   Name
278                 </p>
279               </th>
280 <th>
281                 <p>
282                   Description
283                 </p>
284               </th>
285 </tr></thead>
286 <tbody>
287 <tr>
288 <td>
289                 <p>
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>
291                 </p>
292               </td>
293 <td>
294                 <p>
295                   Get the underlying implementation of the I/O object.
296                 </p>
297               </td>
298 </tr>
299 <tr>
300 <td>
301                 <p>
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>
303                 </p>
304               </td>
305 <td>
306                 <p>
307                   Get the service associated with the I/O object.
308                 </p>
309               </td>
310 </tr>
311 </tbody>
312 </table></div>
313 <h5>
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
316         Data Members</a>
317       </h5>
318 <div class="informaltable"><table class="table">
319 <colgroup>
320 <col>
321 <col>
322 </colgroup>
323 <thead><tr>
324 <th>
325                 <p>
326                   Name
327                 </p>
328               </th>
329 <th>
330                 <p>
331                   Description
332                 </p>
333               </th>
334 </tr></thead>
335 <tbody>
336 <tr>
337 <td>
338                 <p>
339                   <a class="link" href="basic_waitable_timer/implementation.html" title="basic_waitable_timer::implementation"><span class="bold"><strong>implementation</strong></span></a>
340                 </p>
341               </td>
342 <td>
343                 <p>
344                   (Deprecated: Use get_implementation().) The underlying implementation
345                   of the I/O object.
346                 </p>
347               </td>
348 </tr>
349 <tr>
350 <td>
351                 <p>
352                   <a class="link" href="basic_waitable_timer/service.html" title="basic_waitable_timer::service"><span class="bold"><strong>service</strong></span></a>
353                 </p>
354               </td>
355 <td>
356                 <p>
357                   (Deprecated: Use get_service().) The service associated with the
358                   I/O object.
359                 </p>
360               </td>
361 </tr>
362 </tbody>
363 </table></div>
364 <p>
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
367         to expire.
368       </p>
369 <p>
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.
373       </p>
374 <p>
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.
376       </p>
377 <h5>
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>
380       </h5>
381 <p>
382         This waitable timer functionality is for use with the C++11 standard library's
383         <code class="computeroutput"><span class="special">&lt;</span><span class="identifier">chrono</span><span class="special">&gt;</span></code> facility, or with the Boost.Chrono library.
384       </p>
385 <h5>
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
388         Safety</a>
389       </h5>
390 <p>
391         <span class="emphasis"><em>Distinct</em></span> <span class="emphasis"><em>objects:</em></span> Safe.
392       </p>
393 <p>
394         <span class="emphasis"><em>Shared</em></span> <span class="emphasis"><em>objects:</em></span> Unsafe.
395       </p>
396 <h5>
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>
399       </h5>
400 <p>
401         Performing a blocking wait (C++11):
402       </p>
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>
405
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>
408
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>
411 </pre>
412 <p>
413         Performing an asynchronous wait (C++11):
414       </p>
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">&amp;</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>
422
423 <span class="special">...</span>
424
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>
428
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>
431 </pre>
432 <h5>
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>
436       </h5>
437 <p>
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:
441         used:
442       </p>
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">&gt;</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>
455
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">&amp;</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>
463 </pre>
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.
471           </li>
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>.
475           </li>
476 </ul></div>
477 <p>
478         This typedef uses the C++11 <code class="computeroutput"><span class="special">&lt;</span><span class="identifier">chrono</span><span class="special">&gt;</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:
481       </p>
482 <pre class="programlisting"><span class="keyword">typedef</span> <span class="identifier">basic_waitable_timer</span><span class="special">&lt;</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">&gt;</span> <span class="identifier">timer</span><span class="special">;</span>
483 </pre>
484 <h5>
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>
487       </h5>
488 <p>
489         <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/steady_timer.hpp</code>
490       </p>
491 <p>
492         <span class="emphasis"><em>Convenience header: </em></span>None
493       </p>
494 </div>
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 &#169; 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>)
500       </p>
501 </div></td>
502 </tr></table>
503 <hr>
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>
506 </div>
507 </body>
508 </html>