<!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: SignallingCircuitEvent 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_1SignallingCircuitEvent.html">SignallingCircuitEvent</a>
</div>
</div>
<div class="contents">
<h1>SignallingCircuitEvent Class Reference</h1><!-- doxytag: class="TelEngine::SignallingCircuitEvent" --><!-- doxytag: inherits="TelEngine::NamedList" -->A single signalling circuit related event.
<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 SignallingCircuitEvent:</div>
<div class="dynsection">
<p><center><img src="classTelEngine_1_1SignallingCircuitEvent.png" usemap="#SignallingCircuitEvent_map" border="0" alt=""></center>
<map name="SignallingCircuitEvent_map">
<area href="classTelEngine_1_1NamedList.html" alt="NamedList" shape="rect" coords="0,112,136,136">
<area href="classTelEngine_1_1String.html" alt="String" shape="rect" coords="0,56,136,80">
<area href="classTelEngine_1_1GenObject.html" alt="GenObject" shape="rect" coords="0,0,136,24">
</map>
</div>
<p>
<a href="classTelEngine_1_1SignallingCircuitEvent-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 Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SignallingCircuitEvent.html#1d1cfd8ffb84e947f82999c682b666a7">Type</a> { <br>
<b>Unknown</b> = 0,
<b>Dtmf</b> = 1,
<b>Timeout</b> = 10,
<b>Polarity</b> = 11,
<br>
<b>StartLine</b> = 15,
<b>LineStarted</b> = 16,
<b>DialComplete</b> = 17,
<b>OnHook</b> = 20,
<br>
<b>OffHook</b> = 21,
<b>RingBegin</b> = 22,
<b>RingEnd</b> = 23,
<b>RingerOn</b> = 30,
<br>
<b>RingerOff</b> = 31,
<b>Wink</b> = 32,
<b>Flash</b> = 33,
<b>PulseStart</b> = 40,
<br>
<b>PulseDigit</b> = 41,
<b>Alarm</b> = 100,
<b>NoAlarm</b> = 101
<br>
}</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_1SignallingCircuitEvent.html#c087cb69c2c1b01abea31e42aea5901e">SignallingCircuitEvent</a> (<a class="el" href="classTelEngine_1_1SignallingCircuit.html">SignallingCircuit</a> *cic, <a class="el" href="classTelEngine_1_1SignallingCircuitEvent.html#1d1cfd8ffb84e947f82999c682b666a7">Type</a> type, const char *name=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SignallingCircuitEvent.html#b6027afaaf5ee9bdf262ce42cc2b621d">~SignallingCircuitEvent</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1SignallingCircuitEvent.html#1d1cfd8ffb84e947f82999c682b666a7">Type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SignallingCircuitEvent.html#fbd0fa31db28593e9669c3c56711c0a7">type</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1SignallingCircuit.html">SignallingCircuit</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SignallingCircuitEvent.html#efac4c7ff247d52b597e828b43335512">circuit</a> ()</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A single signalling circuit related event.
<p>
An object holding a signalling circuit event and related references <hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="1d1cfd8ffb84e947f82999c682b666a7"></a><!-- doxytag: member="TelEngine::SignallingCircuitEvent::Type" ref="1d1cfd8ffb84e947f82999c682b666a7" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classTelEngine_1_1SignallingCircuitEvent.html#1d1cfd8ffb84e947f82999c682b666a7">Type</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Type of the event
</div>
</div><p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="c087cb69c2c1b01abea31e42aea5901e"></a><!-- doxytag: member="TelEngine::SignallingCircuitEvent::SignallingCircuitEvent" ref="c087cb69c2c1b01abea31e42aea5901e" args="(SignallingCircuit *cic, Type type, const char *name=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1SignallingCircuitEvent.html">SignallingCircuitEvent</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1SignallingCircuit.html">SignallingCircuit</a> * </td>
<td class="paramname"> <em>cic</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1SignallingCircuitEvent.html#1d1cfd8ffb84e947f82999c682b666a7">Type</a> </td>
<td class="paramname"> <em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor for a circuit related event <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>cic</em> </td><td>The circuit that generated this event </td></tr>
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>Event type as enumeration </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Optional name for the named list </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="b6027afaaf5ee9bdf262ce42cc2b621d"></a><!-- doxytag: member="TelEngine::SignallingCircuitEvent::~SignallingCircuitEvent" ref="b6027afaaf5ee9bdf262ce42cc2b621d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ~<a class="el" href="classTelEngine_1_1SignallingCircuitEvent.html">SignallingCircuitEvent</a> </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor, dereferences any resources
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="efac4c7ff247d52b597e828b43335512"></a><!-- doxytag: member="TelEngine::SignallingCircuitEvent::circuit" ref="efac4c7ff247d52b597e828b43335512" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1SignallingCircuit.html">SignallingCircuit</a>* circuit </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the circuit that generated this event <dl class="return" compact><dt><b>Returns:</b></dt><dd>The circuit that generated this event </dd></dl>
</div>
</div><p>
<a class="anchor" name="fbd0fa31db28593e9669c3c56711c0a7"></a><!-- doxytag: member="TelEngine::SignallingCircuitEvent::type" ref="fbd0fa31db28593e9669c3c56711c0a7" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1SignallingCircuitEvent.html#1d1cfd8ffb84e947f82999c682b666a7">Type</a> type </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the type of this event <dl class="return" compact><dt><b>Returns:</b></dt><dd>The type of this event </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
>
542
