<!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: IAXIEList 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_1IAXIEList.html">IAXIEList</a> </div> </div> <div class="contents"> <h1>IAXIEList Class Reference</h1><!-- doxytag: class="TelEngine::IAXIEList" -->Information Element container. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="yateiax_8h-source.html">yateiax.h</a>></code> <p> <p> <a href="classTelEngine_1_1IAXIEList-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_1IAXIEList.html#67af09fcad0c3a959b5fce51ad2dfd55">IAXIEList</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1IAXIEList.html#93fcb2a7c5846cb1afa1416e742af567">IAXIEList</a> (const <a class="el" href="classTelEngine_1_1IAXFullFrame.html">IAXFullFrame</a> *frame, bool incoming=true)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1IAXIEList.html#8b1472ec1306fa5e99b48ba622d209ad">~IAXIEList</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1IAXIEList.html#97deac08a9e6751da01ad33fb36891da">invalidIEList</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_1IAXIEList.html#c8bb3912a3ce86b15842e79d0b421204">clear</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_1IAXIEList.html#54afc007be85abd42a5e9de8bb03b00b">insertVersion</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1IAXIEList.html#aa5f3e699cdad7c71f44f059f99ff4b1">validVersion</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_1IAXIEList.html#fab2e1c72a7fa16c4539085079429389">appendIE</a> (<a class="el" href="classTelEngine_1_1IAXInfoElement.html">IAXInfoElement</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_1IAXIEList.html#d85fb7a33e876d0dcfd5182b1e4d70a9">appendNull</a> (<a class="el" href="classTelEngine_1_1IAXInfoElement.html#1d1cfd8ffb84e947f82999c682b666a7">IAXInfoElement::Type</a> type)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1IAXIEList.html#aa886d32fb9ba6e7124a9323c7ac571d">appendString</a> (<a class="el" href="classTelEngine_1_1IAXInfoElement.html#1d1cfd8ffb84e947f82999c682b666a7">IAXInfoElement::Type</a> type, const <a class="el" href="classTelEngine_1_1String.html">String</a> &src)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1IAXIEList.html#7ec3f616b470f39b196d39935cd28dd1">appendString</a> (<a class="el" href="classTelEngine_1_1IAXInfoElement.html#1d1cfd8ffb84e947f82999c682b666a7">IAXInfoElement::Type</a> type, unsigned char *src, unsigned len)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1IAXIEList.html#7102c3a1a5692a8c1e2b3e44e3bcc18d">appendNumeric</a> (<a class="el" href="classTelEngine_1_1IAXInfoElement.html#1d1cfd8ffb84e947f82999c682b666a7">IAXInfoElement::Type</a> type, u_int32_t value, u_int8_t len)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1IAXIEList.html#e17d3730c19d38adbb839c47646b5e33">appendBinary</a> (<a class="el" href="classTelEngine_1_1IAXInfoElement.html#1d1cfd8ffb84e947f82999c682b666a7">IAXInfoElement::Type</a> type, unsigned char *data, unsigned len)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1IAXIEList.html#0b05f0629ff8afe6068bbae96aad66c7">createFromFrame</a> (const <a class="el" href="classTelEngine_1_1IAXFullFrame.html">IAXFullFrame</a> *frame, bool incoming=true)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1IAXIEList.html#b8e7317af3d32a3397adb688e8588229">toBuffer</a> (<a class="el" href="classTelEngine_1_1DataBlock.html">DataBlock</a> &buf)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1IAXIEList.html#8a4ba5426a6720caba78b625e2a85285">toString</a> (<a class="el" href="classTelEngine_1_1String.html">String</a> &dest, const char *indent=0)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1IAXInfoElement.html">IAXInfoElement</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1IAXIEList.html#e5521ccda1ff15472bee72039f5d3455">getIE</a> (<a class="el" href="classTelEngine_1_1IAXInfoElement.html#1d1cfd8ffb84e947f82999c682b666a7">IAXInfoElement::Type</a> type)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1IAXIEList.html#f8728839cfbf48e552fdafa04317fb0c">getString</a> (<a class="el" href="classTelEngine_1_1IAXInfoElement.html#1d1cfd8ffb84e947f82999c682b666a7">IAXInfoElement::Type</a> type, <a class="el" href="classTelEngine_1_1String.html">String</a> &dest)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1IAXIEList.html#ff50336918478fcddd97e8f7ec706dbc">getNumeric</a> (<a class="el" href="classTelEngine_1_1IAXInfoElement.html#1d1cfd8ffb84e947f82999c682b666a7">IAXInfoElement::Type</a> type, u_int32_t &dest)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1IAXIEList.html#a01d8295f8c56472d4f849973dfb5d9e">getBinary</a> (<a class="el" href="classTelEngine_1_1IAXInfoElement.html#1d1cfd8ffb84e947f82999c682b666a7">IAXInfoElement::Type</a> type, <a class="el" href="classTelEngine_1_1DataBlock.html">DataBlock</a> &dest)</td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> Information Element container. <p> Management class for a list of Information Elements <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="67af09fcad0c3a959b5fce51ad2dfd55"></a><!-- doxytag: member="TelEngine::IAXIEList::IAXIEList" ref="67af09fcad0c3a959b5fce51ad2dfd55" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classTelEngine_1_1IAXIEList.html">IAXIEList</a> </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Constructor </div> </div><p> <a class="anchor" name="93fcb2a7c5846cb1afa1416e742af567"></a><!-- doxytag: member="TelEngine::IAXIEList::IAXIEList" ref="93fcb2a7c5846cb1afa1416e742af567" args="(const IAXFullFrame *frame, bool incoming=true)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classTelEngine_1_1IAXIEList.html">IAXIEList</a> </td> <td>(</td> <td class="paramtype">const <a class="el" href="classTelEngine_1_1IAXFullFrame.html">IAXFullFrame</a> * </td> <td class="paramname"> <em>frame</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"> <em>incoming</em> = <code>true</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> Constructor. Construct the list from an <a class="el" href="classTelEngine_1_1IAXFullFrame.html" title="This class holds an IAX full frame.">IAXFullFrame</a> object <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>frame</em> </td><td>Source object </td></tr> <tr><td valign="top"></td><td valign="top"><em>incoming</em> </td><td>True if it is an incoming frame </td></tr> </table> </dl> </div> </div><p> <a class="anchor" name="8b1472ec1306fa5e99b48ba622d209ad"></a><!-- doxytag: member="TelEngine::IAXIEList::~IAXIEList" ref="8b1472ec1306fa5e99b48ba622d209ad" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">~<a class="el" href="classTelEngine_1_1IAXIEList.html">IAXIEList</a> </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Destructor </div> </div><p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="e17d3730c19d38adbb839c47646b5e33"></a><!-- doxytag: member="TelEngine::IAXIEList::appendBinary" ref="e17d3730c19d38adbb839c47646b5e33" args="(IAXInfoElement::Type type, unsigned char *data, unsigned len)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void appendBinary </td> <td>(</td> <td class="paramtype"><a class="el" href="classTelEngine_1_1IAXInfoElement.html#1d1cfd8ffb84e947f82999c682b666a7">IAXInfoElement::Type</a> </td> <td class="paramname"> <em>type</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">unsigned char * </td> <td class="paramname"> <em>data</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">unsigned </td> <td class="paramname"> <em>len</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 a binary Information Element 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>type</em> </td><td>The type of the <a class="el" href="classTelEngine_1_1IAXInfoElementBinary.html" title="A single IAX2 numeric Information Element.">IAXInfoElementBinary</a> to append </td></tr> <tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>The source </td></tr> <tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>Source length </td></tr> </table> </dl> </div> </div><p> <a class="anchor" name="fab2e1c72a7fa16c4539085079429389"></a><!-- doxytag: member="TelEngine::IAXIEList::appendIE" ref="fab2e1c72a7fa16c4539085079429389" args="(IAXInfoElement *ie)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void appendIE </td> <td>(</td> <td class="paramtype"><a class="el" href="classTelEngine_1_1IAXInfoElement.html">IAXInfoElement</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 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><a class="el" href="classTelEngine_1_1IAXInfoElement.html" title="A single IAX2 Information Element.">IAXInfoElement</a> pointer to append </td></tr> </table> </dl> </div> </div><p> <a class="anchor" name="d85fb7a33e876d0dcfd5182b1e4d70a9"></a><!-- doxytag: member="TelEngine::IAXIEList::appendNull" ref="d85fb7a33e876d0dcfd5182b1e4d70a9" args="(IAXInfoElement::Type type)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void appendNull </td> <td>(</td> <td class="paramtype"><a class="el" href="classTelEngine_1_1IAXInfoElement.html#1d1cfd8ffb84e947f82999c682b666a7">IAXInfoElement::Type</a> </td> <td class="paramname"> <em>type</em> </td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Append an Information Element 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>type</em> </td><td>The type of the <a class="el" href="classTelEngine_1_1IAXInfoElement.html" title="A single IAX2 Information Element.">IAXInfoElement</a> to append </td></tr> </table> </dl> </div> </div><p> <a class="anchor" name="7102c3a1a5692a8c1e2b3e44e3bcc18d"></a><!-- doxytag: member="TelEngine::IAXIEList::appendNumeric" ref="7102c3a1a5692a8c1e2b3e44e3bcc18d" args="(IAXInfoElement::Type type, u_int32_t value, u_int8_t len)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void appendNumeric </td> <td>(</td> <td class="paramtype"><a class="el" href="classTelEngine_1_1IAXInfoElement.html#1d1cfd8ffb84e947f82999c682b666a7">IAXInfoElement::Type</a> </td> <td class="paramname"> <em>type</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">u_int32_t </td> <td class="paramname"> <em>value</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">u_int8_t </td> <td class="paramname"> <em>len</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 a numeric Information Element 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>type</em> </td><td>The type of the <a class="el" href="classTelEngine_1_1IAXInfoElementNumeric.html" title="A single IAX2 numeric Information Element.">IAXInfoElementNumeric</a> to append </td></tr> <tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>The source </td></tr> <tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>Source length </td></tr> </table> </dl> </div> </div><p> <a class="anchor" name="7ec3f616b470f39b196d39935cd28dd1"></a><!-- doxytag: member="TelEngine::IAXIEList::appendString" ref="7ec3f616b470f39b196d39935cd28dd1" args="(IAXInfoElement::Type type, unsigned char *src, unsigned len)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void appendString </td> <td>(</td> <td class="paramtype"><a class="el" href="classTelEngine_1_1IAXInfoElement.html#1d1cfd8ffb84e947f82999c682b666a7">IAXInfoElement::Type</a> </td> <td class="paramname"> <em>type</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">unsigned char * </td> <td class="paramname"> <em>src</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">unsigned </td> <td class="paramname"> <em>len</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 a text Information Element to the list from a buffer <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>The type of the <a class="el" href="classTelEngine_1_1IAXInfoElementString.html" title="A single IAX2 text Information Element.">IAXInfoElementString</a> to append </td></tr> <tr><td valign="top"></td><td valign="top"><em>src</em> </td><td>The source </td></tr> <tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>Source length </td></tr> </table> </dl> </div> </div><p> <a class="anchor" name="aa886d32fb9ba6e7124a9323c7ac571d"></a><!-- doxytag: member="TelEngine::IAXIEList::appendString" ref="aa886d32fb9ba6e7124a9323c7ac571d" args="(IAXInfoElement::Type type, const String &src)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void appendString </td> <td>(</td> <td class="paramtype"><a class="el" href="classTelEngine_1_1IAXInfoElement.html#1d1cfd8ffb84e947f82999c682b666a7">IAXInfoElement::Type</a> </td> <td class="paramname"> <em>type</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td> <td class="paramname"> <em>src</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 a text Information Element to the list from a <a class="el" href="classTelEngine_1_1String.html" title="A C-style string handling class.">String</a> <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>The type of the <a class="el" href="classTelEngine_1_1IAXInfoElementString.html" title="A single IAX2 text Information Element.">IAXInfoElementString</a> to append </td></tr> <tr><td valign="top"></td><td valign="top"><em>src</em> </td><td>The source </td></tr> </table> </dl> <p>References <a class="el" href="yateclass_8h-source.html#l01296">String::c_str()</a>, and <a class="el" href="yateclass_8h-source.html#l01310">String::length()</a>.</p> </div> </div><p> <a class="anchor" name="c8bb3912a3ce86b15842e79d0b421204"></a><!-- doxytag: member="TelEngine::IAXIEList::clear" ref="c8bb3912a3ce86b15842e79d0b421204" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void clear </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Clear the list </div> </div><p> <a class="anchor" name="0b05f0629ff8afe6068bbae96aad66c7"></a><!-- doxytag: member="TelEngine::IAXIEList::createFromFrame" ref="0b05f0629ff8afe6068bbae96aad66c7" args="(const IAXFullFrame *frame, bool incoming=true)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool createFromFrame </td> <td>(</td> <td class="paramtype">const <a class="el" href="classTelEngine_1_1IAXFullFrame.html">IAXFullFrame</a> * </td> <td class="paramname"> <em>frame</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"> <em>incoming</em> = <code>true</code></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p> Construct the list from an <a class="el" href="classTelEngine_1_1IAXFullFrame.html" title="This class holds an IAX full frame.">IAXFullFrame</a> object. On exit m_invalidIEList will contain the opposite of the returned 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>frame</em> </td><td>Source object </td></tr> <tr><td valign="top"></td><td valign="top"><em>incoming</em> </td><td>True if it is an incoming frame </td></tr> </table> </dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd>False if the frame contains invalid IEs </dd></dl> </div> </div><p> <a class="anchor" name="a01d8295f8c56472d4f849973dfb5d9e"></a><!-- doxytag: member="TelEngine::IAXIEList::getBinary" ref="a01d8295f8c56472d4f849973dfb5d9e" args="(IAXInfoElement::Type type, DataBlock &dest)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool getBinary </td> <td>(</td> <td class="paramtype"><a class="el" href="classTelEngine_1_1IAXInfoElement.html#1d1cfd8ffb84e947f82999c682b666a7">IAXInfoElement::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_1DataBlock.html">DataBlock</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> Get the data of a list item into a <a class="el" href="classTelEngine_1_1DataBlock.html" title="A class that holds just a block of raw data.">DataBlock</a>. Before any operation dest is cleared <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>The desired type </td></tr> <tr><td valign="top"></td><td valign="top"><em>dest</em> </td><td>The destination buffer </td></tr> </table> </dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd>False if the list doesn't contain an IE of this type </dd></dl> </div> </div><p> <a class="anchor" name="e5521ccda1ff15472bee72039f5d3455"></a><!-- doxytag: member="TelEngine::IAXIEList::getIE" ref="e5521ccda1ff15472bee72039f5d3455" args="(IAXInfoElement::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>* getIE </td> <td>(</td> <td class="paramtype"><a class="el" href="classTelEngine_1_1IAXInfoElement.html#1d1cfd8ffb84e947f82999c682b666a7">IAXInfoElement::Type</a> </td> <td class="paramname"> <em>type</em> </td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p> Get an <a class="el" href="classTelEngine_1_1IAXInfoElement.html" title="A single IAX2 Information Element.">IAXInfoElement</a> from 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>type</em> </td><td>The desired type </td></tr> </table> </dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd>An <a class="el" href="classTelEngine_1_1IAXInfoElement.html" title="A single IAX2 Information Element.">IAXInfoElement</a> pointer or 0 if the list doesn't contain an IE of this type </dd></dl> </div> </div><p> <a class="anchor" name="ff50336918478fcddd97e8f7ec706dbc"></a><!-- doxytag: member="TelEngine::IAXIEList::getNumeric" ref="ff50336918478fcddd97e8f7ec706dbc" args="(IAXInfoElement::Type type, u_int32_t &dest)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool getNumeric </td> <td>(</td> <td class="paramtype"><a class="el" href="classTelEngine_1_1IAXInfoElement.html#1d1cfd8ffb84e947f82999c682b666a7">IAXInfoElement::Type</a> </td> <td class="paramname"> <em>type</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">u_int32_t & </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> Get the data of a list item into a numeric destination <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>The desired type </td></tr> <tr><td valign="top"></td><td valign="top"><em>dest</em> </td><td>The destination </td></tr> </table> </dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd>False if the list doesn't contain an IE of this type </dd></dl> </div> </div><p> <a class="anchor" name="f8728839cfbf48e552fdafa04317fb0c"></a><!-- doxytag: member="TelEngine::IAXIEList::getString" ref="f8728839cfbf48e552fdafa04317fb0c" args="(IAXInfoElement::Type type, String &dest)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool getString </td> <td>(</td> <td class="paramtype"><a class="el" href="classTelEngine_1_1IAXInfoElement.html#1d1cfd8ffb84e947f82999c682b666a7">IAXInfoElement::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_1String.html">String</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> Get the data of a list item into a <a class="el" href="classTelEngine_1_1String.html" title="A C-style string handling class.">String</a>. Before any operation dest is cleared <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>The desired type </td></tr> <tr><td valign="top"></td><td valign="top"><em>dest</em> </td><td>The destination <a class="el" href="classTelEngine_1_1String.html" title="A C-style string handling class.">String</a> </td></tr> </table> </dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd>False if the list doesn't contain an IE of this type </dd></dl> </div> </div><p> <a class="anchor" name="54afc007be85abd42a5e9de8bb03b00b"></a><!-- doxytag: member="TelEngine::IAXIEList::insertVersion" ref="54afc007be85abd42a5e9de8bb03b00b" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void insertVersion </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p> Insert a VERSION Information Element in the list if not already done </div> </div><p> <a class="anchor" name="97deac08a9e6751da01ad33fb36891da"></a><!-- doxytag: member="TelEngine::IAXIEList::invalidIEList" ref="97deac08a9e6751da01ad33fb36891da" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool invalidIEList </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Get the invalid IE list flag <dl class="return" compact><dt><b>Returns:</b></dt><dd>False if the last frame parse was unsuccessful </dd></dl> </div> </div><p> <a class="anchor" name="b8e7317af3d32a3397adb688e8588229"></a><!-- doxytag: member="TelEngine::IAXIEList::toBuffer" ref="b8e7317af3d32a3397adb688e8588229" args="(DataBlock &buf)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">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></td> </tr> </table> </div> <div class="memdoc"> <p> Construct a buffer from this 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>buf</em> </td><td>Destination buffer </td></tr> </table> </dl> </div> </div><p> <a class="anchor" name="8a4ba5426a6720caba78b625e2a85285"></a><!-- doxytag: member="TelEngine::IAXIEList::toString" ref="8a4ba5426a6720caba78b625e2a85285" args="(String &dest, const char *indent=0)" --> <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">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></td> </tr> </table> </div> <div class="memdoc"> <p> Add this list 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>dest</em> </td><td>Destination string </td></tr> <tr><td valign="top"></td><td valign="top"><em>indent</em> </td><td>Optional indent for each element </td></tr> </table> </dl> </div> </div><p> <a class="anchor" name="aa5f3e699cdad7c71f44f059f99ff4b1"></a><!-- doxytag: member="TelEngine::IAXIEList::validVersion" ref="aa5f3e699cdad7c71f44f059f99ff4b1" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool validVersion </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Get the validity of the VERSION Information Element of the list if any <dl class="return" compact><dt><b>Returns:</b></dt><dd>False if version is not IAX_PROTOCOL_VERSION or the list doesn't contain a VERSION Information Element </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>