<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Yate: SignallingTimer Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.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="namespaceTelEngine.html">TelEngine</a>::<a class="el" href="classTelEngine_1_1SignallingTimer.html">SignallingTimer</a>
</div>
</div>
<div class="contents">
<h1>SignallingTimer Class Reference</h1><!-- doxytag: class="TelEngine::SignallingTimer" -->A signalling timer.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="yatesig_8h-source.html">yatesig.h</a>></code>
<p>
<p>
<a href="classTelEngine_1_1SignallingTimer-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="classTelEngine_1_1SignallingTimer.html#472d58ef96a3e4f5346b218f947df383">SignallingTimer</a> (u_int64_t interval, u_int64_t time=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SignallingTimer.html#f0cb31f6b7dd9eb182cc198fda2a14f9">interval</a> (u_int64_t value)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SignallingTimer.html#2c9fd7d6771fdf692befb42160b9de27">interval</a> (const <a class="el" href="classTelEngine_1_1NamedList.html">NamedList</a> &params, const char *param, unsigned int minVal, unsigned int defVal, bool allowDisable, bool sec=false)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u_int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SignallingTimer.html#c8fe90515f8863372cdf8a6de4770171">interval</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SignallingTimer.html#e7fe4d5970e6de11b2cc8450342698b9">start</a> (u_int64_t time=Time::msecNow())</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SignallingTimer.html#8c528baf37154d347366083f0f816846">stop</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SignallingTimer.html#f41b8630e5466023133f31442906e682">started</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SignallingTimer.html#6407ecaf1c2f0892a09cb115c553823b">timeout</a> (u_int64_t time=Time::msecNow())</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A signalling timer.
<p>
Timer management class. Used to manage timeouts. The time is kept in miliseconds <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="472d58ef96a3e4f5346b218f947df383"></a><!-- doxytag: member="TelEngine::SignallingTimer::SignallingTimer" ref="472d58ef96a3e4f5346b218f947df383" args="(u_int64_t interval, u_int64_t time=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1SignallingTimer.html">SignallingTimer</a> </td>
<td>(</td>
<td class="paramtype">u_int64_t </td>
<td class="paramname"> <em>interval</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u_int64_t </td>
<td class="paramname"> <em>time</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>interval</em> </td><td>The timeout interval. Set to 0 to disable </td></tr>
<tr><td valign="top"></td><td valign="top"><em>time</em> </td><td>Optional timeout value. If non 0, the timer is started </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="c8fe90515f8863372cdf8a6de4770171"></a><!-- doxytag: member="TelEngine::SignallingTimer::interval" ref="c8fe90515f8863372cdf8a6de4770171" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u_int64_t interval </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the timeout interval <dl class="return" compact><dt><b>Returns:</b></dt><dd>The timeout interval </dd></dl>
</div>
</div><p>
<a class="anchor" name="2c9fd7d6771fdf692befb42160b9de27"></a><!-- doxytag: member="TelEngine::SignallingTimer::interval" ref="2c9fd7d6771fdf692befb42160b9de27" args="(const NamedList &params, const char *param, unsigned int minVal, unsigned int defVal, bool allowDisable, bool sec=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void interval </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classTelEngine_1_1NamedList.html">NamedList</a> & </td>
<td class="paramname"> <em>params</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>param</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>minVal</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>defVal</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>allowDisable</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>sec</em> = <code>false</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the timeout interval from a list of parameters. The interval value is checked to be at least minVal or 0 if allowDisable is true <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>params</em> </td><td>The list of parameters </td></tr>
<tr><td valign="top"></td><td valign="top"><em>param</em> </td><td>The name of the parameter containing the timer interval value </td></tr>
<tr><td valign="top"></td><td valign="top"><em>minVal</em> </td><td>Minimum value allowed for the timer interval </td></tr>
<tr><td valign="top"></td><td valign="top"><em>defVal</em> </td><td>Default value if it fails to get one from the given parameter </td></tr>
<tr><td valign="top"></td><td valign="top"><em>allowDisable</em> </td><td>True to allow 0 for the timer interval </td></tr>
<tr><td valign="top"></td><td valign="top"><em>sec</em> </td><td>True if the interval value if given in seconds </td></tr>
</table>
</dl>
<p>References <a class="el" href="classTelEngine_1_1NamedList.html#28c62b8fba64b5df9271e17044309918">NamedList::getIntValue()</a>.</p>
</div>
</div><p>
<a class="anchor" name="f0cb31f6b7dd9eb182cc198fda2a14f9"></a><!-- doxytag: member="TelEngine::SignallingTimer::interval" ref="f0cb31f6b7dd9eb182cc198fda2a14f9" args="(u_int64_t value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void interval </td>
<td>(</td>
<td class="paramtype">u_int64_t </td>
<td class="paramname"> <em>value</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the timeout interval <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>The new timeout value </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="e7fe4d5970e6de11b2cc8450342698b9"></a><!-- doxytag: member="TelEngine::SignallingTimer::start" ref="e7fe4d5970e6de11b2cc8450342698b9" args="(u_int64_t time=Time::msecNow())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void start </td>
<td>(</td>
<td class="paramtype">u_int64_t </td>
<td class="paramname"> <em>time</em> = <code>Time::msecNow()</code> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Start the timer if enabled (interval is positive) <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>time</em> </td><td><a class="el" href="classTelEngine_1_1Time.html" title="A time holding class.">Time</a> to be added to the interval to set the timeout point </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="f41b8630e5466023133f31442906e682"></a><!-- doxytag: member="TelEngine::SignallingTimer::started" ref="f41b8630e5466023133f31442906e682" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool started </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if the timer is started <dl class="return" compact><dt><b>Returns:</b></dt><dd>True if the timer is started </dd></dl>
</div>
</div><p>
<a class="anchor" name="8c528baf37154d347366083f0f816846"></a><!-- doxytag: member="TelEngine::SignallingTimer::stop" ref="8c528baf37154d347366083f0f816846" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void stop </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Stop the timer
</div>
</div><p>
<a class="anchor" name="6407ecaf1c2f0892a09cb115c553823b"></a><!-- doxytag: member="TelEngine::SignallingTimer::timeout" ref="6407ecaf1c2f0892a09cb115c553823b" args="(u_int64_t time=Time::msecNow())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool timeout </td>
<td>(</td>
<td class="paramtype">u_int64_t </td>
<td class="paramname"> <em>time</em> = <code>Time::msecNow()</code> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if the timer is started and timed out <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>time</em> </td><td>The time to compare with </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if the timer timed out </dd></dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="yatesig_8h-source.html">yatesig.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Dec 7 21:36:13 2008 for Yate by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.7.1 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
eeacaa4eb55fa544d622989e42fc27b1
>
files
>
578
