/usr/share/doc/libucommon-dev/a00169.html is in libucommon-doc 3.2.0-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>UCommon: ucc::Timer Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="a00214.html">ucc</a>::<a class="el" href="a00169.html">Timer</a>
</div>
</div>
<div class="contents">
<h1>ucc::Timer Class Reference</h1><!-- doxytag: class="ucc::Timer" -->
<p><a class="el" href="a00169.html" title="Timer class to use when scheduling realtime events.">Timer</a> class to use when scheduling realtime events.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00209_source.html">timers.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ucc::Timer:</div>
<div class="dynsection">
<div class="center"><img src="a00573.png" border="0" usemap="#ucc_1_1_timer_inherit__map" alt="Inheritance graph"/></div>
<map name="ucc_1_1_timer_inherit__map" id="ucc_1_1_timer_inherit__map">
<area shape="rect" id="node3" href="a00168.html" title="Event notification to manage scheduled realtime threads." alt="" coords="5,83,131,112"/><area shape="rect" id="node5" href="a00171.html" title="A timer event object that lives on a timer queue." alt="" coords="155,83,328,112"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0a623e697fc8f8b5bf2511a4785ba24a"></a><!-- doxytag: member="ucc::Timer::clear" ref="a0a623e697fc8f8b5bf2511a4785ba24a" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00169.html#a0a623e697fc8f8b5bf2511a4785ba24a">clear</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clear pending timer, has no value. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00169.html#a92aac4f410ee7fb503c67b059da00a00">get</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get remaining time until the timer expires. <a href="#a92aac4f410ee7fb503c67b059da00a00"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00169.html#a1a6034ffe4d6223bdc92585e2f7d971c">isExpired</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if timer expired. <a href="#a1a6034ffe4d6223bdc92585e2f7d971c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00169.html#a8336818211749b87244623f788386479">isUpdated</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if timer has been updated since last check. <a href="#a8336818211749b87244623f788386479"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00169.html#a93bcbd258afb58773a4d9cb36534c015">operator bool</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if timer expired for <a class="el" href="a00214.html#aa074f1a5a7f2741a51a01bc1607fb4a6" title="Convenience function to validate object assuming it is castable to bool.">is()</a> expression. <a href="#a93bcbd258afb58773a4d9cb36534c015"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00169.html#ad0c49ae13206f4ab42f64b6b94357622">operator!</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if timer has expired. <a href="#ad0c49ae13206f4ab42f64b6b94357622"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00169.html#a6df1d24a2502db2594decc3e5e6a7f31">operator!=</a> (const <a class="el" href="a00169.html">Timer</a> &timer)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compare timers if not same timeout. <a href="#a6df1d24a2502db2594decc3e5e6a7f31"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00169.html#a1dbe1af70e24331e747c5688bf0f9bfb">operator*</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get remaining time until timer expires by reference. <a href="#a1dbe1af70e24331e747c5688bf0f9bfb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00169.html">Timer</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00169.html#acd213dd93de8631e0bb11bb43d839c67">operator+=</a> (<a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> expire)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adjust timer expiration. <a href="#acd213dd93de8631e0bb11bb43d839c67"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00169.html">Timer</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00169.html#a54523b4af64480ad693d4e58a3b778d7">operator+=</a> (time_t expire)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adjust timer expiration. <a href="#a54523b4af64480ad693d4e58a3b778d7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00169.html#a3f08001dbc5195582d14dcc59aa0549d">operator-</a> (const <a class="el" href="a00169.html">Timer</a> &timer)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compute difference between two timers. <a href="#a3f08001dbc5195582d14dcc59aa0549d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00169.html">Timer</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00169.html#ae26d60e8db6d369486282d4aba180b8d">operator-=</a> (<a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> expire)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adjust timer expiration. <a href="#ae26d60e8db6d369486282d4aba180b8d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00169.html">Timer</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00169.html#aa3a445f70c342b1fbd31c68fb3912078">operator-=</a> (time_t expire)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adjust timer expiration. <a href="#aa3a445f70c342b1fbd31c68fb3912078"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00169.html#aac9cbd4b42ac789a57ae9b26652425c4">operator<</a> (const <a class="el" href="a00169.html">Timer</a> &timer)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compare timers if earlier timeout than another timer. <a href="#aac9cbd4b42ac789a57ae9b26652425c4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00169.html#a54d03d55bbefc8b2f4fd0b5699066f96">operator<=</a> (const <a class="el" href="a00169.html">Timer</a> &timer)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compare timers if earlier than or equal to another timer. <a href="#a54d03d55bbefc8b2f4fd0b5699066f96"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00169.html">Timer</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00169.html#aede28f1d5f8571b21f49e0c4e719b9e7">operator=</a> (<a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> expire)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set timer expiration. <a href="#aede28f1d5f8571b21f49e0c4e719b9e7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00169.html">Timer</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00169.html#a13850a90f213f4c8e0b82d0392f94cc6">operator=</a> (time_t expire)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set timer expiration. <a href="#a13850a90f213f4c8e0b82d0392f94cc6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00169.html#acc359ad90a5b938524affa26bbde0e4a">operator==</a> (const <a class="el" href="a00169.html">Timer</a> &timer)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compare timers if same timeout. <a href="#acc359ad90a5b938524affa26bbde0e4a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00169.html#ad59710001d86cdedfa4fab877441f647">operator></a> (const <a class="el" href="a00169.html">Timer</a> &timer)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compare timers if later timeout than another timer. <a href="#ad59710001d86cdedfa4fab877441f647"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00169.html#ab27ccf8012e78ee0eb739448c36832e3">operator>=</a> (const <a class="el" href="a00169.html">Timer</a> &timer)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compare timers if later than or equal to another timer. <a href="#ab27ccf8012e78ee0eb739448c36832e3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aee9397c39e9ade1ace03c3995befc243"></a><!-- doxytag: member="ucc::Timer::set" ref="aee9397c39e9ade1ace03c3995befc243" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00169.html#aee9397c39e9ade1ace03c3995befc243">set</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set (update) the timer with current time. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00169.html#a44514faa2f05bcf1f6a451d09be17673">set</a> (time_t expire)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the timer to expire. <a href="#a44514faa2f05bcf1f6a451d09be17673"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00169.html#aeb982dca6ac289ba8747ba5a8bf0c8a4">set</a> (<a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> expire)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the timer to expire. <a href="#aeb982dca6ac289ba8747ba5a8bf0c8a4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00169.html#a9031d1a9b0c039b471d630168ce528df">Timer</a> (const <a class="el" href="a00169.html">Timer</a> &copy)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a timer from a copy of another timer. <a href="#a9031d1a9b0c039b471d630168ce528df"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00169.html#a9b6f6e4ad887aea4083bcdf2c522237a">Timer</a> (time_t offset)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a triggered timer that expires at specified offset. <a href="#a9b6f6e4ad887aea4083bcdf2c522237a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00169.html#a1149c3ef00e012715e01e9d5fa76fb14">Timer</a> (<a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> offset)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a triggered timer that expires at specified offset. <a href="#a1149c3ef00e012715e01e9d5fa76fb14"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af65ede6b7e97e36e2f3a948165d1a586"></a><!-- doxytag: member="ucc::Timer::Timer" ref="af65ede6b7e97e36e2f3a948165d1a586" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="a00169.html#af65ede6b7e97e36e2f3a948165d1a586">Timer</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct an untriggered timer set to the time of creation. <br/></td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00169.html#ab9b8a28bd20bcc694f5a953fdfd73f39">sync</a> (<a class="el" href="a00169.html">Timer</a> &timer)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sleep current thread until the specified timer expires. <a href="#ab9b8a28bd20bcc694f5a953fdfd73f39"></a><br/></td></tr>
<tr><td colspan="2"><h2>Static Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa3783e1d579d343cf8e55f0f907d67b8"></a><!-- doxytag: member="ucc::Timer::inf" ref="aa3783e1d579d343cf8e55f0f907d67b8" args="" -->
static const <a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00169.html#aa3783e1d579d343cf8e55f0f907d67b8">inf</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A value to use for infinite time. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7f7566f8349b5ae271d35553f0d48ac1"></a><!-- doxytag: member="ucc::Timer::reset" ref="a7f7566f8349b5ae271d35553f0d48ac1" args="" -->
static const time_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00169.html#a7f7566f8349b5ae271d35553f0d48ac1">reset</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A value to use when resetting. <br/></td></tr>
<tr><td colspan="2"><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac10b6b46e90926acb75d89ddca608234"></a><!-- doxytag: member="ucc::Timer::Conditional" ref="ac10b6b46e90926acb75d89ddca608234" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>Conditional</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3c7b3c89bf96f51e80a919b3a82a3915"></a><!-- doxytag: member="ucc::Timer::Event" ref="a3c7b3c89bf96f51e80a919b3a82a3915" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>Event</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aebe70aacee812bed6d2510814cba9c8a"></a><!-- doxytag: member="ucc::Timer::Semaphore" ref="aebe70aacee812bed6d2510814cba9c8a" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>Semaphore</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p><a class="el" href="a00169.html" title="Timer class to use when scheduling realtime events.">Timer</a> class to use when scheduling realtime events. </p>
<p>The timer generally uses millisecond values but has a microsecond accuracy. On platforms that support it, the timer uses posix realtime monotonic clock extensions, otherwise lower accuracy timer systems might be used. </p>
<p>Definition at line <a class="el" href="a00209_source.html#l00049">49</a> of file <a class="el" href="a00209_source.html">timers.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a1149c3ef00e012715e01e9d5fa76fb14"></a><!-- doxytag: member="ucc::Timer::Timer" ref="a1149c3ef00e012715e01e9d5fa76fb14" args="(timeout_t offset)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucc::Timer::Timer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="paramname"> <em>offset</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Construct a triggered timer that expires at specified offset. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>offset</em> </td><td>to expire in milliseconds. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a9b6f6e4ad887aea4083bcdf2c522237a"></a><!-- doxytag: member="ucc::Timer::Timer" ref="a9b6f6e4ad887aea4083bcdf2c522237a" args="(time_t offset)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucc::Timer::Timer </td>
<td>(</td>
<td class="paramtype">time_t </td>
<td class="paramname"> <em>offset</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Construct a triggered timer that expires at specified offset. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>offset</em> </td><td>to expire in seconds. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a9031d1a9b0c039b471d630168ce528df"></a><!-- doxytag: member="ucc::Timer::Timer" ref="a9031d1a9b0c039b471d630168ce528df" args="(const Timer &copy)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucc::Timer::Timer </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00169.html">Timer</a> & </td>
<td class="paramname"> <em>copy</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Construct a timer from a copy of another timer. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>copy</em> </td><td>of timer to construct from. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a92aac4f410ee7fb503c67b059da00a00"></a><!-- doxytag: member="ucc::Timer::get" ref="a92aac4f410ee7fb503c67b059da00a00" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> ucc::Timer::get </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get remaining time until the timer expires. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 if expired or milliseconds still waiting. </dd></dl>
<p>Reimplemented in <a class="el" href="a00171.html#a053b5fa92f8c818b662880a998bb515d">ucc::TimerQueue::event</a>.</p>
</div>
</div>
<a class="anchor" id="a1a6034ffe4d6223bdc92585e2f7d971c"></a><!-- doxytag: member="ucc::Timer::isExpired" ref="a1a6034ffe4d6223bdc92585e2f7d971c" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ucc::Timer::isExpired </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Check if timer expired. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if expired. </dd></dl>
<p>Reimplemented in <a class="el" href="a00171.html#af159beceace1f1fa0b9cee679b4d4ea8">ucc::TimerQueue::event</a>.</p>
</div>
</div>
<a class="anchor" id="a8336818211749b87244623f788386479"></a><!-- doxytag: member="ucc::Timer::isUpdated" ref="a8336818211749b87244623f788386479" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ucc::Timer::isUpdated </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Check if timer has been updated since last check. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if updated. </dd></dl>
</div>
</div>
<a class="anchor" id="a93bcbd258afb58773a4d9cb36534c015"></a><!-- doxytag: member="ucc::Timer::operator bool" ref="a93bcbd258afb58773a4d9cb36534c015" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucc::Timer::operator bool </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Check if timer expired for <a class="el" href="a00214.html#aa074f1a5a7f2741a51a01bc1607fb4a6" title="Convenience function to validate object assuming it is castable to bool.">is()</a> expression. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if timer expired. </dd></dl>
</div>
</div>
<a class="anchor" id="ad0c49ae13206f4ab42f64b6b94357622"></a><!-- doxytag: member="ucc::Timer::operator!" ref="ad0c49ae13206f4ab42f64b6b94357622" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ucc::Timer::operator! </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Check if timer has expired. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if timer still pending. </dd></dl>
</div>
</div>
<a class="anchor" id="a6df1d24a2502db2594decc3e5e6a7f31"></a><!-- doxytag: member="ucc::Timer::operator!=" ref="a6df1d24a2502db2594decc3e5e6a7f31" args="(const Timer &timer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ucc::Timer::operator!= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00169.html">Timer</a> & </td>
<td class="paramname"> <em>timer</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Compare timers if not same timeout. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>timer</em> </td><td>to compare with. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if not same. </dd></dl>
</div>
</div>
<a class="anchor" id="a1dbe1af70e24331e747c5688bf0f9bfb"></a><!-- doxytag: member="ucc::Timer::operator*" ref="a1dbe1af70e24331e747c5688bf0f9bfb" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> ucc::Timer::operator* </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get remaining time until timer expires by reference. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 if expired or milliseconds still waiting. </dd></dl>
<p>Definition at line <a class="el" href="a00209_source.html#l00134">134</a> of file <a class="el" href="a00209_source.html">timers.h</a>.</p>
</div>
</div>
<a class="anchor" id="acd213dd93de8631e0bb11bb43d839c67"></a><!-- doxytag: member="ucc::Timer::operator+=" ref="acd213dd93de8631e0bb11bb43d839c67" args="(timeout_t expire)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00169.html">Timer</a>& ucc::Timer::operator+= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="paramname"> <em>expire</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Adjust timer expiration. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>expire</em> </td><td>time to add in milliseconds. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a54523b4af64480ad693d4e58a3b778d7"></a><!-- doxytag: member="ucc::Timer::operator+=" ref="a54523b4af64480ad693d4e58a3b778d7" args="(time_t expire)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00169.html">Timer</a>& ucc::Timer::operator+= </td>
<td>(</td>
<td class="paramtype">time_t </td>
<td class="paramname"> <em>expire</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Adjust timer expiration. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>expire</em> </td><td>time to add in seconds. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a3f08001dbc5195582d14dcc59aa0549d"></a><!-- doxytag: member="ucc::Timer::operator-" ref="a3f08001dbc5195582d14dcc59aa0549d" args="(const Timer &timer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> ucc::Timer::operator- </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00169.html">Timer</a> & </td>
<td class="paramname"> <em>timer</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Compute difference between two timers. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>timer</em> </td><td>to use for difference. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>difference in milliseconds. </dd></dl>
</div>
</div>
<a class="anchor" id="ae26d60e8db6d369486282d4aba180b8d"></a><!-- doxytag: member="ucc::Timer::operator-=" ref="ae26d60e8db6d369486282d4aba180b8d" args="(timeout_t expire)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00169.html">Timer</a>& ucc::Timer::operator-= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="paramname"> <em>expire</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Adjust timer expiration. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>expire</em> </td><td>time to subtract in milliseconds. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aa3a445f70c342b1fbd31c68fb3912078"></a><!-- doxytag: member="ucc::Timer::operator-=" ref="aa3a445f70c342b1fbd31c68fb3912078" args="(time_t expire)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00169.html">Timer</a>& ucc::Timer::operator-= </td>
<td>(</td>
<td class="paramtype">time_t </td>
<td class="paramname"> <em>expire</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Adjust timer expiration. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>expire</em> </td><td>time to subtract in seconds. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aac9cbd4b42ac789a57ae9b26652425c4"></a><!-- doxytag: member="ucc::Timer::operator<" ref="aac9cbd4b42ac789a57ae9b26652425c4" args="(const Timer &timer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ucc::Timer::operator< </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00169.html">Timer</a> & </td>
<td class="paramname"> <em>timer</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Compare timers if earlier timeout than another timer. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>timer</em> </td><td>to compare with. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if earlier. </dd></dl>
</div>
</div>
<a class="anchor" id="a54d03d55bbefc8b2f4fd0b5699066f96"></a><!-- doxytag: member="ucc::Timer::operator<=" ref="a54d03d55bbefc8b2f4fd0b5699066f96" args="(const Timer &timer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ucc::Timer::operator<= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00169.html">Timer</a> & </td>
<td class="paramname"> <em>timer</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Compare timers if earlier than or equal to another timer. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>timer</em> </td><td>to compare with. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if earlier or same. </dd></dl>
</div>
</div>
<a class="anchor" id="aede28f1d5f8571b21f49e0c4e719b9e7"></a><!-- doxytag: member="ucc::Timer::operator=" ref="aede28f1d5f8571b21f49e0c4e719b9e7" args="(timeout_t expire)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00169.html">Timer</a>& ucc::Timer::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="paramname"> <em>expire</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set timer expiration. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>expire</em> </td><td>timer in milliseconds. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a13850a90f213f4c8e0b82d0392f94cc6"></a><!-- doxytag: member="ucc::Timer::operator=" ref="a13850a90f213f4c8e0b82d0392f94cc6" args="(time_t expire)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00169.html">Timer</a>& ucc::Timer::operator= </td>
<td>(</td>
<td class="paramtype">time_t </td>
<td class="paramname"> <em>expire</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set timer expiration. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>expire</em> </td><td>timer in specified seconds. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="acc359ad90a5b938524affa26bbde0e4a"></a><!-- doxytag: member="ucc::Timer::operator==" ref="acc359ad90a5b938524affa26bbde0e4a" args="(const Timer &timer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ucc::Timer::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00169.html">Timer</a> & </td>
<td class="paramname"> <em>timer</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Compare timers if same timeout. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>timer</em> </td><td>to compare with. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if same. </dd></dl>
</div>
</div>
<a class="anchor" id="ad59710001d86cdedfa4fab877441f647"></a><!-- doxytag: member="ucc::Timer::operator>" ref="ad59710001d86cdedfa4fab877441f647" args="(const Timer &timer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ucc::Timer::operator> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00169.html">Timer</a> & </td>
<td class="paramname"> <em>timer</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Compare timers if later timeout than another timer. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>timer</em> </td><td>to compare with. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if later. </dd></dl>
</div>
</div>
<a class="anchor" id="ab27ccf8012e78ee0eb739448c36832e3"></a><!-- doxytag: member="ucc::Timer::operator>=" ref="ab27ccf8012e78ee0eb739448c36832e3" args="(const Timer &timer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ucc::Timer::operator>= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00169.html">Timer</a> & </td>
<td class="paramname"> <em>timer</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Compare timers if later than or equal to another timer. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>timer</em> </td><td>to compare with. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if later or same. </dd></dl>
</div>
</div>
<a class="anchor" id="a44514faa2f05bcf1f6a451d09be17673"></a><!-- doxytag: member="ucc::Timer::set" ref="a44514faa2f05bcf1f6a451d09be17673" args="(time_t expire)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucc::Timer::set </td>
<td>(</td>
<td class="paramtype">time_t </td>
<td class="paramname"> <em>expire</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the timer to expire. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>expire</em> </td><td>time in seconds. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aeb982dca6ac289ba8747ba5a8bf0c8a4"></a><!-- doxytag: member="ucc::Timer::set" ref="aeb982dca6ac289ba8747ba5a8bf0c8a4" args="(timeout_t expire)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucc::Timer::set </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="paramname"> <em>expire</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the timer to expire. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>expire</em> </td><td>time in milliseconds. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ab9b8a28bd20bcc694f5a953fdfd73f39"></a><!-- doxytag: member="ucc::Timer::sync" ref="ab9b8a28bd20bcc694f5a953fdfd73f39" args="(Timer &timer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void ucc::Timer::sync </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00169.html">Timer</a> & </td>
<td class="paramname"> <em>timer</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sleep current thread until the specified timer expires. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>timer</em> </td><td>to reference for sleep. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ucommon/<a class="el" href="a00209_source.html">timers.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Tue Jul 6 08:22:52 2010 for UCommon by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
|