<!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: IAXFullFrame 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_1IAXFullFrame.html">IAXFullFrame</a>
</div>
</div>
<div class="contents">
<h1>IAXFullFrame Class Reference</h1><!-- doxytag: class="TelEngine::IAXFullFrame" --><!-- doxytag: inherits="TelEngine::IAXFrame" -->This class holds an IAX full frame.
<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 IAXFullFrame:</div>
<div class="dynsection">
<p><center><img src="classTelEngine_1_1IAXFullFrame.png" usemap="#IAXFullFrame_map" border="0" alt=""></center>
<map name="IAXFullFrame_map">
<area href="classTelEngine_1_1IAXFrame.html" alt="IAXFrame" shape="rect" coords="0,112,90,136">
<area href="classTelEngine_1_1RefObject.html" alt="RefObject" shape="rect" coords="0,56,90,80">
<area href="classTelEngine_1_1GenObject.html" alt="GenObject" shape="rect" coords="0,0,90,24">
<area href="classTelEngine_1_1IAXFrameOut.html" alt="IAXFrameOut" shape="rect" coords="0,224,90,248">
</map>
</div>
<p>
<a href="classTelEngine_1_1IAXFullFrame-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_1IAXFullFrame.html#8005f1f182fd0248a710ca64f72508d4">ControlType</a> { <br>
<b>Hangup</b> = 0x01,
<b>Ringing</b> = 0x03,
<b>Answer</b> = 0x04,
<b>Busy</b> = 0x05,
<br>
<b>Congestion</b> = 0x08,
<b>FlashHook</b> = 0x09,
<b>Option</b> = 0x0b,
<b>KeyRadio</b> = 0x0c,
<br>
<b>UnkeyRadio</b> = 0x0d,
<b>Progressing</b> = 0x0e,
<b>Proceeding</b> = 0x0f,
<b>Hold</b> = 0x10,
<br>
<b>Unhold</b> = 0x11,
<b>VidUpdate</b> = 0x12
<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_1IAXFullFrame.html#ef49c046fa32323d52bf1e7e2bfaf2ac">IAXFullFrame</a> (<a class="el" href="classTelEngine_1_1IAXFrame.html#1d1cfd8ffb84e947f82999c682b666a7">Type</a> type, u_int32_t subclass, u_int16_t sCallNo, u_int16_t dCallNo, unsigned char oSeqNo, unsigned char iSeqNo, u_int32_t tStamp, bool retrans, const unsigned char *buf, unsigned int len)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1IAXFullFrame.html#ab8ffe82394296e18d0b8bb7b7db43ed">IAXFullFrame</a> (<a class="el" href="classTelEngine_1_1IAXFrame.html#1d1cfd8ffb84e947f82999c682b666a7">Type</a> type, u_int32_t subclass, u_int16_t sCallNo, u_int16_t dCallNo, unsigned char oSeqNo, unsigned char iSeqNo, u_int32_t tStamp, const unsigned char *buf=0, unsigned int len=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_1IAXFullFrame.html#26f520b4f435a96cb3edbd32b5efae5c">~IAXFullFrame</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u_int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1IAXFullFrame.html#efed35bfdf66a1d87e8889accd39b041">destCallNo</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned char </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1IAXFullFrame.html#bc4f11fd2801b7d640938d42859f1b48">oSeqNo</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned char </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1IAXFullFrame.html#de5838828bb2c88f92ef0d0076cb7987">iSeqNo</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_1IAXFullFrame.html#3b4386fddb72a0f38cbe41ae94ece33a">subclass</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const <a class="el" href="classTelEngine_1_1IAXFullFrame.html">IAXFullFrame</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1IAXFullFrame.html#3c052990c95e405373394ca108bbd01a">fullFrame</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_1IAXFullFrame.html#4747f994186d14dca96bcb0897b34564">toString</a> (<a class="el" href="classTelEngine_1_1String.html">String</a> &dest, const <a class="el" href="classTelEngine_1_1SocketAddr.html">SocketAddr</a> &local, const <a class="el" href="classTelEngine_1_1SocketAddr.html">SocketAddr</a> &remote, bool incoming) const </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_1IAXFullFrame.html#5e8502dbfa2e72ad27ba4623f84ef2bc">controlTypeText</a> (int type)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This class holds an IAX full frame.
<p>
This class holds all data needded to manage an IAX full frame <hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="8005f1f182fd0248a710ca64f72508d4"></a><!-- doxytag: member="TelEngine::IAXFullFrame::ControlType" ref="8005f1f182fd0248a710ca64f72508d4" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classTelEngine_1_1IAXFullFrame.html#8005f1f182fd0248a710ca64f72508d4">ControlType</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
IAX frame subclass enumeration types for frames of type Control
</div>
</div><p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="ef49c046fa32323d52bf1e7e2bfaf2ac"></a><!-- doxytag: member="TelEngine::IAXFullFrame::IAXFullFrame" ref="ef49c046fa32323d52bf1e7e2bfaf2ac" args="(Type type, u_int32_t subclass, u_int16_t sCallNo, u_int16_t dCallNo, unsigned char oSeqNo, unsigned char iSeqNo, u_int32_t tStamp, bool retrans, const unsigned char *buf, unsigned int len)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1IAXFullFrame.html">IAXFullFrame</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1IAXFrame.html#1d1cfd8ffb84e947f82999c682b666a7">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>subclass</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u_int16_t </td>
<td class="paramname"> <em>sCallNo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u_int16_t </td>
<td class="paramname"> <em>dCallNo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned char </td>
<td class="paramname"> <em>oSeqNo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned char </td>
<td class="paramname"> <em>iSeqNo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u_int32_t </td>
<td class="paramname"> <em>tStamp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>retrans</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const unsigned char * </td>
<td class="paramname"> <em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>len</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 an incoming full frame <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>Frame type </td></tr>
<tr><td valign="top"></td><td valign="top"><em>subclass</em> </td><td>Frame subclass </td></tr>
<tr><td valign="top"></td><td valign="top"><em>sCallNo</em> </td><td>Source (remote) call number </td></tr>
<tr><td valign="top"></td><td valign="top"><em>dCallNo</em> </td><td>Destination (local) call number </td></tr>
<tr><td valign="top"></td><td valign="top"><em>oSeqNo</em> </td><td>Outgoing sequence number </td></tr>
<tr><td valign="top"></td><td valign="top"><em>iSeqNo</em> </td><td>Incoming (expected) sequence number </td></tr>
<tr><td valign="top"></td><td valign="top"><em>tStamp</em> </td><td>Frame timestamp </td></tr>
<tr><td valign="top"></td><td valign="top"><em>retrans</em> </td><td>Retransmission flag </td></tr>
<tr><td valign="top"></td><td valign="top"><em>buf</em> </td><td>IE buffer </td></tr>
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>IE buffer length </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="ab8ffe82394296e18d0b8bb7b7db43ed"></a><!-- doxytag: member="TelEngine::IAXFullFrame::IAXFullFrame" ref="ab8ffe82394296e18d0b8bb7b7db43ed" args="(Type type, u_int32_t subclass, u_int16_t sCallNo, u_int16_t dCallNo, unsigned char oSeqNo, unsigned char iSeqNo, u_int32_t tStamp, const unsigned char *buf=0, unsigned int len=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1IAXFullFrame.html">IAXFullFrame</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1IAXFrame.html#1d1cfd8ffb84e947f82999c682b666a7">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>subclass</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u_int16_t </td>
<td class="paramname"> <em>sCallNo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u_int16_t </td>
<td class="paramname"> <em>dCallNo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned char </td>
<td class="paramname"> <em>oSeqNo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned char </td>
<td class="paramname"> <em>iSeqNo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u_int32_t </td>
<td class="paramname"> <em>tStamp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const unsigned char * </td>
<td class="paramname"> <em>buf</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>len</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. Constructs an outgoing full frame <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>Frame type </td></tr>
<tr><td valign="top"></td><td valign="top"><em>subclass</em> </td><td>Frame subclass </td></tr>
<tr><td valign="top"></td><td valign="top"><em>sCallNo</em> </td><td>Source (remote) call number </td></tr>
<tr><td valign="top"></td><td valign="top"><em>dCallNo</em> </td><td>Destination (local) call number </td></tr>
<tr><td valign="top"></td><td valign="top"><em>oSeqNo</em> </td><td>Outgoing sequence number </td></tr>
<tr><td valign="top"></td><td valign="top"><em>iSeqNo</em> </td><td>Incoming (expected) sequence number </td></tr>
<tr><td valign="top"></td><td valign="top"><em>tStamp</em> </td><td>Frame timestamp </td></tr>
<tr><td valign="top"></td><td valign="top"><em>buf</em> </td><td>IE buffer </td></tr>
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>IE buffer length </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="26f520b4f435a96cb3edbd32b5efae5c"></a><!-- doxytag: member="TelEngine::IAXFullFrame::~IAXFullFrame" ref="26f520b4f435a96cb3edbd32b5efae5c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ~<a class="el" href="classTelEngine_1_1IAXFullFrame.html">IAXFullFrame</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="5e8502dbfa2e72ad27ba4623f84ef2bc"></a><!-- doxytag: member="TelEngine::IAXFullFrame::controlTypeText" ref="5e8502dbfa2e72ad27ba4623f84ef2bc" args="(int type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static const char* controlTypeText </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>type</em> </td>
<td> ) </td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the string associated with the given IAX control 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>The requested control type </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The text if type is valid or 0 </dd></dl>
<p>References <a class="el" href="namespaceTelEngine.html#4668c9172c6ae5f59f5782ecc6e05516">TelEngine::lookup()</a>.</p>
</div>
</div><p>
<a class="anchor" name="efed35bfdf66a1d87e8889accd39b041"></a><!-- doxytag: member="TelEngine::IAXFullFrame::destCallNo" ref="efed35bfdf66a1d87e8889accd39b041" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u_int16_t destCallNo </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the destination call number <dl class="return" compact><dt><b>Returns:</b></dt><dd>The destination call number </dd></dl>
</div>
</div><p>
<a class="anchor" name="3c052990c95e405373394ca108bbd01a"></a><!-- doxytag: member="TelEngine::IAXFullFrame::fullFrame" ref="3c052990c95e405373394ca108bbd01a" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="classTelEngine_1_1IAXFullFrame.html">IAXFullFrame</a>* fullFrame </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a pointer to this frame if it is a full frame <dl class="return" compact><dt><b>Returns:</b></dt><dd>A pointer to this frame </dd></dl>
<p>Reimplemented from <a class="el" href="classTelEngine_1_1IAXFrame.html#3c052990c95e405373394ca108bbd01a">IAXFrame</a>.</p>
</div>
</div><p>
<a class="anchor" name="de5838828bb2c88f92ef0d0076cb7987"></a><!-- doxytag: member="TelEngine::IAXFullFrame::iSeqNo" ref="de5838828bb2c88f92ef0d0076cb7987" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned char iSeqNo </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the incoming sequence number <dl class="return" compact><dt><b>Returns:</b></dt><dd>The incoming sequence number </dd></dl>
</div>
</div><p>
<a class="anchor" name="bc4f11fd2801b7d640938d42859f1b48"></a><!-- doxytag: member="TelEngine::IAXFullFrame::oSeqNo" ref="bc4f11fd2801b7d640938d42859f1b48" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned char oSeqNo </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the outgoing sequence number <dl class="return" compact><dt><b>Returns:</b></dt><dd>The outgoing sequence number </dd></dl>
</div>
</div><p>
<a class="anchor" name="3b4386fddb72a0f38cbe41ae94ece33a"></a><!-- doxytag: member="TelEngine::IAXFullFrame::subclass" ref="3b4386fddb72a0f38cbe41ae94ece33a" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u_int32_t subclass </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the subclass of this frame <dl class="return" compact><dt><b>Returns:</b></dt><dd>The subclass of this frame </dd></dl>
</div>
</div><p>
<a class="anchor" name="4747f994186d14dca96bcb0897b34564"></a><!-- doxytag: member="TelEngine::IAXFullFrame::toString" ref="4747f994186d14dca96bcb0897b34564" args="(String &dest, const SocketAddr &local, const SocketAddr &remote, bool incoming) 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">const <a class="el" href="classTelEngine_1_1SocketAddr.html">SocketAddr</a> & </td>
<td class="paramname"> <em>local</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classTelEngine_1_1SocketAddr.html">SocketAddr</a> & </td>
<td class="paramname"> <em>remote</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>incoming</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Fill a string with this frame <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 string to fill </td></tr>
<tr><td valign="top"></td><td valign="top"><em>local</em> </td><td>The local address </td></tr>
<tr><td valign="top"></td><td valign="top"><em>remote</em> </td><td>The remote address </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>
<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>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
eeacaa4eb55fa544d622989e42fc27b1
>
files
>
152
