<!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: IAXInfoElement 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_1IAXInfoElement.html">IAXInfoElement</a> </div> </div> <div class="contents"> <h1>IAXInfoElement Class Reference</h1><!-- doxytag: class="TelEngine::IAXInfoElement" --><!-- doxytag: inherits="TelEngine::RefObject" -->A single IAX2 Information Element. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="yateiax_8h-source.html">yateiax.h</a>></code> <p> <div class="dynheader"> Inheritance diagram for IAXInfoElement:</div> <div class="dynsection"> <p><center><img src="classTelEngine_1_1IAXInfoElement.png" usemap="#IAXInfoElement_map" border="0" alt=""></center> <map name="IAXInfoElement_map"> <area href="classTelEngine_1_1RefObject.html" alt="RefObject" shape="rect" coords="155,56,300,80"> <area href="classTelEngine_1_1GenObject.html" alt="GenObject" shape="rect" coords="155,0,300,24"> <area href="classTelEngine_1_1IAXInfoElementBinary.html" alt="IAXInfoElementBinary" shape="rect" coords="0,168,145,192"> <area href="classTelEngine_1_1IAXInfoElementNumeric.html" alt="IAXInfoElementNumeric" shape="rect" coords="155,168,300,192"> <area href="classTelEngine_1_1IAXInfoElementString.html" alt="IAXInfoElementString" shape="rect" coords="310,168,455,192"> </map> </div> <p> <a href="classTelEngine_1_1IAXInfoElement-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_1IAXInfoElement.html#1d1cfd8ffb84e947f82999c682b666a7">Type</a> { <br> <b>textframe</b> = 0x00, <b>CALLED_NUMBER</b> = 0x01, <b>CALLING_NUMBER</b> = 0x02, <b>CALLING_ANI</b> = 0x03, <br> <b>CALLING_NAME</b> = 0x04, <b>CALLED_CONTEXT</b> = 0x05, <b>USERNAME</b> = 0x06, <b>PASSWORD</b> = 0x07, <br> <b>CAPABILITY</b> = 0x08, <b>FORMAT</b> = 0x09, <b>LANGUAGE</b> = 0x0a, <b>VERSION</b> = 0x0b, <br> <b>ADSICPE</b> = 0x0c, <b>DNID</b> = 0x0d, <b>AUTHMETHODS</b> = 0x0e, <b>CHALLENGE</b> = 0x0f, <br> <b>MD5_RESULT</b> = 0x10, <b>RSA_RESULT</b> = 0x11, <b>APPARENT_ADDR</b> = 0x12, <b>REFRESH</b> = 0x13, <br> <b>DPSTATUS</b> = 0x14, <b>CALLNO</b> = 0x15, <b>CAUSE</b> = 0x16, <b>IAX_UNKNOWN</b> = 0x17, <br> <b>MSGCOUNT</b> = 0x18, <b>AUTOANSWER</b> = 0x19, <b>MUSICONHOLD</b> = 0x1a, <b>TRANSFERID</b> = 0x1b, <br> <b>RDNIS</b> = 0x1c, <b>PROVISIONING</b> = 0x1d, <b>AESPROVISIONING</b> = 0x1e, <b>DATETIME</b> = 0x1f, <br> <b>DEVICETYPE</b> = 0x20, <b>SERVICEIDENT</b> = 0x21, <b>FIRMWAREVER</b> = 0x22, <b>FWBLOCKDESC</b> = 0x23, <br> <b>FWBLOCKDATA</b> = 0x24, <b>PROVVER</b> = 0x25, <b>CALLINGPRES</b> = 0x26, <b>CALLINGTON</b> = 0x27, <br> <b>CALLINGTNS</b> = 0x28, <b>SAMPLINGRATE</b> = 0x29, <b>CAUSECODE</b> = 0x2a, <b>ENCRYPTION</b> = 0x2b, <br> <b>ENKEY</b> = 0x2c, <b>CODEC_PREFS</b> = 0x2d, <b>RR_JITTER</b> = 0x2e, <b>RR_LOSS</b> = 0x2f, <br> <b>RR_PKTS</b> = 0x30, <b>RR_DELAY</b> = 0x31, <b>RR_DROPPED</b> = 0x32, <b>RR_OOO</b> = 0x33 <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_1IAXInfoElement.html#2bbac2ce75d94cf0b4033eebed4ed084">IAXInfoElement</a> (<a class="el" href="classTelEngine_1_1IAXInfoElement.html#1d1cfd8ffb84e947f82999c682b666a7">Type</a> type)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1IAXInfoElement.html#ea224fe233f1565d60572561b648fd8d">~IAXInfoElement</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1IAXInfoElement.html#1d1cfd8ffb84e947f82999c682b666a7">Type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1IAXInfoElement.html#fbd0fa31db28593e9669c3c56711c0a7">type</a> () 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_1IAXInfoElement.html#7fe2a8da4e5d5ae2d4e6ca0d8a3d4be7">toBuffer</a> (<a class="el" href="classTelEngine_1_1DataBlock.html">DataBlock</a> &buf)</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_1IAXInfoElement.html#e012f02f9b353958b64122898b9e6b12">toString</a> (<a class="el" href="classTelEngine_1_1String.html">String</a> &buf)</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 const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1IAXInfoElement.html#a2d5a88781da4ec63d945593c632f0d0">ieText</a> (u_int8_t ieCode)</td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> A single IAX2 Information Element. <p> This class holds a single Information Element with no data <hr><h2>Member Enumeration Documentation</h2> <a class="anchor" name="1d1cfd8ffb84e947f82999c682b666a7"></a><!-- doxytag: member="TelEngine::IAXInfoElement::Type" ref="1d1cfd8ffb84e947f82999c682b666a7" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">enum <a class="el" href="classTelEngine_1_1IAXInfoElement.html#1d1cfd8ffb84e947f82999c682b666a7">Type</a> </td> </tr> </table> </div> <div class="memdoc"> <p> Information Element enumeration types </div> </div><p> <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="2bbac2ce75d94cf0b4033eebed4ed084"></a><!-- doxytag: member="TelEngine::IAXInfoElement::IAXInfoElement" ref="2bbac2ce75d94cf0b4033eebed4ed084" args="(Type type)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classTelEngine_1_1IAXInfoElement.html">IAXInfoElement</a> </td> <td>(</td> <td class="paramtype"><a class="el" href="classTelEngine_1_1IAXInfoElement.html#1d1cfd8ffb84e947f82999c682b666a7">Type</a> </td> <td class="paramname"> <em>type</em> </td> <td> ) </td> <td><code> [inline]</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>type</em> </td><td>Type of this IE </td></tr> </table> </dl> </div> </div><p> <a class="anchor" name="ea224fe233f1565d60572561b648fd8d"></a><!-- doxytag: member="TelEngine::IAXInfoElement::~IAXInfoElement" ref="ea224fe233f1565d60572561b648fd8d" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual ~<a class="el" href="classTelEngine_1_1IAXInfoElement.html">IAXInfoElement</a> </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Destructor </div> </div><p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="a2d5a88781da4ec63d945593c632f0d0"></a><!-- doxytag: member="TelEngine::IAXInfoElement::ieText" ref="a2d5a88781da4ec63d945593c632f0d0" args="(u_int8_t ieCode)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static const char* ieText </td> <td>(</td> <td class="paramtype">u_int8_t </td> <td class="paramname"> <em>ieCode</em> </td> <td> ) </td> <td><code> [inline, static]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Get the text associated with an IE type value <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>ieCode</em> </td><td>Numeric code of the IE </td></tr> </table> </dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd>Pointer to the IE text or 0 if it doesn't exist </dd></dl> <p>References <a class="el" href="namespaceTelEngine.html#4668c9172c6ae5f59f5782ecc6e05516">TelEngine::lookup()</a>.</p> </div> </div><p> <a class="anchor" name="7fe2a8da4e5d5ae2d4e6ca0d8a3d4be7"></a><!-- doxytag: member="TelEngine::IAXInfoElement::toBuffer" ref="7fe2a8da4e5d5ae2d4e6ca0d8a3d4be7" args="(DataBlock &buf)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void toBuffer </td> <td>(</td> <td class="paramtype"><a class="el" href="classTelEngine_1_1DataBlock.html">DataBlock</a> & </td> <td class="paramname"> <em>buf</em> </td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Constructs a buffer containing this Information Element <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>buf</em> </td><td>Destination buffer </td></tr> </table> </dl> <p>Reimplemented in <a class="el" href="classTelEngine_1_1IAXInfoElementString.html#7fe2a8da4e5d5ae2d4e6ca0d8a3d4be7">IAXInfoElementString</a>, <a class="el" href="classTelEngine_1_1IAXInfoElementNumeric.html#7fe2a8da4e5d5ae2d4e6ca0d8a3d4be7">IAXInfoElementNumeric</a>, and <a class="el" href="classTelEngine_1_1IAXInfoElementBinary.html#7fe2a8da4e5d5ae2d4e6ca0d8a3d4be7">IAXInfoElementBinary</a>.</p> </div> </div><p> <a class="anchor" name="e012f02f9b353958b64122898b9e6b12"></a><!-- doxytag: member="TelEngine::IAXInfoElement::toString" ref="e012f02f9b353958b64122898b9e6b12" args="(String &buf)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void toString </td> <td>(</td> <td class="paramtype"><a class="el" href="classTelEngine_1_1String.html">String</a> & </td> <td class="paramname"> <em>buf</em> </td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Add this element to a string <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>buf</em> </td><td>Destination string </td></tr> </table> </dl> <p>Reimplemented in <a class="el" href="classTelEngine_1_1IAXInfoElementString.html#e012f02f9b353958b64122898b9e6b12">IAXInfoElementString</a>, <a class="el" href="classTelEngine_1_1IAXInfoElementNumeric.html#e012f02f9b353958b64122898b9e6b12">IAXInfoElementNumeric</a>, and <a class="el" href="classTelEngine_1_1IAXInfoElementBinary.html#e012f02f9b353958b64122898b9e6b12">IAXInfoElementBinary</a>.</p> </div> </div><p> <a class="anchor" name="fbd0fa31db28593e9669c3c56711c0a7"></a><!-- doxytag: member="TelEngine::IAXInfoElement::type" ref="fbd0fa31db28593e9669c3c56711c0a7" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classTelEngine_1_1IAXInfoElement.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 IE <dl class="return" compact><dt><b>Returns:</b></dt><dd>Type of this IE </dd></dl> </div> </div><p> <hr>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="yateiax_8h-source.html">yateiax.h</a></ul> </div> <hr size="1"><address style="text-align: right;"><small>Generated on Sun Dec 7 21:36:12 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>