<!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::AlarmImpl 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_1AlarmImpl.html">AlarmImpl</a>
</div>
</div>
<div class="contents">
<h1>prophet::AlarmImpl Class Reference</h1><!-- doxytag: class="prophet::AlarmImpl" --><!-- doxytag: inherits="prophet::Alarm" -->Mock object for use in testing.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="BundleCore_8h-source.html">BundleCore.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for prophet::AlarmImpl:</div>
<div class="dynsection">
<p><center><img src="classprophet_1_1AlarmImpl.png" usemap="#prophet::AlarmImpl_map" border="0" alt=""></center>
<map name="prophet::AlarmImpl_map">
<area href="classprophet_1_1Alarm.html" alt="prophet::Alarm" shape="rect" coords="0,0,116,24">
</map>
</div>
<p>
<a href="classprophet_1_1AlarmImpl-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_1AlarmImpl.html#ade59086ac9c76e5dc6944da8ef1a645">AlarmImpl</a> (<a class="el" href="classprophet_1_1ExpirationHandler.html">ExpirationHandler</a> *h)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classprophet_1_1AlarmImpl.html#043f65b2e6722ed861303fcb6535ae92">~AlarmImpl</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classprophet_1_1AlarmImpl.html#c86500213de92091f72d5f35a9b35c82">schedule</a> (u_int)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">How many milliseconds in the future to schedule this alarm. <a href="#c86500213de92091f72d5f35a9b35c82"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u_int </td><td class="memItemRight" valign="bottom"><a class="el" href="classprophet_1_1AlarmImpl.html#ef9f3f3b8acd7154e06e6855dbe7a1fa">time_remaining</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Milliseconds remaining until alarm expires. <a href="#ef9f3f3b8acd7154e06e6855dbe7a1fa"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classprophet_1_1AlarmImpl.html#2a94ed60883985747d3e6fec362bdb6c">cancel</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Disable the alarm; do not execute the handler. <a href="#2a94ed60883985747d3e6fec362bdb6c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="serialsource_8c.html#1062901a7428fdd9c7f180f5e01ea056">bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classprophet_1_1AlarmImpl.html#7b8cb7f5c70feda6849b8bc9be6ec510">pending</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Accessors. <a href="#7b8cb7f5c70feda6849b8bc9be6ec510"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="serialsource_8c.html#1062901a7428fdd9c7f180f5e01ea056">bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classprophet_1_1AlarmImpl.html#830a40308b1fcb2696b44a89fcb7be93">cancelled</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Accessors. <a href="#830a40308b1fcb2696b44a89fcb7be93"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="serialsource_8c.html#1062901a7428fdd9c7f180f5e01ea056">bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classprophet_1_1AlarmImpl.html#32f24b7f024973c48059b4876131bff1">pending_</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="serialsource_8c.html#1062901a7428fdd9c7f180f5e01ea056">bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classprophet_1_1AlarmImpl.html#86132571e60f8946cc47a8f0b190020e">cancelled_</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Mock object for use in testing.
<p>Definition at line <a class="el" href="BundleCore_8h-source.html#l00202">202</a> of file <a class="el" href="BundleCore_8h-source.html">BundleCore.h</a>.</p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="ade59086ac9c76e5dc6944da8ef1a645"></a><!-- doxytag: member="prophet::AlarmImpl::AlarmImpl" ref="ade59086ac9c76e5dc6944da8ef1a645" args="(ExpirationHandler *h)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">prophet::AlarmImpl::AlarmImpl </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classprophet_1_1ExpirationHandler.html">ExpirationHandler</a> * </td>
<td class="paramname"> <em>h</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Definition at line <a class="el" href="BundleCore_8h-source.html#l00205">205</a> of file <a class="el" href="BundleCore_8h-source.html">BundleCore.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="043f65b2e6722ed861303fcb6535ae92"></a><!-- doxytag: member="prophet::AlarmImpl::~AlarmImpl" ref="043f65b2e6722ed861303fcb6535ae92" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual prophet::AlarmImpl::~AlarmImpl </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Definition at line <a class="el" href="BundleCore_8h-source.html#l00208">208</a> of file <a class="el" href="BundleCore_8h-source.html">BundleCore.h</a>.</p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="2a94ed60883985747d3e6fec362bdb6c"></a><!-- doxytag: member="prophet::AlarmImpl::cancel" ref="2a94ed60883985747d3e6fec362bdb6c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void prophet::AlarmImpl::cancel </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, 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>Implements <a class="el" href="classprophet_1_1Alarm.html#508522f8fbea59f5b6a64a6fafae5f4c">prophet::Alarm</a>.</p>
<p>Definition at line <a class="el" href="BundleCore_8h-source.html#l00212">212</a> of file <a class="el" href="BundleCore_8h-source.html">BundleCore.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="830a40308b1fcb2696b44a89fcb7be93"></a><!-- doxytag: member="prophet::AlarmImpl::cancelled" ref="830a40308b1fcb2696b44a89fcb7be93" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="serialsource_8c.html#1062901a7428fdd9c7f180f5e01ea056">bool</a> prophet::AlarmImpl::cancelled </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Accessors.
<p>
<p>Implements <a class="el" href="classprophet_1_1Alarm.html#c091adaa44e62772c19f20d23efebd92">prophet::Alarm</a>.</p>
<p>Definition at line <a class="el" href="BundleCore_8h-source.html#l00214">214</a> of file <a class="el" href="BundleCore_8h-source.html">BundleCore.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="7b8cb7f5c70feda6849b8bc9be6ec510"></a><!-- doxytag: member="prophet::AlarmImpl::pending" ref="7b8cb7f5c70feda6849b8bc9be6ec510" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="serialsource_8c.html#1062901a7428fdd9c7f180f5e01ea056">bool</a> prophet::AlarmImpl::pending </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Accessors.
<p>
<p>Implements <a class="el" href="classprophet_1_1Alarm.html#6d7567c66026f23fa7ef545b23110fe5">prophet::Alarm</a>.</p>
<p>Definition at line <a class="el" href="BundleCore_8h-source.html#l00213">213</a> of file <a class="el" href="BundleCore_8h-source.html">BundleCore.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="c86500213de92091f72d5f35a9b35c82"></a><!-- doxytag: member="prophet::AlarmImpl::schedule" ref="c86500213de92091f72d5f35a9b35c82" args="(u_int)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void prophet::AlarmImpl::schedule </td>
<td>(</td>
<td class="paramtype">u_int </td>
<td class="paramname"> <em>milliseconds</em> </td>
<td> ) </td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
How many milliseconds in the future to schedule this alarm.
<p>
<p>Implements <a class="el" href="classprophet_1_1Alarm.html#63c754c7cac177eba56e52a1a0dda218">prophet::Alarm</a>.</p>
<p>Definition at line <a class="el" href="BundleCore_8h-source.html#l00210">210</a> of file <a class="el" href="BundleCore_8h-source.html">BundleCore.h</a>.</p>
<p>Referenced by <a class="el" href="BundleCore_8h-source.html#l00322">prophet::BundleCoreTestImpl::create_alarm()</a>.</p>
</div>
</div><p>
<a class="anchor" name="ef9f3f3b8acd7154e06e6855dbe7a1fa"></a><!-- doxytag: member="prophet::AlarmImpl::time_remaining" ref="ef9f3f3b8acd7154e06e6855dbe7a1fa" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u_int prophet::AlarmImpl::time_remaining </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Milliseconds remaining until alarm expires.
<p>
<p>Implements <a class="el" href="classprophet_1_1Alarm.html#3304d46e4d44b59e1e2387c7c2f3bb07">prophet::Alarm</a>.</p>
<p>Definition at line <a class="el" href="BundleCore_8h-source.html#l00211">211</a> of file <a class="el" href="BundleCore_8h-source.html">BundleCore.h</a>.</p>
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="86132571e60f8946cc47a8f0b190020e"></a><!-- doxytag: member="prophet::AlarmImpl::cancelled_" ref="86132571e60f8946cc47a8f0b190020e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="serialsource_8c.html#1062901a7428fdd9c7f180f5e01ea056">bool</a> <a class="el" href="classprophet_1_1AlarmImpl.html#86132571e60f8946cc47a8f0b190020e">prophet::AlarmImpl::cancelled_</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Definition at line <a class="el" href="BundleCore_8h-source.html#l00215">215</a> of file <a class="el" href="BundleCore_8h-source.html">BundleCore.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="32f24b7f024973c48059b4876131bff1"></a><!-- doxytag: member="prophet::AlarmImpl::pending_" ref="32f24b7f024973c48059b4876131bff1" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="serialsource_8c.html#1062901a7428fdd9c7f180f5e01ea056">bool</a> <a class="el" href="classprophet_1_1AlarmImpl.html#32f24b7f024973c48059b4876131bff1">prophet::AlarmImpl::pending_</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Definition at line <a class="el" href="BundleCore_8h-source.html#l00215">215</a> of file <a class="el" href="BundleCore_8h-source.html">BundleCore.h</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="BundleCore_8h-source.html">BundleCore.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
>
1560
