<!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: ISDNQ931Message 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_1ISDNQ931Message.html">ISDNQ931Message</a>
</div>
</div>
<div class="contents">
<h1>ISDNQ931Message Class Reference</h1><!-- doxytag: class="TelEngine::ISDNQ931Message" --><!-- doxytag: inherits="TelEngine::SignallingMessage" -->A Q.931 ISDN Layer 3 message.
<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 ISDNQ931Message:</div>
<div class="dynsection">
<p><center><img src="classTelEngine_1_1ISDNQ931Message.png" usemap="#ISDNQ931Message_map" border="0" alt=""></center>
<map name="ISDNQ931Message_map">
<area href="classTelEngine_1_1SignallingMessage.html" alt="SignallingMessage" shape="rect" coords="0,112,123,136">
<area href="classTelEngine_1_1RefObject.html" alt="RefObject" shape="rect" coords="0,56,123,80">
<area href="classTelEngine_1_1GenObject.html" alt="GenObject" shape="rect" coords="0,0,123,24">
</map>
</div>
<p>
<a href="classTelEngine_1_1ISDNQ931Message-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_1ISDNQ931Message.html#1d1cfd8ffb84e947f82999c682b666a7">Type</a> { <br>
<b>Alerting</b> = 0x01,
<b>Proceeding</b> = 0x02,
<b>Connect</b> = 0x07,
<b>ConnectAck</b> = 0x0f,
<br>
<b>Progress</b> = 0x03,
<b>Setup</b> = 0x05,
<b>SetupAck</b> = 0x0d,
<b>Resume</b> = 0x26,
<br>
<b>ResumeAck</b> = 0x2e,
<b>ResumeRej</b> = 0x22,
<b>Suspend</b> = 0x25,
<b>SuspendAck</b> = 0x2d,
<br>
<b>SuspendRej</b> = 0x21,
<b>UserInfo</b> = 0x20,
<b>Disconnect</b> = 0x45,
<b>Release</b> = 0x4d,
<br>
<b>ReleaseComplete</b> = 0x5a,
<b>Restart</b> = 0x46,
<b>RestartAck</b> = 0x4e,
<b>Segment</b> = 0x60,
<br>
<b>CongestionCtrl</b> = 0x79,
<b>Info</b> = 0x7b,
<b>Notify</b> = 0x6e,
<b>Status</b> = 0x7d,
<br>
<b>StatusEnquiry</b> = 0x75
<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_1ISDNQ931Message.html#3a07137d6d9ab1ee75c16d9a0448a83b">ISDNQ931Message</a> (<a class="el" href="classTelEngine_1_1ISDNQ931Message.html#1d1cfd8ffb84e947f82999c682b666a7">Type</a> type, bool initiator, u_int32_t callRef, u_int8_t callRefLen)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ISDNQ931Message.html#2040aebebebfbe9fc2aa21767d68baf1">ISDNQ931Message</a> (<a class="el" href="classTelEngine_1_1ISDNQ931Message.html#1d1cfd8ffb84e947f82999c682b666a7">Type</a> type)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ISDNQ931Message.html#dd908fc10104f5c0a7e2dd4861fb43ba">ISDNQ931Message</a> (<a class="el" href="classTelEngine_1_1ISDNQ931Message.html#1d1cfd8ffb84e947f82999c682b666a7">Type</a> type, <a class="el" href="classTelEngine_1_1ISDNQ931Call.html">ISDNQ931Call</a> *call)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ISDNQ931Message.html#5b5f61614abc22e8901addb73afa8f5b">~ISDNQ931Message</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1ISDNQ931Message.html#1d1cfd8ffb84e947f82999c682b666a7">Type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ISDNQ931Message.html#fbd0fa31db28593e9669c3c56711c0a7">type</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ISDNQ931Message.html#2ad6cc0173d0cf5aa8e4623d211e1c46">initiator</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_1ISDNQ931Message.html#bc8731036e842a83978447146753661b">callRef</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u_int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ISDNQ931Message.html#8419754732c9a0c07f66b2e26be54cc2">callRefLen</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ISDNQ931Message.html#afde1faea55eff4282cefbbb0886d239">dummyCallRef</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ISDNQ931Message.html#e51ab430f6977454fbb5e8696ade5164">unknownMandatory</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ISDNQ931Message.html#542c9ae0b0a42b0d07a07bf7641d215b">setUnknownMandatory</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1ObjList.html">ObjList</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ISDNQ931Message.html#0ad4d0e4527cd08b6c832629a6dc2c73">ieList</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1ISDNQ931IE.html">ISDNQ931IE</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ISDNQ931Message.html#6acfe493d68deb5d1f2716dfd2d0daad">getIE</a> (<a class="el" href="classTelEngine_1_1ISDNQ931IE.html#1d1cfd8ffb84e947f82999c682b666a7">ISDNQ931IE::Type</a> type, <a class="el" href="classTelEngine_1_1ISDNQ931IE.html">ISDNQ931IE</a> *base=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1ISDNQ931IE.html">ISDNQ931IE</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ISDNQ931Message.html#4f3a9522320648e45f043a33b81a780b">removeIE</a> (<a class="el" href="classTelEngine_1_1ISDNQ931IE.html#1d1cfd8ffb84e947f82999c682b666a7">ISDNQ931IE::Type</a> type, <a class="el" href="classTelEngine_1_1ISDNQ931IE.html">ISDNQ931IE</a> *base=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ISDNQ931Message.html#e6d6a9bff2425468a72236828a70c3bc">getIEValue</a> (<a class="el" href="classTelEngine_1_1ISDNQ931IE.html#1d1cfd8ffb84e947f82999c682b666a7">ISDNQ931IE::Type</a> type, const char *param, const char *defVal=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1ISDNQ931IE.html">ISDNQ931IE</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ISDNQ931Message.html#128b197be444c04f860699107523fc79">appendIEValue</a> (<a class="el" href="classTelEngine_1_1ISDNQ931IE.html#1d1cfd8ffb84e947f82999c682b666a7">ISDNQ931IE::Type</a> type, const char *param, const char *value)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ISDNQ931Message.html#0ff1b9d17fc1d91169c054bb6c2a1229">append</a> (<a class="el" href="classTelEngine_1_1ISDNQ931IE.html">ISDNQ931IE</a> *ie)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ISDNQ931Message.html#f7eae4ac1dd48a82ba1e16b15cf498ff">appendSafe</a> (<a class="el" href="classTelEngine_1_1ISDNQ931IE.html">ISDNQ931IE</a> *ie)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ISDNQ931Message.html#43e445f6d113e60dc80ba02d91afe258">toString</a> (<a class="el" href="classTelEngine_1_1String.html">String</a> &dest, bool extendedDebug, const char *indent=0) 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_1ISDNQ931Message.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">u_int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ISDNQ931Message.html#5c777392fdf177aeda6fec7d3e65a72b">encode</a> (<a class="el" href="classTelEngine_1_1ISDNQ931ParserData.html">ISDNQ931ParserData</a> &parserData, <a class="el" href="classTelEngine_1_1ObjList.html">ObjList</a> &dest)</td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classTelEngine_1_1ISDNQ931Message.html">ISDNQ931Message</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ISDNQ931Message.html#ca45df6ee506ebcb9d8d7b81da960b4f">parse</a> (<a class="el" href="classTelEngine_1_1ISDNQ931ParserData.html">ISDNQ931ParserData</a> &parserData, const <a class="el" href="classTelEngine_1_1DataBlock.html">DataBlock</a> &buffer, <a class="el" href="classTelEngine_1_1DataBlock.html">DataBlock</a> *segData)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ISDNQ931Message.html#e122df3be75f38741fd497b58f303cea">typeName</a> (int t)</td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1DataBlock.html">DataBlock</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ISDNQ931Message.html#3aa804a6c140137d54c8298df9e2729d">m_buffer</a></td></tr>
<tr><td colspan="2"><br><h2>Static Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="structTelEngine_1_1TokenDict.html">TokenDict</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1ISDNQ931Message.html#ca156cbdad5f00431ea3a797881e0003">s_type</a> []</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A Q.931 ISDN Layer 3 message.
<p>
Q.931 ISDN Layer 3 message <hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="1d1cfd8ffb84e947f82999c682b666a7"></a><!-- doxytag: member="TelEngine::ISDNQ931Message::Type" ref="1d1cfd8ffb84e947f82999c682b666a7" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classTelEngine_1_1ISDNQ931Message.html#1d1cfd8ffb84e947f82999c682b666a7">Type</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<a class="el" href="classTelEngine_1_1Message.html" title="A message container class.">Message</a> type enumeration
</div>
</div><p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="3a07137d6d9ab1ee75c16d9a0448a83b"></a><!-- doxytag: member="TelEngine::ISDNQ931Message::ISDNQ931Message" ref="3a07137d6d9ab1ee75c16d9a0448a83b" args="(Type type, bool initiator, 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_1ISDNQ931Message.html">ISDNQ931Message</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1ISDNQ931Message.html#1d1cfd8ffb84e947f82999c682b666a7">Type</a> </td>
<td class="paramname"> <em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>initiator</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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor Constructs a message from given data. Used for incoming messages <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td><a class="el" href="classTelEngine_1_1Message.html" title="A message container class.">Message</a> type </td></tr>
<tr><td valign="top"></td><td valign="top"><em>initiator</em> </td><td>The call initiator flag: True: this is the initiator </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 </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="2040aebebebfbe9fc2aa21767d68baf1"></a><!-- doxytag: member="TelEngine::ISDNQ931Message::ISDNQ931Message" ref="2040aebebebfbe9fc2aa21767d68baf1" args="(Type type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1ISDNQ931Message.html">ISDNQ931Message</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1ISDNQ931Message.html#1d1cfd8ffb84e947f82999c682b666a7">Type</a> </td>
<td class="paramname"> <em>type</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor Constructs a message with dummy call reference <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td><a class="el" href="classTelEngine_1_1Message.html" title="A message container class.">Message</a> type </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="dd908fc10104f5c0a7e2dd4861fb43ba"></a><!-- doxytag: member="TelEngine::ISDNQ931Message::ISDNQ931Message" ref="dd908fc10104f5c0a7e2dd4861fb43ba" args="(Type type, ISDNQ931Call *call)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1ISDNQ931Message.html">ISDNQ931Message</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1ISDNQ931Message.html#1d1cfd8ffb84e947f82999c682b666a7">Type</a> </td>
<td class="paramname"> <em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1ISDNQ931Call.html">ISDNQ931Call</a> * </td>
<td class="paramname"> <em>call</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor Constructs a message for a given call. Used for outgoing messages <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td><a class="el" href="classTelEngine_1_1Message.html" title="A message container class.">Message</a> type </td></tr>
<tr><td valign="top"></td><td valign="top"><em>call</em> </td><td>The call this message belongs to </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="5b5f61614abc22e8901addb73afa8f5b"></a><!-- doxytag: member="TelEngine::ISDNQ931Message::~ISDNQ931Message" ref="5b5f61614abc22e8901addb73afa8f5b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ~<a class="el" href="classTelEngine_1_1ISDNQ931Message.html">ISDNQ931Message</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="0ff1b9d17fc1d91169c054bb6c2a1229"></a><!-- doxytag: member="TelEngine::ISDNQ931Message::append" ref="0ff1b9d17fc1d91169c054bb6c2a1229" args="(ISDNQ931IE *ie)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool append </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1ISDNQ931IE.html">ISDNQ931IE</a> * </td>
<td class="paramname"> <em>ie</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Append an information element to this message <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ie</em> </td><td>Information element to add </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if the IE was added or replaced, false if it was invalid </dd></dl>
<p>References <a class="el" href="classTelEngine_1_1String.html#de42fa933397d05aaf223736acdb6725">String::append()</a>.</p>
</div>
</div><p>
<a class="anchor" name="128b197be444c04f860699107523fc79"></a><!-- doxytag: member="TelEngine::ISDNQ931Message::appendIEValue" ref="128b197be444c04f860699107523fc79" args="(ISDNQ931IE::Type type, const char *param, const char *value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1ISDNQ931IE.html">ISDNQ931IE</a>* appendIEValue </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1ISDNQ931IE.html#1d1cfd8ffb84e947f82999c682b666a7">ISDNQ931IE::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>param</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>value</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>
Append an IE with a given parameter <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>IE's type </td></tr>
<tr><td valign="top"></td><td valign="top"><em>param</em> </td><td>IE's parameter. Set to 0 to use IE's name </td></tr>
<tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>IE parameter's value </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Pointer to the requested value or 0 </dd></dl>
<p>References <a class="el" href="classTelEngine_1_1NamedList.html#c02d6feff01a4579770c1c25bec4be98">NamedList::addParam()</a>, and <a class="el" href="yateclass_8h-source.html#l01296">String::c_str()</a>.</p>
</div>
</div><p>
<a class="anchor" name="f7eae4ac1dd48a82ba1e16b15cf498ff"></a><!-- doxytag: member="TelEngine::ISDNQ931Message::appendSafe" ref="f7eae4ac1dd48a82ba1e16b15cf498ff" args="(ISDNQ931IE *ie)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool appendSafe </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1ISDNQ931IE.html">ISDNQ931IE</a> * </td>
<td class="paramname"> <em>ie</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Append/insert an information element to this message. Check the IE list consistency The given IE is 'consumed': deleted or appended to the list <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ie</em> </td><td>Information element to add </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if the IE was added or replaced, false if it was invalid </dd></dl>
</div>
</div><p>
<a class="anchor" name="bc8731036e842a83978447146753661b"></a><!-- doxytag: member="TelEngine::ISDNQ931Message::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 the call this message belongs to <dl class="return" compact><dt><b>Returns:</b></dt><dd>The call reference </dd></dl>
</div>
</div><p>
<a class="anchor" name="8419754732c9a0c07f66b2e26be54cc2"></a><!-- doxytag: member="TelEngine::ISDNQ931Message::callRefLen" ref="8419754732c9a0c07f66b2e26be54cc2" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u_int8_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>
</div>
</div><p>
<a class="anchor" name="afde1faea55eff4282cefbbb0886d239"></a><!-- doxytag: member="TelEngine::ISDNQ931Message::dummyCallRef" ref="afde1faea55eff4282cefbbb0886d239" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool dummyCallRef </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if this message has a dummy call reference <dl class="return" compact><dt><b>Returns:</b></dt><dd>True if this message has a dummy call reference </dd></dl>
</div>
</div><p>
<a class="anchor" name="5c777392fdf177aeda6fec7d3e65a72b"></a><!-- doxytag: member="TelEngine::ISDNQ931Message::encode" ref="5c777392fdf177aeda6fec7d3e65a72b" args="(ISDNQ931ParserData &parserData, ObjList &dest)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u_int8_t encode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1ISDNQ931ParserData.html">ISDNQ931ParserData</a> & </td>
<td class="paramname"> <em>parserData</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1ObjList.html">ObjList</a> & </td>
<td class="paramname"> <em>dest</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Encode this message If message segmentation is allowed and the message is longer then maximum allowed, split it into Segment messages <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>parserData</em> </td><td>The parser settings </td></tr>
<tr><td valign="top"></td><td valign="top"><em>dest</em> </td><td>The destination list. If 1 is returned the list contains a DataBuffer with this message. If more then 1 is returned, the list is filled with data buffers with Segment messages </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The number of segments on success or 0 on failure. </dd></dl>
</div>
</div><p>
<a class="anchor" name="6acfe493d68deb5d1f2716dfd2d0daad"></a><!-- doxytag: member="TelEngine::ISDNQ931Message::getIE" ref="6acfe493d68deb5d1f2716dfd2d0daad" args="(ISDNQ931IE::Type type, ISDNQ931IE *base=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1ISDNQ931IE.html">ISDNQ931IE</a>* getIE </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1ISDNQ931IE.html#1d1cfd8ffb84e947f82999c682b666a7">ISDNQ931IE::Type</a> </td>
<td class="paramname"> <em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1ISDNQ931IE.html">ISDNQ931IE</a> * </td>
<td class="paramname"> <em>base</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>
Get a pointer to the first IE with the given type <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>Requested IE's type </td></tr>
<tr><td valign="top"></td><td valign="top"><em>base</em> </td><td>Optional search starting element. If 0, search is started from the first IE following base </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Pointer to the IE or 0 if not found </dd></dl>
</div>
</div><p>
<a class="anchor" name="e6d6a9bff2425468a72236828a70c3bc"></a><!-- doxytag: member="TelEngine::ISDNQ931Message::getIEValue" ref="e6d6a9bff2425468a72236828a70c3bc" args="(ISDNQ931IE::Type type, const char *param, const char *defVal=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* getIEValue </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1ISDNQ931IE.html#1d1cfd8ffb84e947f82999c682b666a7">ISDNQ931IE::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>param</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>defVal</em> = <code>0</code></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>
Get the value of a given parameter of a given IE <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>Requested IE's type </td></tr>
<tr><td valign="top"></td><td valign="top"><em>param</em> </td><td>Requested IE's parameter. Set to 0 to use IE's name </td></tr>
<tr><td valign="top"></td><td valign="top"><em>defVal</em> </td><td>Default value to return if IE is missing or the parameter is missing </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Pointer to the requested value or 0 </dd></dl>
<p>References <a class="el" href="yateclass_8h-source.html#l01296">String::c_str()</a>, and <a class="el" href="classTelEngine_1_1NamedList.html#abf36017b973e5a71aaf554c0f767dd1">NamedList::getValue()</a>.</p>
</div>
</div><p>
<a class="anchor" name="aa71c3294b1a073c3ad0b64a2ed6325a"></a><!-- doxytag: member="TelEngine::ISDNQ931Message::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 message <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="0ad4d0e4527cd08b6c832629a6dc2c73"></a><!-- doxytag: member="TelEngine::ISDNQ931Message::ieList" ref="0ad4d0e4527cd08b6c832629a6dc2c73" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1ObjList.html">ObjList</a>* ieList </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the IE list of this message <dl class="return" compact><dt><b>Returns:</b></dt><dd>A valid pointer to the list of this message's IEs </dd></dl>
</div>
</div><p>
<a class="anchor" name="2ad6cc0173d0cf5aa8e4623d211e1c46"></a><!-- doxytag: member="TelEngine::ISDNQ931Message::initiator" ref="2ad6cc0173d0cf5aa8e4623d211e1c46" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool initiator </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if the sender of this message is the call initiator <dl class="return" compact><dt><b>Returns:</b></dt><dd>True if the sender of this message is the call initiator </dd></dl>
</div>
</div><p>
<a class="anchor" name="ca45df6ee506ebcb9d8d7b81da960b4f"></a><!-- doxytag: member="TelEngine::ISDNQ931Message::parse" ref="ca45df6ee506ebcb9d8d7b81da960b4f" args="(ISDNQ931ParserData &parserData, const DataBlock &buffer, DataBlock *segData)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classTelEngine_1_1ISDNQ931Message.html">ISDNQ931Message</a>* parse </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1ISDNQ931ParserData.html">ISDNQ931ParserData</a> & </td>
<td class="paramname"> <em>parserData</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classTelEngine_1_1DataBlock.html">DataBlock</a> & </td>
<td class="paramname"> <em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1DataBlock.html">DataBlock</a> * </td>
<td class="paramname"> <em>segData</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Parse received data If the message type is Segment, decode only the header and the first IE If valid, fills the given buffer with the rest of the message. If segData is 0, drop the message. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>parserData</em> </td><td>The parser settings </td></tr>
<tr><td valign="top"></td><td valign="top"><em>buffer</em> </td><td>The received data </td></tr>
<tr><td valign="top"></td><td valign="top"><em>segData</em> </td><td>Segment message data. If 0, received segmented messages will be dropped </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Valid <a class="el" href="classTelEngine_1_1ISDNQ931Message.html" title="A Q.931 ISDN Layer 3 message.">ISDNQ931Message</a> pointer on success or 0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="4f3a9522320648e45f043a33b81a780b"></a><!-- doxytag: member="TelEngine::ISDNQ931Message::removeIE" ref="4f3a9522320648e45f043a33b81a780b" args="(ISDNQ931IE::Type type, ISDNQ931IE *base=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1ISDNQ931IE.html">ISDNQ931IE</a>* removeIE </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1ISDNQ931IE.html#1d1cfd8ffb84e947f82999c682b666a7">ISDNQ931IE::Type</a> </td>
<td class="paramname"> <em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1ISDNQ931IE.html">ISDNQ931IE</a> * </td>
<td class="paramname"> <em>base</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>
Remove an IE from list without destroying it <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>Requested IE's type </td></tr>
<tr><td valign="top"></td><td valign="top"><em>base</em> </td><td>Optional search starting element. If 0, search is started from the first IE following base </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Pointer to the IE or 0 if not found </dd></dl>
</div>
</div><p>
<a class="anchor" name="542c9ae0b0a42b0d07a07bf7641d215b"></a><!-- doxytag: member="TelEngine::ISDNQ931Message::setUnknownMandatory" ref="542c9ae0b0a42b0d07a07bf7641d215b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setUnknownMandatory </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the unknown mandatory IE(s) flag
</div>
</div><p>
<a class="anchor" name="43e445f6d113e60dc80ba02d91afe258"></a><!-- doxytag: member="TelEngine::ISDNQ931Message::toString" ref="43e445f6d113e60dc80ba02d91afe258" args="(String &dest, bool extendedDebug, const char *indent=0) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void toString </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1String.html">String</a> & </td>
<td class="paramname"> <em>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>extendedDebug</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>indent</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Put this message into a string for debug purposes <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>dest</em> </td><td>The destination string </td></tr>
<tr><td valign="top"></td><td valign="top"><em>extendedDebug</em> </td><td>True to add the content of IEs and dump data. If false, only the IE name is added to the destination string </td></tr>
<tr><td valign="top"></td><td valign="top"><em>indent</em> </td><td>The line indent </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="fbd0fa31db28593e9669c3c56711c0a7"></a><!-- doxytag: member="TelEngine::ISDNQ931Message::type" ref="fbd0fa31db28593e9669c3c56711c0a7" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1ISDNQ931Message.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 message <dl class="return" compact><dt><b>Returns:</b></dt><dd>The type of this message as enumeration </dd></dl>
</div>
</div><p>
<a class="anchor" name="e122df3be75f38741fd497b58f303cea"></a><!-- doxytag: member="TelEngine::ISDNQ931Message::typeName" ref="e122df3be75f38741fd497b58f303cea" args="(int t)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static const char* typeName </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>t</em> </td>
<td> ) </td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the string associated with a given message type <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>t</em> </td><td>The message type whose string we want to get </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Pointer to the string associated with the given message type or 0 </dd></dl>
<p>References <a class="el" href="namespaceTelEngine.html#4668c9172c6ae5f59f5782ecc6e05516">TelEngine::lookup()</a>.</p>
</div>
</div><p>
<a class="anchor" name="e51ab430f6977454fbb5e8696ade5164"></a><!-- doxytag: member="TelEngine::ISDNQ931Message::unknownMandatory" ref="e51ab430f6977454fbb5e8696ade5164" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool unknownMandatory </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if this message contains unknown mandatory IE(s) <dl class="return" compact><dt><b>Returns:</b></dt><dd>True if this message contains unknown mandatory IE(s) </dd></dl>
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="3aa804a6c140137d54c8298df9e2729d"></a><!-- doxytag: member="TelEngine::ISDNQ931Message::m_buffer" ref="3aa804a6c140137d54c8298df9e2729d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1DataBlock.html">DataBlock</a> <a class="el" href="classTelEngine_1_1ISDNQ931Message.html#3aa804a6c140137d54c8298df9e2729d">m_buffer</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Internally used buffer for debug purposes
</div>
</div><p>
<a class="anchor" name="ca156cbdad5f00431ea3a797881e0003"></a><!-- doxytag: member="TelEngine::ISDNQ931Message::s_type" ref="ca156cbdad5f00431ea3a797881e0003" args="[]" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structTelEngine_1_1TokenDict.html">TokenDict</a> <a class="el" href="classTelEngine_1_1ISDNQ931Message.html#ca156cbdad5f00431ea3a797881e0003">s_type</a>[]<code> [static]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Keep the string associated with message types
</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
>
207
