Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > eeacaa4eb55fa544d622989e42fc27b1 > files > 199

libyate-devel-2.0.0-2mdv2009.1.i586.rpm

<!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: ISDNQ931CallMonitor 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&nbsp;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&nbsp;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
  <div class="navpath"><a class="el" href="namespaceTelEngine.html">TelEngine</a>::<a class="el" href="classTelEngine_1_1ISDNQ931CallMonitor.html">ISDNQ931CallMonitor</a>
  </div>
</div>
<div class="contents">
<h1>ISDNQ931CallMonitor Class Reference</h1><!-- doxytag: class="TelEngine::ISDNQ931CallMonitor" --><!-- doxytag: inherits="TelEngine::ISDNQ931State,TelEngine::SignallingCall" -->A Q.931 ISDN call monitor.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="yatesig_8h-source.html">yatesig.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for ISDNQ931CallMonitor:</div>
<div class="dynsection">

<p><center><img src="classTelEngine_1_1ISDNQ931CallMonitor.png" usemap="#ISDNQ931CallMonitor_map" border="0" alt=""></center>
<map name="ISDNQ931CallMonitor_map">
<area href="classTelEngine_1_1ISDNQ931State.html" alt="ISDNQ931State" shape="rect" coords="0,112,137,136">
<area href="classTelEngine_1_1SignallingCall.html" alt="SignallingCall" shape="rect" coords="147,112,284,136">
<area href="classTelEngine_1_1RefObject.html" alt="RefObject" shape="rect" coords="147,56,284,80">
<area href="classTelEngine_1_1GenObject.html" alt="GenObject" shape="rect" coords="147,0,284,24">
</map>
</div>

<p>
<a href="classTelEngine_1_1ISDNQ931CallMonitor-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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ISDNQ931CallMonitor.html#30709eec0cf3435cc234c95df8b5036a">~ISDNQ931CallMonitor</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ISDNQ931CallMonitor.html#a6f5714904b08b70e482cec97276dc40">netInit</a> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classTelEngine_1_1SignallingEvent.html">SignallingEvent</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ISDNQ931CallMonitor.html#60b984499483882d3ed71e6888a79201">getEvent</a> (const <a class="el" href="classTelEngine_1_1Time.html">Time</a> &amp;when)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ISDNQ931CallMonitor.html#d159a160e7888bca4c2b089c12141265">setTerminate</a> (const char *reason)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ISDNQ931CallMonitor.html#aa71c3294b1a073c3ad0b64a2ed6325a">getObject</a> (const <a class="el" href="classTelEngine_1_1String.html">String</a> &amp;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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ISDNQ931CallMonitor.html#4d35ea24366afb24fa5243ba6828707f">ISDNQ931CallMonitor</a> (<a class="el" href="classTelEngine_1_1ISDNQ931Monitor.html">ISDNQ931Monitor</a> *controller, u_int32_t callRef, bool netInit)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1SignallingEvent.html">SignallingEvent</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ISDNQ931CallMonitor.html#3aae2ad6d7f91285564b7c2b96de48f5">releaseComplete</a> (const char *reason=0)</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="4183a5a7b893ce2d1e09e95e6a3db8da"></a><!-- doxytag: member="TelEngine::ISDNQ931CallMonitor::ISDNQ931Monitor" ref="4183a5a7b893ce2d1e09e95e6a3db8da" args="" -->
class&nbsp;</td><td class="memItemRight" valign="bottom"><b>ISDNQ931Monitor</b></td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A Q.931 ISDN call monitor. 
<p>
Q.931 ISDN call monitor <hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="30709eec0cf3435cc234c95df8b5036a"></a><!-- doxytag: member="TelEngine::ISDNQ931CallMonitor::~ISDNQ931CallMonitor" ref="30709eec0cf3435cc234c95df8b5036a" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual ~<a class="el" href="classTelEngine_1_1ISDNQ931CallMonitor.html">ISDNQ931CallMonitor</a>           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Destructor 
</div>
</div><p>
<a class="anchor" name="4d35ea24366afb24fa5243ba6828707f"></a><!-- doxytag: member="TelEngine::ISDNQ931CallMonitor::ISDNQ931CallMonitor" ref="4d35ea24366afb24fa5243ba6828707f" args="(ISDNQ931Monitor *controller, u_int32_t callRef, bool netInit)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classTelEngine_1_1ISDNQ931CallMonitor.html">ISDNQ931CallMonitor</a>           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classTelEngine_1_1ISDNQ931Monitor.html">ISDNQ931Monitor</a> *&nbsp;</td>
          <td class="paramname"> <em>controller</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u_int32_t&nbsp;</td>
          <td class="paramname"> <em>callRef</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>netInit</em></td><td>&nbsp;</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>&nbsp;</td><td>The call controller </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>callRef</em>&nbsp;</td><td>The call reference </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>netInit</em>&nbsp;</td><td>True if the initiator is from the network side of the link </td></tr>
  </table>
</dl>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="60b984499483882d3ed71e6888a79201"></a><!-- doxytag: member="TelEngine::ISDNQ931CallMonitor::getEvent" ref="60b984499483882d3ed71e6888a79201" args="(const Time &amp;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> &amp;&nbsp;</td>
          <td class="paramname"> <em>when</em>          </td>
          <td>&nbsp;)&nbsp;</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>&nbsp;</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::ISDNQ931CallMonitor::getObject" ref="aa71c3294b1a073c3ad0b64a2ed6325a" args="(const String &amp;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> &amp;&nbsp;</td>
          <td class="paramname"> <em>name</em>          </td>
          <td>&nbsp;)&nbsp;</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>&nbsp;</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="a6f5714904b08b70e482cec97276dc40"></a><!-- doxytag: member="TelEngine::ISDNQ931CallMonitor::netInit" ref="a6f5714904b08b70e482cec97276dc40" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool netInit           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Check if the initiator is from the network side of the data link <dl class="return" compact><dt><b>Returns:</b></dt><dd>True if the initiator is from the network side of the data link, false if it is from the user side </dd></dl>

</div>
</div><p>
<a class="anchor" name="3aae2ad6d7f91285564b7c2b96de48f5"></a><!-- doxytag: member="TelEngine::ISDNQ931CallMonitor::releaseComplete" ref="3aae2ad6d7f91285564b7c2b96de48f5" args="(const char *reason=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 *&nbsp;</td>
          <td class="paramname"> <em>reason</em> = <code>0</code>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
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>&nbsp;</td><td>Optional release reason. If missing, the last reason is used </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 </dd></dl>

</div>
</div><p>
<a class="anchor" name="d159a160e7888bca4c2b089c12141265"></a><!-- doxytag: member="TelEngine::ISDNQ931CallMonitor::setTerminate" ref="d159a160e7888bca4c2b089c12141265" args="(const char *reason)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void setTerminate           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>reason</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set termination flag 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>reason</em>&nbsp;</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&nbsp;
<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>