high_resolution_timer.html
17.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>high_resolution_timer</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../index.html" title="Asio">
<link rel="up" href="../reference.html" title="Reference">
<link rel="prev" href="get_associated_executor/overload3.html" title="get_associated_executor (3 of 3 overloads)">
<link rel="next" href="invalid_service_owner.html" title="invalid_service_owner">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="get_associated_executor/overload3.html"><img src="../../prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../home.png" alt="Home"></a><a accesskey="n" href="invalid_service_owner.html"><img src="../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="asio.reference.high_resolution_timer"></a><a class="link" href="high_resolution_timer.html" title="high_resolution_timer">high_resolution_timer</a>
</h3></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.high_resolution_timer"></a>
Typedef for a timer
based on the high resolution clock.
</p>
<pre class="programlisting">typedef basic_waitable_timer< chrono::high_resolution_clock > high_resolution_timer;
</pre>
<h5>
<a name="asio.reference.high_resolution_timer.h0"></a>
<span><a name="asio.reference.high_resolution_timer.types"></a></span><a class="link" href="high_resolution_timer.html#asio.reference.high_resolution_timer.types">Types</a>
</h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<a class="link" href="basic_waitable_timer__rebind_executor.html" title="basic_waitable_timer::rebind_executor"><span class="bold"><strong>rebind_executor</strong></span></a>
</p>
</td>
<td>
<p>
Rebinds the timer type to another executor.
</p>
</td>
</tr>
<tr>
<td>
<p>
<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>
</p>
</td>
<td>
<p>
The clock type.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="basic_waitable_timer/duration.html" title="basic_waitable_timer::duration"><span class="bold"><strong>duration</strong></span></a>
</p>
</td>
<td>
<p>
The duration type of the clock.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="basic_waitable_timer/executor_type.html" title="basic_waitable_timer::executor_type"><span class="bold"><strong>executor_type</strong></span></a>
</p>
</td>
<td>
<p>
The type of the executor associated with the object.
</p>
</td>
</tr>
<tr>
<td>
<p>
<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>
</p>
</td>
<td>
<p>
The time point type of the clock.
</p>
</td>
</tr>
<tr>
<td>
<p>
<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>
</p>
</td>
<td>
<p>
The wait traits type.
</p>
</td>
</tr>
</tbody>
</table></div>
<h5>
<a name="asio.reference.high_resolution_timer.h1"></a>
<span><a name="asio.reference.high_resolution_timer.member_functions"></a></span><a class="link" href="high_resolution_timer.html#asio.reference.high_resolution_timer.member_functions">Member Functions</a>
</h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<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>
</p>
</td>
<td>
<p>
Start an asynchronous wait on the timer.
</p>
</td>
</tr>
<tr>
<td>
<p>
<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> <span class="silver">[constructor]</span>
</p>
</td>
<td>
<p>
Constructor. <br> <span class="silver"> —</span><br> Constructor to set a particular expiry
time as an absolute time. <br> <span class="silver"> —</span><br> Constructor to set a particular
expiry time relative to now. <br> <span class="silver"> —</span><br> Move-construct a basic_waitable_timer
from another.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="basic_waitable_timer/cancel.html" title="basic_waitable_timer::cancel"><span class="bold"><strong>cancel</strong></span></a>
</p>
</td>
<td>
<p>
Cancel any asynchronous operations that are waiting on the timer.
<br> <span class="silver"> —</span><br> (Deprecated: Use non-error_code overload.) Cancel
any asynchronous operations that are waiting on the timer.
</p>
</td>
</tr>
<tr>
<td>
<p>
<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>
</p>
</td>
<td>
<p>
Cancels one asynchronous operation that is waiting on the timer.
<br> <span class="silver"> —</span><br> (Deprecated: Use non-error_code overload.) Cancels
one asynchronous operation that is waiting on the timer.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="basic_waitable_timer/expires_after.html" title="basic_waitable_timer::expires_after"><span class="bold"><strong>expires_after</strong></span></a>
</p>
</td>
<td>
<p>
Set the timer's expiry time relative to now.
</p>
</td>
</tr>
<tr>
<td>
<p>
<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>
</p>
</td>
<td>
<p>
(Deprecated: Use expiry().) Get the timer's expiry time as an absolute
time. <br> <span class="silver"> —</span><br> Set the timer's expiry time as an absolute
time. <br> <span class="silver"> —</span><br> (Deprecated: Use non-error_code overload.)
Set the timer's expiry time as an absolute time.
</p>
</td>
</tr>
<tr>
<td>
<p>
<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>
</p>
</td>
<td>
<p>
(Deprecated: Use expiry().) Get the timer's expiry time relative
to now. <br> <span class="silver"> —</span><br> (Deprecated: Use expires_after().) Set the
timer's expiry time relative to now.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="basic_waitable_timer/expiry.html" title="basic_waitable_timer::expiry"><span class="bold"><strong>expiry</strong></span></a>
</p>
</td>
<td>
<p>
Get the timer's expiry time as an absolute time.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="basic_waitable_timer/get_executor.html" title="basic_waitable_timer::get_executor"><span class="bold"><strong>get_executor</strong></span></a>
</p>
</td>
<td>
<p>
Get the executor associated with the object.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="basic_waitable_timer/operator_eq_.html" title="basic_waitable_timer::operator="><span class="bold"><strong>operator=</strong></span></a>
</p>
</td>
<td>
<p>
Move-assign a basic_waitable_timer from another.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="basic_waitable_timer/wait.html" title="basic_waitable_timer::wait"><span class="bold"><strong>wait</strong></span></a>
</p>
</td>
<td>
<p>
Perform a blocking wait on the timer.
</p>
</td>
</tr>
<tr>
<td>
<p>
<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> <span class="silver">[destructor]</span>
</p>
</td>
<td>
<p>
Destroys the timer.
</p>
</td>
</tr>
</tbody>
</table></div>
<p>
The <a class="link" href="basic_waitable_timer.html" title="basic_waitable_timer"><code class="computeroutput">basic_waitable_timer</code></a>
class template provides the ability to perform a blocking or asynchronous
wait for a timer to expire.
</p>
<p>
A waitable timer is always in one of two states: "expired" or "not
expired". If the <code class="computeroutput">wait()</code> or <code class="computeroutput">async_wait()</code> function
is called on an expired timer, the wait operation will complete immediately.
</p>
<p>
Most applications will use one of the <a class="link" href="steady_timer.html" title="steady_timer"><code class="computeroutput">steady_timer</code></a>,
<a class="link" href="system_timer.html" title="system_timer"><code class="computeroutput">system_timer</code></a>
or <a class="link" href="high_resolution_timer.html" title="high_resolution_timer"><code class="computeroutput">high_resolution_timer</code></a>
typedefs.
</p>
<h5>
<a name="asio.reference.high_resolution_timer.h2"></a>
<span><a name="asio.reference.high_resolution_timer.remarks"></a></span><a class="link" href="high_resolution_timer.html#asio.reference.high_resolution_timer.remarks">Remarks</a>
</h5>
<p>
This waitable timer functionality is for use with the C++11 standard library's
<code class="computeroutput"><chrono></code> facility, or with the Boost.Chrono library.
</p>
<h5>
<a name="asio.reference.high_resolution_timer.h3"></a>
<span><a name="asio.reference.high_resolution_timer.thread_safety"></a></span><a class="link" href="high_resolution_timer.html#asio.reference.high_resolution_timer.thread_safety">Thread
Safety</a>
</h5>
<p>
<span class="emphasis"><em>Distinct</em></span> <span class="emphasis"><em>objects:</em></span> Safe.
</p>
<p>
<span class="emphasis"><em>Shared</em></span> <span class="emphasis"><em>objects:</em></span> Unsafe.
</p>
<h5>
<a name="asio.reference.high_resolution_timer.h4"></a>
<span><a name="asio.reference.high_resolution_timer.examples"></a></span><a class="link" href="high_resolution_timer.html#asio.reference.high_resolution_timer.examples">Examples</a>
</h5>
<p>
Performing a blocking wait (C++11):
</p>
<pre class="programlisting">// Construct a timer without setting an expiry time.
asio::steady_timer timer(my_context);
// Set an expiry time relative to now.
timer.expires_after(std::chrono::seconds(5));
// Wait for the timer to expire.
timer.wait();
</pre>
<p>
Performing an asynchronous wait (C++11):
</p>
<pre class="programlisting">void handler(const asio::error_code& error)
{
if (!error)
{
// Timer expired.
}
}
...
// Construct a timer with an absolute expiry time.
asio::steady_timer timer(my_context,
std::chrono::steady_clock::now() + std::chrono::seconds(60));
// Start an asynchronous wait.
timer.async_wait(handler);
</pre>
<h5>
<a name="asio.reference.high_resolution_timer.h5"></a>
<span><a name="asio.reference.high_resolution_timer.changing_an_active_waitable_timer_s_expiry_time"></a></span><a class="link" href="high_resolution_timer.html#asio.reference.high_resolution_timer.changing_an_active_waitable_timer_s_expiry_time">Changing
an active waitable timer's expiry time</a>
</h5>
<p>
Changing the expiry time of a timer while there are pending asynchronous
waits causes those wait operations to be cancelled. To ensure that the action
associated with the timer is performed only once, use something like this:
used:
</p>
<pre class="programlisting">void on_some_event()
{
if (my_timer.expires_after(seconds(5)) > 0)
{
// We managed to cancel the timer. Start new asynchronous wait.
my_timer.async_wait(on_timeout);
}
else
{
// Too late, timer has already expired!
}
}
void on_timeout(const asio::error_code& e)
{
if (e != asio::error::operation_aborted)
{
// Timer was not cancelled, take necessary action.
}
}
</pre>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
The <code class="computeroutput">asio::basic_waitable_timer::expires_after()</code> function
cancels any pending asynchronous waits, and returns the number of asynchronous
waits that were cancelled. If it returns 0 then you were too late and
the wait handler has already been executed, or will soon be executed.
If it returns 1 then the wait handler was successfully cancelled.
</li>
<li class="listitem">
If a wait handler is cancelled, the <a class="link" href="error_code.html" title="error_code"><code class="computeroutput">error_code</code></a>
passed to it contains the value <code class="computeroutput">asio::error::operation_aborted</code>.
</li>
</ul></div>
<p>
This typedef uses the C++11 <code class="computeroutput"><chrono></code> standard library
facility, if available. Otherwise, it may use the Boost.Chrono library. To
explicitly utilise Boost.Chrono, use the <a class="link" href="basic_waitable_timer.html" title="basic_waitable_timer"><code class="computeroutput">basic_waitable_timer</code></a>
template directly:
</p>
<pre class="programlisting">typedef basic_waitable_timer<boost::chrono::high_resolution_clock> timer;
</pre>
<h5>
<a name="asio.reference.high_resolution_timer.h6"></a>
<span><a name="asio.reference.high_resolution_timer.requirements"></a></span><a class="link" href="high_resolution_timer.html#asio.reference.high_resolution_timer.requirements">Requirements</a>
</h5>
<p>
<span class="emphasis"><em>Header: </em></span><code class="literal">asio/high_resolution_timer.hpp</code>
</p>
<p>
<span class="emphasis"><em>Convenience header: </em></span><code class="literal">asio.hpp</code>
</p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M.
Kohlhoff<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
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>)
</p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="get_associated_executor/overload3.html"><img src="../../prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../home.png" alt="Home"></a><a accesskey="n" href="invalid_service_owner.html"><img src="../../next.png" alt="Next"></a>
</div>
</body>
</html>