<!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: ISDNQ921 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_1ISDNQ921.html">ISDNQ921</a> </div> </div> <div class="contents"> <h1>ISDNQ921 Class Reference</h1><!-- doxytag: class="TelEngine::ISDNQ921" --><!-- doxytag: inherits="TelEngine::ISDNLayer2,TelEngine::SignallingReceiver" -->ISDN Q.921 implementation on top of a hardware interface. <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 ISDNQ921:</div> <div class="dynsection"> <p><center><img src="classTelEngine_1_1ISDNQ921.png" usemap="#ISDNQ921_map" border="0" alt=""></center> <map name="ISDNQ921_map"> <area href="classTelEngine_1_1ISDNLayer2.html" alt="ISDNLayer2" shape="rect" coords="70,112,200,136"> <area href="classTelEngine_1_1SignallingReceiver.html" alt="SignallingReceiver" shape="rect" coords="350,112,480,136"> <area href="classTelEngine_1_1SignallingComponent.html" alt="SignallingComponent" shape="rect" coords="70,56,200,80"> <area href="classTelEngine_1_1SignallingComponent.html" alt="SignallingComponent" shape="rect" coords="350,56,480,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_1GenObject.html" alt="GenObject" shape="rect" coords="280,0,410,24"> <area href="classTelEngine_1_1DebugEnabler.html" alt="DebugEnabler" shape="rect" coords="420,0,550,24"> </map> </div> <p> <a href="classTelEngine_1_1ISDNQ921-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ISDNQ921.html#b8f2b817f8c7aa9a70315ceb599d5697">ISDNQ921</a> (const <a class="el" href="classTelEngine_1_1NamedList.html">NamedList</a> &params, 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_1ISDNQ921.html#024605ac440d5f1eafe314b03a3b7e3c">~ISDNQ921</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">u_int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ISDNQ921.html#aea671e0630d61456f4eedec96cb3d92">dataTimeout</a> () const </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_1ISDNQ921.html#5f90db9a745acf7a72873f31b403594f">multipleFrame</a> (bool establish, bool force)</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_1ISDNQ921.html#f3a7de973e9a72158dd243d398783574">sendData</a> (const <a class="el" href="classTelEngine_1_1DataBlock.html">DataBlock</a> &data, bool ack)</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_1ISDNQ921.html#09f4fe805fa9a54d4d68c5b29c1502e1">cleanup</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_1ISDNQ921.html#aa71c3294b1a073c3ad0b64a2ed6325a">getObject</a> (const <a class="el" href="classTelEngine_1_1String.html">String</a> &name) const </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_1ISDNQ921.html#757ca89703a72ac56715edb379958716">destruct</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_1ISDNQ921.html#31476688400a58f389ad2d7a35ff2f61">setDebug</a> (bool printFrames, bool extendedDebug)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ISDNQ921.html#9e5c784c528f39ad68c680587539d04a">setDumper</a> (<a class="el" href="classTelEngine_1_1SignallingDumper.html">SignallingDumper</a> *dumper=0)</td></tr> <tr><td colspan="2"><br><h2>Protected Member Functions</h2></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_1ISDNQ921.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">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ISDNQ921.html#e2f0cea80519672915fadd313eca986f">receivedPacket</a> (const <a class="el" href="classTelEngine_1_1DataBlock.html">DataBlock</a> &packet)</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_1ISDNQ921.html#0fb541a2a5718bcea726c7ac8f800cbf">notify</a> (<a class="el" href="classTelEngine_1_1SignallingInterface.html#9b7018c6a58f6d63a9446fea1f12ad89">SignallingInterface::Notification</a> event)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ISDNQ921.html#d20897c5c8bd47f5d4005989bead0e55">reset</a> ()</td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> ISDN Q.921 implementation on top of a hardware interface. <p> Q.921 ISDN Layer 2 implementation on top of a hardware HDLC interface <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="b8f2b817f8c7aa9a70315ceb599d5697"></a><!-- doxytag: member="TelEngine::ISDNQ921::ISDNQ921" ref="b8f2b817f8c7aa9a70315ceb599d5697" args="(const NamedList &params, const char *name=0)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classTelEngine_1_1ISDNQ921.html">ISDNQ921</a> </td> <td>(</td> <td class="paramtype">const <a class="el" href="classTelEngine_1_1NamedList.html">NamedList</a> & </td> <td class="paramname"> <em>params</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 Initialize this object and 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>params</em> </td><td>Layer's and <a class="el" href="classTelEngine_1_1ISDNLayer2.html">TelEngine::ISDNLayer2</a> parameters </td></tr> <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="024605ac440d5f1eafe314b03a3b7e3c"></a><!-- doxytag: member="TelEngine::ISDNQ921::~ISDNQ921" ref="024605ac440d5f1eafe314b03a3b7e3c" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual ~<a class="el" href="classTelEngine_1_1ISDNQ921.html">ISDNQ921</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> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="09f4fe805fa9a54d4d68c5b29c1502e1"></a><!-- doxytag: member="TelEngine::ISDNQ921::cleanup" ref="09f4fe805fa9a54d4d68c5b29c1502e1" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void cleanup </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Emergency release. Send 'disconnect' command. Reset all data. Set state to 'Released' This method is thread safe <p>Implements <a class="el" href="classTelEngine_1_1ISDNLayer2.html#8f94dc33a3804ab30f2d2289ccd0494a">ISDNLayer2</a>.</p> </div> </div><p> <a class="anchor" name="aea671e0630d61456f4eedec96cb3d92"></a><!-- doxytag: member="TelEngine::ISDNQ921::dataTimeout" ref="aea671e0630d61456f4eedec96cb3d92" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">u_int64_t dataTimeout </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Get the timeout of a data frame. After that, a higher layer may retransmit data <dl class="return" compact><dt><b>Returns:</b></dt><dd>The timeout of a data frame </dd></dl> </div> </div><p> <a class="anchor" name="757ca89703a72ac56715edb379958716"></a><!-- doxytag: member="TelEngine::ISDNQ921::destruct" ref="757ca89703a72ac56715edb379958716" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void destruct </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Detach links. Disposes memory <p>Reimplemented from <a class="el" href="classTelEngine_1_1GenObject.html#757ca89703a72ac56715edb379958716">GenObject</a>.</p> <p>References <a class="el" href="classTelEngine_1_1SignallingReceiver.html#6333a828444db99c0b21db1baf54c9c3">SignallingReceiver::attach()</a>, <a class="el" href="classTelEngine_1_1ISDNLayer2.html#5f193c8ad439c312c17acad5bbd4f1a6">ISDNLayer2::attach()</a>, and <a class="el" href="yateclass_8h-source.html#l00650">TelEngine::destruct()</a>.</p> </div> </div><p> <a class="anchor" name="aa71c3294b1a073c3ad0b64a2ed6325a"></a><!-- doxytag: member="TelEngine::ISDNQ921::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 layer <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="5f90db9a745acf7a72873f31b403594f"></a><!-- doxytag: member="TelEngine::ISDNQ921::multipleFrame" ref="5f90db9a745acf7a72873f31b403594f" args="(bool establish, bool force)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual bool multipleFrame </td> <td>(</td> <td class="paramtype">bool </td> <td class="paramname"> <em>establish</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"> <em>force</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Implements Q.921 DL-ESTABLISH and DL-RELEASE request primitives If accepted, the primitive is enqueued for further processing 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>establish</em> </td><td>True to establish. False to release </td></tr> <tr><td valign="top"></td><td valign="top"><em>force</em> </td><td>True to establish even if we already are in this mode. This parameter is ignored if establish is false </td></tr> </table> </dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd>True if the request was accepted </dd></dl> <p>Reimplemented from <a class="el" href="classTelEngine_1_1ISDNLayer2.html#5f90db9a745acf7a72873f31b403594f">ISDNLayer2</a>.</p> </div> </div><p> <a class="anchor" name="0fb541a2a5718bcea726c7ac8f800cbf"></a><!-- doxytag: member="TelEngine::ISDNQ921::notify" ref="0fb541a2a5718bcea726c7ac8f800cbf" args="(SignallingInterface::Notification event)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual bool notify </td> <td>(</td> <td class="paramtype"><a class="el" href="classTelEngine_1_1SignallingInterface.html#9b7018c6a58f6d63a9446fea1f12ad89">SignallingInterface::Notification</a> </td> <td class="paramname"> <em>event</em> </td> <td> ) </td> <td><code> [protected, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Process a notification generated by the attached interface 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>Notification event reported by the interface </td></tr> </table> </dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd>True if notification was processed </dd></dl> <p>Reimplemented from <a class="el" href="classTelEngine_1_1SignallingReceiver.html#0fb541a2a5718bcea726c7ac8f800cbf">SignallingReceiver</a>.</p> </div> </div><p> <a class="anchor" name="e2f0cea80519672915fadd313eca986f"></a><!-- doxytag: member="TelEngine::ISDNQ921::receivedPacket" ref="e2f0cea80519672915fadd313eca986f" args="(const DataBlock &packet)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual bool receivedPacket </td> <td>(</td> <td class="paramtype">const <a class="el" href="classTelEngine_1_1DataBlock.html">DataBlock</a> & </td> <td class="paramname"> <em>packet</em> </td> <td> ) </td> <td><code> [protected, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Process a packet received by the receiver's interface 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>packet</em> </td><td>The received packet </td></tr> </table> </dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd>True if message was successfully processed </dd></dl> <p>Implements <a class="el" href="classTelEngine_1_1SignallingReceiver.html#66945d03318ad13a436f2ae5e55087fe">SignallingReceiver</a>.</p> </div> </div><p> <a class="anchor" name="d20897c5c8bd47f5d4005989bead0e55"></a><!-- doxytag: member="TelEngine::ISDNQ921::reset" ref="d20897c5c8bd47f5d4005989bead0e55" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void reset </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Reset object if not in Released state. Drop all frames This method is thread safe </div> </div><p> <a class="anchor" name="f3a7de973e9a72158dd243d398783574"></a><!-- doxytag: member="TelEngine::ISDNQ921::sendData" ref="f3a7de973e9a72158dd243d398783574" args="(const DataBlock &data, bool ack)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual bool sendData </td> <td>(</td> <td class="paramtype">const <a class="el" href="classTelEngine_1_1DataBlock.html">DataBlock</a> & </td> <td class="paramname"> <em>data</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"> <em>ack</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Implements Q.921 DL-DATA and DL-UNIT DATA request primitives Send data through the HDLC interface 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>data</em> </td><td>Data to send </td></tr> <tr><td valign="top"></td><td valign="top"><em>ack</em> </td><td>True to send an acknoledged frame, false to send an unacknoledged one </td></tr> </table> </dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd>False if the request was not accepted or send operation failed </dd></dl> <p>Reimplemented from <a class="el" href="classTelEngine_1_1ISDNLayer2.html#f3a7de973e9a72158dd243d398783574">ISDNLayer2</a>.</p> </div> </div><p> <a class="anchor" name="31476688400a58f389ad2d7a35ff2f61"></a><!-- doxytag: member="TelEngine::ISDNQ921::setDebug" ref="31476688400a58f389ad2d7a35ff2f61" args="(bool printFrames, bool extendedDebug)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void setDebug </td> <td>(</td> <td class="paramtype">bool </td> <td class="paramname"> <em>printFrames</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"> <em>extendedDebug</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Set debug data of this layer <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>printFrames</em> </td><td>Enable/disable frame printing on output </td></tr> <tr><td valign="top"></td><td valign="top"><em>extendedDebug</em> </td><td>Enable/disable hex data dump if print frames is enabled </td></tr> </table> </dl> </div> </div><p> <a class="anchor" name="9e5c784c528f39ad68c680587539d04a"></a><!-- doxytag: member="TelEngine::ISDNQ921::setDumper" ref="9e5c784c528f39ad68c680587539d04a" args="(SignallingDumper *dumper=0)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void setDumper </td> <td>(</td> <td class="paramtype"><a class="el" href="classTelEngine_1_1SignallingDumper.html">SignallingDumper</a> * </td> <td class="paramname"> <em>dumper</em> = <code>0</code> </td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p> Set or remove a data dumper <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>dumper</em> </td><td>Pointer to the data dumper object, 0 to remove </td></tr> </table> </dl> </div> </div><p> <a class="anchor" name="c7cf24f02cfa3147bf2cbf6434edb9c0"></a><!-- doxytag: member="TelEngine::ISDNQ921::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 to check timeouts 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><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 from <a class="el" href="classTelEngine_1_1SignallingComponent.html#c7cf24f02cfa3147bf2cbf6434edb9c0">SignallingComponent</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 <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>