<!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: ISDNQ931Call 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_1ISDNQ931Call.html">ISDNQ931Call</a>
</div>
</div>
<div class="contents">
<h1>ISDNQ931Call Class Reference</h1><!-- doxytag: class="TelEngine::ISDNQ931Call" --><!-- doxytag: inherits="TelEngine::ISDNQ931State,TelEngine::SignallingCall" -->A Q.931 ISDN call.
<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 ISDNQ931Call:</div>
<div class="dynsection">
<p><center><img src="classTelEngine_1_1ISDNQ931Call.png" usemap="#ISDNQ931Call_map" border="0" alt=""></center>
<map name="ISDNQ931Call_map">
<area href="classTelEngine_1_1ISDNQ931State.html" alt="ISDNQ931State" shape="rect" coords="0,112,100,136">
<area href="classTelEngine_1_1SignallingCall.html" alt="SignallingCall" shape="rect" coords="110,112,210,136">
<area href="classTelEngine_1_1RefObject.html" alt="RefObject" shape="rect" coords="110,56,210,80">
<area href="classTelEngine_1_1GenObject.html" alt="GenObject" shape="rect" coords="110,0,210,24">
</map>
</div>
<p>
<a href="classTelEngine_1_1ISDNQ931Call-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_1ISDNQ931Call.html#a3ded50a1d79d5c8828dd2371af7440c">~ISDNQ931Call</a> ()</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_1ISDNQ931Call.html#bc8731036e842a83978447146753661b">callRef</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_1ISDNQ931Call.html#3374427315bcf6aa9a013e82b4061f3f">callRefLen</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_1ISDNQ931Call.html#efac4c7ff247d52b597e828b43335512">circuit</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ISDNQ931Call.html#40e955f4a4d60cfff580811a7fc222e4">setTerminate</a> (bool destroy, const char *reason)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ISDNQ931Call.html#fabf4b61e29a47f4ea1b6b8d0cb4882c">sendEvent</a> (<a class="el" href="classTelEngine_1_1SignallingEvent.html">SignallingEvent</a> *event)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classTelEngine_1_1SignallingEvent.html">SignallingEvent</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ISDNQ931Call.html#60b984499483882d3ed71e6888a79201">getEvent</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_1ISDNQ931Call.html#168892820b39f67cfd935ab19a6dcd18">dataLinkState</a> (bool up)</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_1ISDNQ931Call.html#aa71c3294b1a073c3ad0b64a2ed6325a">getObject</a> (const <a class="el" href="classTelEngine_1_1String.html">String</a> &name) 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_1ISDNQ931Call.html#f17def8aed0a4db556e6d2967a550132">ISDNQ931Call</a> (<a class="el" href="classTelEngine_1_1ISDNQ931.html">ISDNQ931</a> *controller, bool outgoing, u_int32_t callRef, u_int8_t callRefLen)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1SignallingEvent.html">SignallingEvent</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ISDNQ931Call.html#ff30a449f6df391a323f2302386da9bc">releaseComplete</a> (const char *reason=0, const char *diag=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1SignallingEvent.html">SignallingEvent</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ISDNQ931Call.html#9eada45d5e65c0463c3a2067d244198b">getCircuitEvent</a> (const <a class="el" href="classTelEngine_1_1Time.html">Time</a> &when)</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="179b2ceb72c797d832acfbec8bcf2057"></a><!-- doxytag: member="TelEngine::ISDNQ931Call::ISDNQ931" ref="179b2ceb72c797d832acfbec8bcf2057" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>ISDNQ931</b></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A Q.931 ISDN call.
<p>
Q.931 ISDN call <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="a3ded50a1d79d5c8828dd2371af7440c"></a><!-- doxytag: member="TelEngine::ISDNQ931Call::~ISDNQ931Call" ref="a3ded50a1d79d5c8828dd2371af7440c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ~<a class="el" href="classTelEngine_1_1ISDNQ931Call.html">ISDNQ931Call</a> </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor
</div>
</div><p>
<a class="anchor" name="f17def8aed0a4db556e6d2967a550132"></a><!-- doxytag: member="TelEngine::ISDNQ931Call::ISDNQ931Call" ref="f17def8aed0a4db556e6d2967a550132" args="(ISDNQ931 *controller, bool outgoing, u_int32_t callRef, u_int8_t callRefLen)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1ISDNQ931Call.html">ISDNQ931Call</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1ISDNQ931.html">ISDNQ931</a> * </td>
<td class="paramname"> <em>controller</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>outgoing</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u_int32_t </td>
<td class="paramname"> <em>callRef</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u_int8_t </td>
<td class="paramname"> <em>callRefLen</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</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>controller</em> </td><td>The call controller </td></tr>
<tr><td valign="top"></td><td valign="top"><em>outgoing</em> </td><td>The call direction </td></tr>
<tr><td valign="top"></td><td valign="top"><em>callRef</em> </td><td>The call reference </td></tr>
<tr><td valign="top"></td><td valign="top"><em>callRefLen</em> </td><td>The call reference length in bytes </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="bc8731036e842a83978447146753661b"></a><!-- doxytag: member="TelEngine::ISDNQ931Call::callRef" ref="bc8731036e842a83978447146753661b" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u_int32_t callRef </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the id of this call <dl class="return" compact><dt><b>Returns:</b></dt><dd>The call reference </dd></dl>
<p>Referenced by <a class="el" href="yatesig_8h-source.html#l07464">ISDNQ931::sendRelease()</a>, and <a class="el" href="yatesig_8h-source.html#l07446">ISDNQ931::sendStatus()</a>.</p>
</div>
</div><p>
<a class="anchor" name="3374427315bcf6aa9a013e82b4061f3f"></a><!-- doxytag: member="TelEngine::ISDNQ931Call::callRefLen" ref="3374427315bcf6aa9a013e82b4061f3f" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u_int32_t callRefLen </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the length of the call reference <dl class="return" compact><dt><b>Returns:</b></dt><dd>The length of the call reference </dd></dl>
<p>Referenced by <a class="el" href="yatesig_8h-source.html#l07464">ISDNQ931::sendRelease()</a>, and <a class="el" href="yatesig_8h-source.html#l07446">ISDNQ931::sendStatus()</a>.</p>
</div>
</div><p>
<a class="anchor" name="efac4c7ff247d52b597e828b43335512"></a><!-- doxytag: member="TelEngine::ISDNQ931Call::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 this call had reserved <dl class="return" compact><dt><b>Returns:</b></dt><dd>The circuit reserved by this call </dd></dl>
</div>
</div><p>
<a class="anchor" name="168892820b39f67cfd935ab19a6dcd18"></a><!-- doxytag: member="TelEngine::ISDNQ931Call::dataLinkState" ref="168892820b39f67cfd935ab19a6dcd18" args="(bool up)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void dataLinkState </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>up</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Data link (interface) state notification This method is thread safe <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>up</em> </td><td>The data link state </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="9eada45d5e65c0463c3a2067d244198b"></a><!-- doxytag: member="TelEngine::ISDNQ931Call::getCircuitEvent" ref="9eada45d5e65c0463c3a2067d244198b" args="(const Time &when)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1SignallingEvent.html">SignallingEvent</a>* getCircuitEvent </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]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get an event from the circuit reserved for this call <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>The current time </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><a class="el" href="classTelEngine_1_1SignallingEvent.html" title="A single signalling related event.">SignallingEvent</a> pointer or 0 if no events </dd></dl>
</div>
</div><p>
<a class="anchor" name="60b984499483882d3ed71e6888a79201"></a><!-- doxytag: member="TelEngine::ISDNQ931Call::getEvent" ref="60b984499483882d3ed71e6888a79201" args="(const Time &when)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classTelEngine_1_1SignallingEvent.html">SignallingEvent</a>* getEvent </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> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get an event from this call This method is thread safe <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>The current time </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><a class="el" href="classTelEngine_1_1SignallingEvent.html" title="A single signalling related event.">SignallingEvent</a> pointer or 0 if no events </dd></dl>
<p>Implements <a class="el" href="classTelEngine_1_1SignallingCall.html#3ee099c6661a8026dc49dd92b9ed7f85">SignallingCall</a>.</p>
</div>
</div><p>
<a class="anchor" name="aa71c3294b1a073c3ad0b64a2ed6325a"></a><!-- doxytag: member="TelEngine::ISDNQ931Call::getObject" ref="aa71c3294b1a073c3ad0b64a2ed6325a" args="(const String &name) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void* getObject </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a pointer to a data member or this call <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>Object name </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The requested pointer or 0 if not exists </dd></dl>
<p>Reimplemented from <a class="el" href="classTelEngine_1_1GenObject.html#aa71c3294b1a073c3ad0b64a2ed6325a">GenObject</a>.</p>
</div>
</div><p>
<a class="anchor" name="ff30a449f6df391a323f2302386da9bc"></a><!-- doxytag: member="TelEngine::ISDNQ931Call::releaseComplete" ref="ff30a449f6df391a323f2302386da9bc" args="(const char *reason=0, const char *diag=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1SignallingEvent.html">SignallingEvent</a>* releaseComplete </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>reason</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>diag</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Send RELEASE COMPLETE if not in Null state. Clear all call data. Remove from controller's queue. Decrease the object's refence count <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>reason</em> </td><td>Optional release reason. If missing, the last reason is used </td></tr>
<tr><td valign="top"></td><td valign="top"><em>diag</em> </td><td>Optional hexified string for the cause diagnostic </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Pointer to an <a class="el" href="classTelEngine_1_1SignallingEvent.html" title="A single signalling related event.">SignallingEvent</a> of type Release, with no message </dd></dl>
</div>
</div><p>
<a class="anchor" name="fabf4b61e29a47f4ea1b6b8d0cb4882c"></a><!-- doxytag: member="TelEngine::ISDNQ931Call::sendEvent" ref="fabf4b61e29a47f4ea1b6b8d0cb4882c" args="(SignallingEvent *event)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool sendEvent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1SignallingEvent.html">SignallingEvent</a> * </td>
<td class="paramname"> <em>event</em> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Send an event to this call This method is thread safe <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>event</em> </td><td>The sent event </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if the operation succedded </dd></dl>
<p>Reimplemented from <a class="el" href="classTelEngine_1_1SignallingCall.html#fabf4b61e29a47f4ea1b6b8d0cb4882c">SignallingCall</a>.</p>
</div>
</div><p>
<a class="anchor" name="40e955f4a4d60cfff580811a7fc222e4"></a><!-- doxytag: member="TelEngine::ISDNQ931Call::setTerminate" ref="40e955f4a4d60cfff580811a7fc222e4" args="(bool destroy, const char *reason)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setTerminate </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>destroy</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>reason</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set termination (and destroy) flags This method is thread safe <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>destroy</em> </td><td>The destroy flag. If true, the call will be destroyed </td></tr>
<tr><td valign="top"></td><td valign="top"><em>reason</em> </td><td>Terminate reason </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:14 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
>
196
