<!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: SignallingCounter 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_1SignallingCounter.html">SignallingCounter</a>
</div>
</div>
<div class="contents">
<h1>SignallingCounter Class Reference</h1><!-- doxytag: class="TelEngine::SignallingCounter" -->A counter class.
<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_1SignallingCounter-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_1SignallingCounter.html#871c1d7bb44ae865255a75470cf5a062">SignallingCounter</a> (u_int32_t maxVal)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SignallingCounter.html#b6d68ff78a1ce69fcba4578eda8c666f">maxVal</a> (u_int32_t value)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u_int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SignallingCounter.html#cd4c0a4dde44e976f66fe7b20005f9b0">maxVal</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u_int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SignallingCounter.html#4fae88a43a36da20b6c0953589aa3aa0">count</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_1SignallingCounter.html#cc8f2ff933fdbb9dd594b95a55307906">reset</a> (bool down=true)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SignallingCounter.html#8b737fd2b2beb5daa81eadbf7d0f0c5e">inc</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_1SignallingCounter.html#b923efaf4dd5adc9cff96bc74bf5c7e9">dec</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_1SignallingCounter.html#c6e61de369e994009e36f344f99c15ad">empty</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SignallingCounter.html#a0b75676033302511679a2f5e9638c4d">full</a> () const </td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A counter class.
<p>
Counter management class. Keep a value between 0 and a given maximum one <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="871c1d7bb44ae865255a75470cf5a062"></a><!-- doxytag: member="TelEngine::SignallingCounter::SignallingCounter" ref="871c1d7bb44ae865255a75470cf5a062" args="(u_int32_t maxVal)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1SignallingCounter.html">SignallingCounter</a> </td>
<td>(</td>
<td class="paramtype">u_int32_t </td>
<td class="paramname"> <em>maxVal</em> </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>maxVal</em> </td><td>The maximum value for the counter </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="4fae88a43a36da20b6c0953589aa3aa0"></a><!-- doxytag: member="TelEngine::SignallingCounter::count" ref="4fae88a43a36da20b6c0953589aa3aa0" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u_int32_t count </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the current value of the counter <dl class="return" compact><dt><b>Returns:</b></dt><dd>The current value of the counter </dd></dl>
</div>
</div><p>
<a class="anchor" name="b923efaf4dd5adc9cff96bc74bf5c7e9"></a><!-- doxytag: member="TelEngine::SignallingCounter::dec" ref="b923efaf4dd5adc9cff96bc74bf5c7e9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool dec </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Decrement the counter's value if it can <dl class="return" compact><dt><b>Returns:</b></dt><dd>False if the counter is empty (reached 0) </dd></dl>
</div>
</div><p>
<a class="anchor" name="c6e61de369e994009e36f344f99c15ad"></a><!-- doxytag: member="TelEngine::SignallingCounter::empty" ref="c6e61de369e994009e36f344f99c15ad" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool empty </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if the counter is empty (the value is 0) <dl class="return" compact><dt><b>Returns:</b></dt><dd>True if the counter is empty </dd></dl>
</div>
</div><p>
<a class="anchor" name="a0b75676033302511679a2f5e9638c4d"></a><!-- doxytag: member="TelEngine::SignallingCounter::full" ref="a0b75676033302511679a2f5e9638c4d" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool full </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if the counter is full (the value reached the maximum) <dl class="return" compact><dt><b>Returns:</b></dt><dd>True if the counter is full </dd></dl>
</div>
</div><p>
<a class="anchor" name="8b737fd2b2beb5daa81eadbf7d0f0c5e"></a><!-- doxytag: member="TelEngine::SignallingCounter::inc" ref="8b737fd2b2beb5daa81eadbf7d0f0c5e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool inc </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Increment the counter's value if it can <dl class="return" compact><dt><b>Returns:</b></dt><dd>False if the counter is full (reached the maximum value) </dd></dl>
</div>
</div><p>
<a class="anchor" name="cd4c0a4dde44e976f66fe7b20005f9b0"></a><!-- doxytag: member="TelEngine::SignallingCounter::maxVal" ref="cd4c0a4dde44e976f66fe7b20005f9b0" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u_int32_t maxVal </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the maximum value for the counter <dl class="return" compact><dt><b>Returns:</b></dt><dd>The maximum value for the counter </dd></dl>
</div>
</div><p>
<a class="anchor" name="b6d68ff78a1ce69fcba4578eda8c666f"></a><!-- doxytag: member="TelEngine::SignallingCounter::maxVal" ref="b6d68ff78a1ce69fcba4578eda8c666f" args="(u_int32_t value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void maxVal </td>
<td>(</td>
<td class="paramtype">u_int32_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 maximum value for the counter <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 maximum value for the counter </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="cc8f2ff933fdbb9dd594b95a55307906"></a><!-- doxytag: member="TelEngine::SignallingCounter::reset" ref="cc8f2ff933fdbb9dd594b95a55307906" args="(bool down=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void reset </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>down</em> = <code>true</code> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Reset the counter's value <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>down</em> </td><td>True to reset to 0, false to reset to <a class="el" href="classTelEngine_1_1SignallingCounter.html#b6d68ff78a1ce69fcba4578eda8c666f">maxVal()</a> </td></tr>
</table>
</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
>
557
