1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml"> 3 <head> 4 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 5 <meta http-equiv="Content-Style-Type" content="text/css" /> 6 <link rel="stylesheet" href="../../../css/manpage.css" type="text/css" /> 7 <style type="text/css"><!-- 8 span.static_style 9 { 10 font-size : 8pt; 11 color : white; 12 font-weight : bold; 13 background : #44f; 14 border-left : solid 1px #aaf; 15 border-top : solid 1px #aaf; 16 border-right : solid 1px #00c; 17 border-bottom : solid 1px #00c; 18 padding-left : 2px; 19 padding-right : 2px; 20 } 21 22 span.virtual_style 23 { 24 font-size : 8pt; 25 color : white; 26 font-weight : bold; 27 background : #0a0; 28 border-left : solid 1px #0f0; 29 border-top : solid 1px #0f0; 30 border-right : solid 1px #060; 31 border-bottom : solid 1px #060; 32 padding-left : 2px; 33 padding-right : 2px; 34 } 35 36 span.protected_style 37 { 38 font-size : 8pt; 39 color : white; 40 font-weight : bold; 41 background : #444; 42 border-left : solid 1px #ccc; 43 border-top : solid 1px #ccc; 44 border-right : solid 1px #222; 45 border-bottom : solid 1px #222; 46 padding-left : 2px; 47 padding-right : 2px; 48 } 49 --></style> 50<title>nn::os::Timer</title> 51 </head> 52 <body> 53<h1><CODE>nn::os::Timer</CODE> Class</h1> 54<h2>Syntax</h2> 55 <div class="section"> 56 <pre class="definition">class Timer : public <a href="../../../nn/os/WaitObject/Overview.html">nn::os::WaitObject</a></pre> 57 </div> 58<h2>Description</h2> 59 <div class="section"> 60<p>Class for representing timers.</p><p>Timers, like <a href="../../../nn/os/Event/Overview.html">events</a>, have two possible states: signaled and non-signaled. The <CODE>Wait</CODE> operation for a <CODE><a href="../../../nn/os/Timer/Overview.html">Timer</a></CODE> waits until the event enters the signaled state.</p><p>There are two types of timers: those that are manually reset and those that are automatically reset. This characteristic can be configured by parameters during initialization. See the documentation for the <CODE><a href="../../../nn/os/Event/Overview.html">Event</a></CODE> class for more details about the differences.</p><p>Timers do not enter the signaled state immediately. They do so only after after the <CODE><a href="../../../nn/os/Timer/StartOneShot.html">StartOneShot</a></CODE> function is called and the specified timespan elapses.</p><p>Alternately, by calling <CODE><a href="../../../nn/os/Timer/StartPeriodic.html">StartPeriodic</a></CODE> you can make them enter the signaled state on a periodic basis.</p><!-- write here --></div> 61 <a name="function" id="function"> 62<h2>Member Functions</h2> 63 <div class="section"> 64 <table class="members"> 65 <tr> 66 <td width="100"> </td> 67 <th> 68<a href="../../../nn/os/Timer/Timer.html"><CODE>Timer</CODE></a> 69 </th> 70<td>Timer initialization.</td> 71 </tr> 72 <tr> 73 <td width="100"> </td> 74 <th> 75<a href="../../../nn/os/Timer/Initialize.html"><CODE>Initialize</CODE></a> 76 </th> 77<td>Timer initialization.</td> 78 </tr> 79 <tr> 80 <td width="100"> </td> 81 <th> 82<a href="../../../nn/os/Timer/TryInitialize.html"><CODE>TryInitialize</CODE></a> 83 </th> 84<td>Tries to initialize a timer.</td> 85 </tr> 86 <tr> 87 <td width="100"> </td> 88 <th> 89<a href="../../../nn/os/Timer/Finalize.html"><CODE>Finalize</CODE></a> 90 </th> 91<td>Destroys a timer.</td> 92 </tr> 93 <tr> 94 <td width="100"> </td> 95 <th> 96<a href="../../../nn/os/Timer/~Timer.html"><CODE>~Timer</CODE></a> 97 </th> 98<td>Destructor.</td> 99 </tr> 100 <tr> 101 <td width="100"> </td> 102 <th> 103<a href="../../../nn/os/Timer/StartOneShot.html"><CODE>StartOneShot</CODE></a> 104 </th> 105<td>Starts a timer.</td> 106 </tr> 107 <tr> 108 <td width="100"> </td> 109 <th> 110<a href="../../../nn/os/Timer/StartPeriodic.html"><CODE>StartPeriodic</CODE></a> 111 </th> 112<td>Starts a timer.</td> 113 </tr> 114 <tr> 115 <td width="100"> </td> 116 <th> 117<a href="../../../nn/os/Timer/Signal.html"><CODE>Signal</CODE></a> 118 </th> 119<td>Sets a timer to the signaled state immediately.</td> 120 </tr> 121 <tr> 122 <td width="100"> </td> 123 <th> 124<a href="../../../nn/os/Timer/Wait.html"><CODE>Wait</CODE></a> 125 </th> 126<td>Waits until a timer notification.</td> 127 </tr> 128 <tr> 129 <td width="100"> </td> 130 <th> 131<a href="../../../nn/os/Timer/Stop.html"><CODE>Stop</CODE></a> 132 </th> 133<td>Stops a timer that has been started.</td> 134 </tr> 135 <tr> 136 <td width="100"> </td> 137 <th> 138<a href="../../../nn/os/Timer/ClearSignal.html"><CODE>ClearSignal</CODE></a> 139 </th> 140<td>Clears a timer.</td> 141 </tr> </table> 142 </div> 143 </a> 144<h2>Class Hierarchy</h2> 145 <div class="section"> 146<p class="hierarchy"><span>ADLFireWall::NonCopyable</span><br /> <a href="../../../nn/os/HandleObject/Overview.html">nn::os::HandleObject</a><br /> <a href="../../../nn/os/WaitObject/Overview.html">nn::os::WaitObject</a><br /> <b>nn::os::Timer</b> 147 </p> 148 </div> 149<h2>Revision History</h2> 150 <div class="section"> 151 <dl class="history"> 152 <dt>2010/01/07</dt> 153<dd>Initial version.<br /> 154 </dd> 155 </dl> 156 </div> 157 <hr><p>CONFIDENTIAL</p></body> 158</html>