Sophie

Sophie

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

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: ISDNLayer3 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_1ISDNLayer3.html">ISDNLayer3</a>
  </div>
</div>
<div class="contents">
<h1>ISDNLayer3 Class Reference</h1><!-- doxytag: class="TelEngine::ISDNLayer3" --><!-- doxytag: inherits="TelEngine::SignallingComponent" -->Abstract ISDN layer 3 (Q.931) message transport.  
<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 ISDNLayer3:</div>
<div class="dynsection">

<p><center><img src="classTelEngine_1_1ISDNLayer3.png" usemap="#ISDNLayer3_map" border="0" alt=""></center>
<map name="ISDNLayer3_map">
<area href="classTelEngine_1_1SignallingComponent.html" alt="SignallingComponent" shape="rect" coords="70,56,200,80">
<area href="classTelEngine_1_1GenObject.html" alt="GenObject" shape="rect" coords="0,0,130,24">
<area href="classTelEngine_1_1DebugEnabler.html" alt="DebugEnabler" shape="rect" coords="140,0,270,24">
<area href="classTelEngine_1_1ISDNQ931.html" alt="ISDNQ931" shape="rect" coords="0,168,130,192">
<area href="classTelEngine_1_1ISDNQ931Monitor.html" alt="ISDNQ931Monitor" shape="rect" coords="140,168,270,192">
</map>
</div>

<p>
<a href="classTelEngine_1_1ISDNLayer3-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 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ISDNLayer3.html#bdd08bc9811a3eb0a2f63c6b1bf24f9a">multipleFrameEstablished</a> (bool confirm, bool timeout, <a class="el" href="classTelEngine_1_1ISDNLayer2.html">ISDNLayer2</a> *layer2)</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_1ISDNLayer3.html#6ddca8794e7d21697b6b3450a668f718">multipleFrameReleased</a> (bool confirm, bool timeout, <a class="el" href="classTelEngine_1_1ISDNLayer2.html">ISDNLayer2</a> *layer2)</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_1ISDNLayer3.html#9a9fbb725bc7ea16941bdcb6008d9f5e">dataLinkState</a> (bool cmd, bool value, <a class="el" href="classTelEngine_1_1ISDNLayer2.html">ISDNLayer2</a> *layer2)</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_1ISDNLayer3.html#9f1f4242bbe660fea71c751ea09f74e6">idleTimeout</a> (<a class="el" href="classTelEngine_1_1ISDNLayer2.html">ISDNLayer2</a> *layer2)</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_1ISDNLayer3.html#d5142ec09d49c30da0cc79699b3dab02">receiveData</a> (const <a class="el" href="classTelEngine_1_1DataBlock.html">DataBlock</a> &amp;data, bool ack, <a class="el" href="classTelEngine_1_1ISDNLayer2.html">ISDNLayer2</a> *layer2)=0</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_1ISDNLayer3.html#b1ec5f1490b8eec88f39bf6d68b4606b">attach</a> (<a class="el" href="classTelEngine_1_1ISDNLayer2.html">ISDNLayer2</a> *layer2)</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_1ISDNLayer3.html#244759d60ac633e4d3af910d6064749d">ISDNLayer3</a> (const char *name=0)</td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Abstract ISDN layer 3 (Q.931) message transport. 
<p>
An interface to a Layer 3 (Q.931) ISDN message transport <hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="244759d60ac633e4d3af910d6064749d"></a><!-- doxytag: member="TelEngine::ISDNLayer3::ISDNLayer3" ref="244759d60ac633e4d3af910d6064749d" args="(const char *name=0)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classTelEngine_1_1ISDNLayer3.html">ISDNLayer3</a>           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>name</em> = <code>0</code>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline, protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Constructor Initialize the component <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>Name of this component </td></tr>
  </table>
</dl>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="b1ec5f1490b8eec88f39bf6d68b4606b"></a><!-- doxytag: member="TelEngine::ISDNLayer3::attach" ref="b1ec5f1490b8eec88f39bf6d68b4606b" args="(ISDNLayer2 *layer2)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void attach           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classTelEngine_1_1ISDNLayer2.html">ISDNLayer2</a> *&nbsp;</td>
          <td class="paramname"> <em>layer2</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Attach an ISDN Q.921 Layer 2 <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>layer2</em>&nbsp;</td><td>Pointer to the Q.921 Layer 2 to attach </td></tr>
  </table>
</dl>

<p>Reimplemented in <a class="el" href="classTelEngine_1_1ISDNQ931.html#591de01f261471ceac34b8f425890bef">ISDNQ931</a>.</p>

</div>
</div><p>
<a class="anchor" name="9a9fbb725bc7ea16941bdcb6008d9f5e"></a><!-- doxytag: member="TelEngine::ISDNLayer3::dataLinkState" ref="9a9fbb725bc7ea16941bdcb6008d9f5e" args="(bool cmd, bool value, ISDNLayer2 *layer2)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void dataLinkState           </td>
          <td>(</td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>cmd</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>value</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classTelEngine_1_1ISDNLayer2.html">ISDNLayer2</a> *&nbsp;</td>
          <td class="paramname"> <em>layer2</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Notification from layer 2 of data link set/release command or response Used for stateless layer 2 <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>cmd</em>&nbsp;</td><td>True if received a command, false if received a response </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>value</em>&nbsp;</td><td>The value of the notification If 'cmd' is true (command), the value is true if a request to establish data link was received or false if received a request to release data link If 'cmd' is false (response), the value is the response </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>layer2</em>&nbsp;</td><td>Pointer to the notifier </td></tr>
  </table>
</dl>

<p>Reimplemented in <a class="el" href="classTelEngine_1_1ISDNQ931Monitor.html#9a9fbb725bc7ea16941bdcb6008d9f5e">ISDNQ931Monitor</a>.</p>

</div>
</div><p>
<a class="anchor" name="9f1f4242bbe660fea71c751ea09f74e6"></a><!-- doxytag: member="TelEngine::ISDNLayer3::idleTimeout" ref="9f1f4242bbe660fea71c751ea09f74e6" args="(ISDNLayer2 *layer2)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void idleTimeout           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classTelEngine_1_1ISDNLayer2.html">ISDNLayer2</a> *&nbsp;</td>
          <td class="paramname"> <em>layer2</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Notification from layer 2 of data link idle timeout Used for stateless layer 2 <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>layer2</em>&nbsp;</td><td>Pointer to the notifier </td></tr>
  </table>
</dl>

<p>Reimplemented in <a class="el" href="classTelEngine_1_1ISDNQ931Monitor.html#9f1f4242bbe660fea71c751ea09f74e6">ISDNQ931Monitor</a>.</p>

</div>
</div><p>
<a class="anchor" name="bdd08bc9811a3eb0a2f63c6b1bf24f9a"></a><!-- doxytag: member="TelEngine::ISDNLayer3::multipleFrameEstablished" ref="bdd08bc9811a3eb0a2f63c6b1bf24f9a" args="(bool confirm, bool timeout, ISDNLayer2 *layer2)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void multipleFrameEstablished           </td>
          <td>(</td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>confirm</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>timeout</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classTelEngine_1_1ISDNLayer2.html">ISDNLayer2</a> *&nbsp;</td>
          <td class="paramname"> <em>layer2</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Implements Q.921 DL-ESTABLISH indication/confirmation primitive: 'multiple frame acknoledged' mode established <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>confirm</em>&nbsp;</td><td>True if this is a confirmation of a previous request. False if it is an indication of state change on remote request </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>timeout</em>&nbsp;</td><td>True if the reason is a timeout </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>layer2</em>&nbsp;</td><td>Pointer to the notifier </td></tr>
  </table>
</dl>

<p>Reimplemented in <a class="el" href="classTelEngine_1_1ISDNQ931.html#bdd08bc9811a3eb0a2f63c6b1bf24f9a">ISDNQ931</a>.</p>

</div>
</div><p>
<a class="anchor" name="6ddca8794e7d21697b6b3450a668f718"></a><!-- doxytag: member="TelEngine::ISDNLayer3::multipleFrameReleased" ref="6ddca8794e7d21697b6b3450a668f718" args="(bool confirm, bool timeout, ISDNLayer2 *layer2)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void multipleFrameReleased           </td>
          <td>(</td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>confirm</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>timeout</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classTelEngine_1_1ISDNLayer2.html">ISDNLayer2</a> *&nbsp;</td>
          <td class="paramname"> <em>layer2</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Implements Q.921 DL-RELEASE indication/confirmation primitive: 'multiple frame acknoledged' mode released <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>confirm</em>&nbsp;</td><td>True if this is a confirmation of a previous request. False if it is an indication of state change on remote request </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>timeout</em>&nbsp;</td><td>True if the reason is a timeout. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>layer2</em>&nbsp;</td><td>Pointer to the notifier </td></tr>
  </table>
</dl>

<p>Reimplemented in <a class="el" href="classTelEngine_1_1ISDNQ931.html#6ddca8794e7d21697b6b3450a668f718">ISDNQ931</a>.</p>

</div>
</div><p>
<a class="anchor" name="d5142ec09d49c30da0cc79699b3dab02"></a><!-- doxytag: member="TelEngine::ISDNLayer3::receiveData" ref="d5142ec09d49c30da0cc79699b3dab02" args="(const DataBlock &amp;data, bool ack, ISDNLayer2 *layer2)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void receiveData           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classTelEngine_1_1DataBlock.html">DataBlock</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>data</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>ack</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classTelEngine_1_1ISDNLayer2.html">ISDNLayer2</a> *&nbsp;</td>
          <td class="paramname"> <em>layer2</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Implements Q.921 DL-DATA and DL-UNIT DATA indication primitives Receive data from remote peer <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>data</em>&nbsp;</td><td>Received data </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>ack</em>&nbsp;</td><td>True if data is an acknoledged frame, false if it is an unacknoledged one </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>layer2</em>&nbsp;</td><td>Pointer to the sender </td></tr>
  </table>
</dl>

<p>Implemented in <a class="el" href="classTelEngine_1_1ISDNQ931.html#7855282c3ae092787b79dc3d3ae7cb3b">ISDNQ931</a>, and <a class="el" href="classTelEngine_1_1ISDNQ931Monitor.html#7855282c3ae092787b79dc3d3ae7cb3b">ISDNQ931Monitor</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: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>