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 span.virtual_style 22 { 23 font-size : 8pt; 24 color : white; 25 font-weight : bold; 26 background : #0a0; 27 border-left : solid 1px #0f0; 28 border-top : solid 1px #0f0; 29 border-right : solid 1px #060; 30 border-bottom : solid 1px #060; 31 padding-left : 2px; 32 padding-right : 2px; 33 } 34 span.protected_style 35 { 36 font-size : 8pt; 37 color : white; 38 font-weight : bold; 39 background : #444; 40 border-left : solid 1px #ccc; 41 border-top : solid 1px #ccc; 42 border-right : solid 1px #222; 43 border-bottom : solid 1px #222; 44 padding-left : 2px; 45 padding-right : 2px; 46 } 47 --></style> 48<title>nn::os::Timer</title> 49 </head> 50 <body> 51<h1><CODE>nn::os::Timer</CODE> Class</h1> 52<h2>Syntax</h2> 53 <div class="section"> 54 <pre class="definition">class Timer : public <a href="../../../nn/os/WaitObject/Overview.html">nn::os::WaitObject</a></pre> 55 </div> 56<h2>Description</h2> 57 <div class="section"> 58<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><p>You can create up to 8 <a href="../../../nn/os/Timer/Overview.html"><CODE>Timer</CODE></a> objects. Note also that different functions might use up resources that count against this limit.</p><!-- write here --></div> 59 <a name="function" id="function"> 60<h2>Member Functions</h2> 61 <div class="section"> 62 <table class="members"> 63 <tr> 64 <td width="100"> </td> 65 <th> 66<a href="../../../nn/os/Timer/Timer.html"><CODE>Timer</CODE></a> 67 </th> 68<td>Timer initialization.</td> 69 </tr> 70 <tr> 71 <td width="100"> </td> 72 <th> 73<a href="../../../nn/os/Timer/Initialize.html"><CODE>Initialize</CODE></a> 74 </th> 75<td>Timer initialization.</td> 76 </tr> 77 <tr> 78 <td width="100"> </td> 79 <th> 80<a href="../../../nn/os/Timer/TryInitialize.html"><CODE>TryInitialize</CODE></a> 81 </th> 82<td>Tries to initialize a timer.</td> 83 </tr> 84 <tr> 85 <td width="100"> </td> 86 <th> 87<a href="../../../nn/os/Timer/Finalize.html"><CODE>Finalize</CODE></a> 88 </th> 89<td>Destroys a timer.</td> 90 </tr> 91 <tr> 92 <td width="100"> </td> 93 <th> 94<a href="../../../nn/os/Timer/~Timer.html"><CODE>~Timer</CODE></a> 95 </th> 96<td>Destructor.</td> 97 </tr> 98 <tr> 99 <td width="100"> </td> 100 <th> 101<a href="../../../nn/os/Timer/StartOneShot.html"><CODE>StartOneShot</CODE></a> 102 </th> 103<td>Starts a timer.</td> 104 </tr> 105 <tr> 106 <td width="100"> </td> 107 <th> 108<a href="../../../nn/os/Timer/StartPeriodic.html"><CODE>StartPeriodic</CODE></a> 109 </th> 110<td>Starts a timer.</td> 111 </tr> 112 <tr> 113 <td width="100"> </td> 114 <th> 115<a href="../../../nn/os/Timer/Signal.html"><CODE>Signal</CODE></a> 116 </th> 117<td>Sets a timer to the signaled state immediately.</td> 118 </tr> 119 <tr> 120 <td width="100"> </td> 121 <th> 122<a href="../../../nn/os/Timer/Wait.html"><CODE>Wait</CODE></a> 123 </th> 124<td>Waits until a timer notification.</td> 125 </tr> 126 <tr> 127 <td width="100"> </td> 128 <th> 129<a href="../../../nn/os/Timer/Stop.html"><CODE>Stop</CODE></a> 130 </th> 131<td>Stops a timer that has been started.</td> 132 </tr> 133 <tr> 134 <td width="100"> </td> 135 <th> 136<a href="../../../nn/os/Timer/ClearSignal.html"><CODE>ClearSignal</CODE></a> 137 </th> 138<td>Clears a timer.</td> 139 </tr> </table> 140 </div> 141 </a> 142<h2>Class Hierarchy</h2> 143 <div class="section"> 144<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> 145 </p> 146 </div> 147<h2>Revision History</h2> 148 <div class="section"> 149 <dl class="history"> 150 <dt>2010/01/07</dt> 151<dd>Initial version.<br /> 152 </dd> 153 </dl> 154 </div> 155 <hr><p>CONFIDENTIAL</p></body> 156</html> 157