<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>DTN Reference Implementation: prophet::Alarm 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.5.8 -->
<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>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespaceprophet.html">prophet</a>::<a class="el" href="classprophet_1_1Alarm.html">Alarm</a>
</div>
</div>
<div class="contents">
<h1>prophet::Alarm Class Reference</h1><!-- doxytag: class="prophet::Alarm" --><a class="el" href="classprophet_1_1Alarm.html" title="Alarm registration.">Alarm</a> registration.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="Alarm_8h-source.html">Alarm.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for prophet::Alarm:</div>
<div class="dynsection">
<p><center><img src="classprophet_1_1Alarm.png" usemap="#prophet::Alarm_map" border="0" alt=""></center>
<map name="prophet::Alarm_map">
<area href="classdtn_1_1ProphetTimer.html" alt="dtn::ProphetTimer" shape="rect" coords="0,56,116,80">
<area href="classprophet_1_1AlarmImpl.html" alt="prophet::AlarmImpl" shape="rect" coords="126,56,242,80">
</map>
</div>
<p>
<a href="classprophet_1_1Alarm-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classprophet_1_1Alarm.html#987f663429fa93cdbc7884d5411eb703">Alarm</a> (<a class="el" href="classprophet_1_1ExpirationHandler.html">ExpirationHandler</a> *handler)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#987f663429fa93cdbc7884d5411eb703"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classprophet_1_1Alarm.html#651ac71929528bf130564c31ae5d9c5e">~Alarm</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#651ac71929528bf130564c31ae5d9c5e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classprophet_1_1Alarm.html#63c754c7cac177eba56e52a1a0dda218">schedule</a> (u_int milliseconds)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">How many milliseconds in the future to schedule this alarm. <a href="#63c754c7cac177eba56e52a1a0dda218"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual u_int </td><td class="memItemRight" valign="bottom"><a class="el" href="classprophet_1_1Alarm.html#3304d46e4d44b59e1e2387c7c2f3bb07">time_remaining</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Milliseconds remaining until alarm expires. <a href="#3304d46e4d44b59e1e2387c7c2f3bb07"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classprophet_1_1Alarm.html#508522f8fbea59f5b6a64a6fafae5f4c">cancel</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Disable the alarm; do not execute the handler. <a href="#508522f8fbea59f5b6a64a6fafae5f4c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classprophet_1_1Alarm.html#2b338adb4dc614f739697d18813f88b5">timeout</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Invoke timeout handler. <a href="#2b338adb4dc614f739697d18813f88b5"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="serialsource_8c.html#1062901a7428fdd9c7f180f5e01ea056">bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classprophet_1_1Alarm.html#6d7567c66026f23fa7ef545b23110fe5">pending</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Accessors. <a href="#6d7567c66026f23fa7ef545b23110fe5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="serialsource_8c.html#1062901a7428fdd9c7f180f5e01ea056">bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classprophet_1_1Alarm.html#c091adaa44e62772c19f20d23efebd92">cancelled</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Accessors. <a href="#c091adaa44e62772c19f20d23efebd92"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classprophet_1_1ExpirationHandler.html">ExpirationHandler</a> *const </td><td class="memItemRight" valign="bottom"><a class="el" href="classprophet_1_1Alarm.html#2b6199fb54a7298db1a256e70565d42d">handler_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">action to perform when alarm expires <a href="#2b6199fb54a7298db1a256e70565d42d"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<a class="el" href="classprophet_1_1Alarm.html" title="Alarm registration.">Alarm</a> registration.
<p>Definition at line <a class="el" href="Alarm_8h-source.html#l00068">68</a> of file <a class="el" href="Alarm_8h-source.html">Alarm.h</a>.</p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="987f663429fa93cdbc7884d5411eb703"></a><!-- doxytag: member="prophet::Alarm::Alarm" ref="987f663429fa93cdbc7884d5411eb703" args="(ExpirationHandler *handler)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">prophet::Alarm::Alarm </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classprophet_1_1ExpirationHandler.html">ExpirationHandler</a> * </td>
<td class="paramname"> <em>handler</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor.
<p>
<p>Definition at line <a class="el" href="Alarm_8h-source.html#l00074">74</a> of file <a class="el" href="Alarm_8h-source.html">Alarm.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="651ac71929528bf130564c31ae5d9c5e"></a><!-- doxytag: member="prophet::Alarm::~Alarm" ref="651ac71929528bf130564c31ae5d9c5e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual prophet::Alarm::~Alarm </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor.
<p>
<p>Definition at line <a class="el" href="Alarm_8h-source.html#l00080">80</a> of file <a class="el" href="Alarm_8h-source.html">Alarm.h</a>.</p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="508522f8fbea59f5b6a64a6fafae5f4c"></a><!-- doxytag: member="prophet::Alarm::cancel" ref="508522f8fbea59f5b6a64a6fafae5f4c" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void prophet::Alarm::cancel </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Disable the alarm; do not execute the handler.
<p>
It is expected that the host's timer implementation will cleanup a cancelled Alarm's memory ...
<p>Implemented in <a class="el" href="classprophet_1_1AlarmImpl.html#2a94ed60883985747d3e6fec362bdb6c">prophet::AlarmImpl</a>, and <a class="el" href="classdtn_1_1ProphetTimer.html#ac693f56a7f6de16b5a23935438194e3">dtn::ProphetTimer</a>.</p>
</div>
</div><p>
<a class="anchor" name="c091adaa44e62772c19f20d23efebd92"></a><!-- doxytag: member="prophet::Alarm::cancelled" ref="c091adaa44e62772c19f20d23efebd92" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="serialsource_8c.html#1062901a7428fdd9c7f180f5e01ea056">bool</a> prophet::Alarm::cancelled </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Accessors.
<p>
<p>Implemented in <a class="el" href="classprophet_1_1AlarmImpl.html#830a40308b1fcb2696b44a89fcb7be93">prophet::AlarmImpl</a>, and <a class="el" href="classdtn_1_1ProphetTimer.html#e0a84170bfd5dd1f2fbbb32e51cf343a">dtn::ProphetTimer</a>.</p>
</div>
</div><p>
<a class="anchor" name="6d7567c66026f23fa7ef545b23110fe5"></a><!-- doxytag: member="prophet::Alarm::pending" ref="6d7567c66026f23fa7ef545b23110fe5" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="serialsource_8c.html#1062901a7428fdd9c7f180f5e01ea056">bool</a> prophet::Alarm::pending </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Accessors.
<p>
<p>Implemented in <a class="el" href="classprophet_1_1AlarmImpl.html#7b8cb7f5c70feda6849b8bc9be6ec510">prophet::AlarmImpl</a>, and <a class="el" href="classdtn_1_1ProphetTimer.html#7dfd5440dcb955b90ba0fb2c7a9f6145">dtn::ProphetTimer</a>.</p>
</div>
</div><p>
<a class="anchor" name="63c754c7cac177eba56e52a1a0dda218"></a><!-- doxytag: member="prophet::Alarm::schedule" ref="63c754c7cac177eba56e52a1a0dda218" args="(u_int milliseconds)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void prophet::Alarm::schedule </td>
<td>(</td>
<td class="paramtype">u_int </td>
<td class="paramname"> <em>milliseconds</em> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
How many milliseconds in the future to schedule this alarm.
<p>
<p>Implemented in <a class="el" href="classprophet_1_1AlarmImpl.html#c86500213de92091f72d5f35a9b35c82">prophet::AlarmImpl</a>, and <a class="el" href="classdtn_1_1ProphetTimer.html#06a6447f317c304f1a341dad43484b0e">dtn::ProphetTimer</a>.</p>
</div>
</div><p>
<a class="anchor" name="3304d46e4d44b59e1e2387c7c2f3bb07"></a><!-- doxytag: member="prophet::Alarm::time_remaining" ref="3304d46e4d44b59e1e2387c7c2f3bb07" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual u_int prophet::Alarm::time_remaining </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Milliseconds remaining until alarm expires.
<p>
<p>Implemented in <a class="el" href="classprophet_1_1AlarmImpl.html#ef9f3f3b8acd7154e06e6855dbe7a1fa">prophet::AlarmImpl</a>, and <a class="el" href="classdtn_1_1ProphetTimer.html#19272e0bef9c0df0e20d278c0e4f586f">dtn::ProphetTimer</a>.</p>
<p>Referenced by <a class="el" href="Encounter_8h-source.html#l00116">prophet::Encounter::time_remaining()</a>.</p>
</div>
</div><p>
<a class="anchor" name="2b338adb4dc614f739697d18813f88b5"></a><!-- doxytag: member="prophet::Alarm::timeout" ref="2b338adb4dc614f739697d18813f88b5" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void prophet::Alarm::timeout </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Invoke timeout handler.
<p>
It is expected that a successfully executed <a class="el" href="classprophet_1_1ExpirationHandler.html" title="Alarm expiration handler.">ExpirationHandler</a> will clean up Alarm's memory
<p>Definition at line <a class="el" href="Alarm_8h-source.html#l00103">103</a> of file <a class="el" href="Alarm_8h-source.html">Alarm.h</a>.</p>
<p>References <a class="el" href="classprophet_1_1ExpirationHandler.html#bbdbff285abd02df47b26ae6dab909c8">prophet::ExpirationHandler::handle_timeout()</a>, and <a class="el" href="Alarm_8h-source.html#l00111">handler_</a>.</p>
<p>Referenced by <a class="el" href="ProphetTimer_8h-source.html#l00047">dtn::ProphetTimer::timeout()</a>.</p>
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="2b6199fb54a7298db1a256e70565d42d"></a><!-- doxytag: member="prophet::Alarm::handler_" ref="2b6199fb54a7298db1a256e70565d42d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classprophet_1_1ExpirationHandler.html">ExpirationHandler</a>* const <a class="el" href="classprophet_1_1Alarm.html#2b6199fb54a7298db1a256e70565d42d">prophet::Alarm::handler_</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
action to perform when alarm expires
<p>
<p>Definition at line <a class="el" href="Alarm_8h-source.html#l00111">111</a> of file <a class="el" href="Alarm_8h-source.html">Alarm.h</a>.</p>
<p>Referenced by <a class="el" href="Alarm_8h-source.html#l00103">timeout()</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="Alarm_8h-source.html">Alarm.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Jan 30 09:27:05 2009 for DTN Reference Implementation by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
29c369053a983cc5d8c880dc6e0a2237
>
files
>
1557
