<!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: SignallingComponent 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_1SignallingComponent.html">SignallingComponent</a>
</div>
</div>
<div class="contents">
<h1>SignallingComponent Class Reference</h1><!-- doxytag: class="TelEngine::SignallingComponent" --><!-- doxytag: inherits="TelEngine::GenObject,TelEngine::DebugEnabler" -->Abstract signalling component that can be managed by the engine.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="yatesig_8h-source.html">yatesig.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for SignallingComponent:</div>
<div class="dynsection">
<p><center><img src="classTelEngine_1_1SignallingComponent.png" usemap="#SignallingComponent_map" border="0" alt=""></center>
<map name="SignallingComponent_map">
<area href="classTelEngine_1_1GenObject.html" alt="GenObject" shape="rect" coords="0,0,139,24">
<area href="classTelEngine_1_1DebugEnabler.html" alt="DebugEnabler" shape="rect" coords="149,0,288,24">
<area href="classTelEngine_1_1ISDNLayer2.html" alt="ISDNLayer2" shape="rect" coords="223,112,362,136">
<area href="classTelEngine_1_1ISDNLayer3.html" alt="ISDNLayer3" shape="rect" coords="223,168,362,192">
<area href="classTelEngine_1_1SignallingCircuitGroup.html" alt="SignallingCircuitGroup" shape="rect" coords="223,224,362,248">
<area href="classTelEngine_1_1SignallingInterface.html" alt="SignallingInterface" shape="rect" coords="223,280,362,304">
<area href="classTelEngine_1_1SignallingReceiver.html" alt="SignallingReceiver" shape="rect" coords="223,336,362,360">
<area href="classTelEngine_1_1SS7ASP.html" alt="SS7ASP" shape="rect" coords="223,392,362,416">
<area href="classTelEngine_1_1SS7L2User.html" alt="SS7L2User" shape="rect" coords="223,448,362,472">
<area href="classTelEngine_1_1SS7L3User.html" alt="SS7L3User" shape="rect" coords="223,504,362,528">
<area href="classTelEngine_1_1SS7Layer2.html" alt="SS7Layer2" shape="rect" coords="223,560,362,584">
<area href="classTelEngine_1_1SS7Layer3.html" alt="SS7Layer3" shape="rect" coords="223,616,362,640">
<area href="classTelEngine_1_1SS7TCAP.html" alt="SS7TCAP" shape="rect" coords="223,672,362,696">
</map>
</div>
<p>
<a href="classTelEngine_1_1SignallingComponent-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">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SignallingComponent.html#a1aebb3753ddc3369e1584bb76e7b192">~SignallingComponent</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SignallingComponent.html#4a7bd56fb99593ace9379ed699f2719c">toString</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1SignallingEngine.html">SignallingEngine</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SignallingComponent.html#c5ef280daa60be5868f0cd365ffb9ddc">engine</a> () const </td></tr>
<tr><td colspan="2"><br><h2>Protected 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_1SignallingComponent.html#2f20cf7e4b2980376b640d7054ba2080">SignallingComponent</a> (const char *name=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_1SignallingComponent.html#4771fdcaa533970dd45313967fc98fd1">insert</a> (<a class="el" href="classTelEngine_1_1SignallingComponent.html">SignallingComponent</a> *component)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SignallingComponent.html#7f98f7c892816cc02a7791f67e25ecab">detach</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SignallingComponent.html#c7cf24f02cfa3147bf2cbf6434edb9c0">timerTick</a> (const <a class="el" href="classTelEngine_1_1Time.html">Time</a> &when)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SignallingComponent.html#b3a256e7d9fad73fa57de7c1fedf51c5">setName</a> (const char *name)</td></tr>
<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f118abcb532475b629c25948e221ed92"></a><!-- doxytag: member="TelEngine::SignallingComponent::SignallingEngine" ref="f118abcb532475b629c25948e221ed92" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>SignallingEngine</b></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Abstract signalling component that can be managed by the engine.
<p>
Interface to an abstract signalling component that is managed by an engine. The engine will periodically poll each component to keep them alive. <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="a1aebb3753ddc3369e1584bb76e7b192"></a><!-- doxytag: member="TelEngine::SignallingComponent::~SignallingComponent" ref="a1aebb3753ddc3369e1584bb76e7b192" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ~<a class="el" href="classTelEngine_1_1SignallingComponent.html">SignallingComponent</a> </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor, detaches the engine and other components
</div>
</div><p>
<a class="anchor" name="2f20cf7e4b2980376b640d7054ba2080"></a><!-- doxytag: member="TelEngine::SignallingComponent::SignallingComponent" ref="2f20cf7e4b2980376b640d7054ba2080" args="(const char *name=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1SignallingComponent.html">SignallingComponent</a> </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em> = <code>0</code> </td>
<td> ) </td>
<td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor with a default empty component name <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Name of this component </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="7f98f7c892816cc02a7791f67e25ecab"></a><!-- doxytag: member="TelEngine::SignallingComponent::detach" ref="7f98f7c892816cc02a7791f67e25ecab" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void detach </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Detach this component from all its links - components and engine. Reimplement this method in all components that keep pointers to other components. The default implementation detaches from the engine.
</div>
</div><p>
<a class="anchor" name="c5ef280daa60be5868f0cd365ffb9ddc"></a><!-- doxytag: member="TelEngine::SignallingComponent::engine" ref="c5ef280daa60be5868f0cd365ffb9ddc" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1SignallingEngine.html">SignallingEngine</a>* engine </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the <a class="el" href="classTelEngine_1_1SignallingEngine.html">TelEngine::SignallingEngine</a> that manages this component <dl class="return" compact><dt><b>Returns:</b></dt><dd>Pointer to engine or NULL if not managed by an engine </dd></dl>
</div>
</div><p>
<a class="anchor" name="4771fdcaa533970dd45313967fc98fd1"></a><!-- doxytag: member="TelEngine::SignallingComponent::insert" ref="4771fdcaa533970dd45313967fc98fd1" args="(SignallingComponent *component)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void insert </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1SignallingComponent.html">SignallingComponent</a> * </td>
<td class="paramname"> <em>component</em> </td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Insert another component in the same engine as this one. This method should be called for every component we attach. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>component</em> </td><td>Pointer to component to insert in engine </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="b3a256e7d9fad73fa57de7c1fedf51c5"></a><!-- doxytag: member="TelEngine::SignallingComponent::setName" ref="b3a256e7d9fad73fa57de7c1fedf51c5" args="(const char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setName </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Change the name of the component after it was constructed <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Name of this component </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="c7cf24f02cfa3147bf2cbf6434edb9c0"></a><!-- doxytag: member="TelEngine::SignallingComponent::timerTick" ref="c7cf24f02cfa3147bf2cbf6434edb9c0" args="(const Time &when)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void timerTick </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classTelEngine_1_1Time.html">Time</a> & </td>
<td class="paramname"> <em>when</em> </td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Method called periodically by the engine to keep everything alive <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>when</em> </td><td><a class="el" href="classTelEngine_1_1Time.html" title="A time holding class.">Time</a> to use as computing base for events and timeouts </td></tr>
</table>
</dl>
<p>Reimplemented in <a class="el" href="classTelEngine_1_1SS7MTP2.html#c7cf24f02cfa3147bf2cbf6434edb9c0">SS7MTP2</a>, <a class="el" href="classTelEngine_1_1SS7ISUP.html#c7cf24f02cfa3147bf2cbf6434edb9c0">SS7ISUP</a>, <a class="el" href="classTelEngine_1_1ISDNQ921.html#c7cf24f02cfa3147bf2cbf6434edb9c0">ISDNQ921</a>, <a class="el" href="classTelEngine_1_1ISDNQ921Pasive.html#c7cf24f02cfa3147bf2cbf6434edb9c0">ISDNQ921Pasive</a>, <a class="el" href="classTelEngine_1_1ISDNQ931.html#c7cf24f02cfa3147bf2cbf6434edb9c0">ISDNQ931</a>, and <a class="el" href="classTelEngine_1_1ISDNQ931Monitor.html#c7cf24f02cfa3147bf2cbf6434edb9c0">ISDNQ931Monitor</a>.</p>
</div>
</div><p>
<a class="anchor" name="4a7bd56fb99593ace9379ed699f2719c"></a><!-- doxytag: member="TelEngine::SignallingComponent::toString" ref="4a7bd56fb99593ace9379ed699f2719c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="classTelEngine_1_1String.html">String</a>& toString </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the component's name so it can be used for list searches <dl class="return" compact><dt><b>Returns:</b></dt><dd>A reference to the name by which the component is known to engine </dd></dl>
<p>Reimplemented from <a class="el" href="classTelEngine_1_1GenObject.html#4a7bd56fb99593ace9379ed699f2719c">GenObject</a>.</p>
</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
>
554
