<!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: IAXFrameOut 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_1IAXFrameOut.html">IAXFrameOut</a>
</div>
</div>
<div class="contents">
<h1>IAXFrameOut Class Reference</h1><!-- doxytag: class="TelEngine::IAXFrameOut" --><!-- doxytag: inherits="TelEngine::IAXFullFrame" -->This class holds an outgoing 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 IAXFrameOut:</div>
<div class="dynsection">
<p><center><img src="classTelEngine_1_1IAXFrameOut.png" usemap="#IAXFrameOut_map" border="0" alt=""></center>
<map name="IAXFrameOut_map">
<area href="classTelEngine_1_1IAXFullFrame.html" alt="IAXFullFrame" shape="rect" coords="0,168,90,192">
<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">
</map>
</div>
<p>
<a href="classTelEngine_1_1IAXFrameOut-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_1IAXFrameOut.html#ac02e2d2f49d3d8cfe013c9538acb59a">IAXFrameOut</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, unsigned int len, u_int16_t retransCount, u_int32_t retransInterval, bool ackOnly)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1IAXFrameOut.html#00578d76af67f9498e2f4350cda70c3c">~IAXFrameOut</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_1IAXFrameOut.html#9c437d53bf2d1e353a45486af2fd3343">timeout</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_1IAXFrameOut.html#b0bab6fd2271d118df74de7bec5e03c5">timeForRetrans</a> (u_int64_t time) 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_1IAXFrameOut.html#2319a250ff0c2d14c3a017260d2c479d">setRetrans</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_1IAXFrameOut.html#59f0fa87deba4d638506e176d4f5b5f2">transmitted</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_1IAXFrameOut.html#13d82bac8478ffd34bc2682d04190c8a">ack</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_1IAXFrameOut.html#6063ca1297a08afac63ae7b6f24b9fa4">setAck</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_1IAXFrameOut.html#f604560600787ef595f41a70ab37711c">ackOnly</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_1IAXFrameOut.html#b01a08a955a55cc7dd555681d64a5535">adjustAuthTimeout</a> (u_int64_t nextTransTime)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This class holds an outgoing IAX full frame.
<p>
This class holds all data needded to manage an outgoing IAX full frame <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="ac02e2d2f49d3d8cfe013c9538acb59a"></a><!-- doxytag: member="TelEngine::IAXFrameOut::IAXFrameOut" ref="ac02e2d2f49d3d8cfe013c9538acb59a" 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, unsigned int len, u_int16_t retransCount, u_int32_t retransInterval, bool ackOnly)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1IAXFrameOut.html">IAXFrameOut</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>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>len</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u_int16_t </td>
<td class="paramname"> <em>retransCount</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u_int32_t </td>
<td class="paramname"> <em>retransInterval</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>ackOnly</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>
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>
<tr><td valign="top"></td><td valign="top"><em>retransCount</em> </td><td>Retransmission counter </td></tr>
<tr><td valign="top"></td><td valign="top"><em>retransInterval</em> </td><td><a class="el" href="classTelEngine_1_1Time.html" title="A time holding class.">Time</a> interval to the next retransmission </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ackOnly</em> </td><td>Acknoledge only flag. If true, the frame only expects an ACK </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="00578d76af67f9498e2f4350cda70c3c"></a><!-- doxytag: member="TelEngine::IAXFrameOut::~IAXFrameOut" ref="00578d76af67f9498e2f4350cda70c3c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ~<a class="el" href="classTelEngine_1_1IAXFrameOut.html">IAXFrameOut</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="13d82bac8478ffd34bc2682d04190c8a"></a><!-- doxytag: member="TelEngine::IAXFrameOut::ack" ref="13d82bac8478ffd34bc2682d04190c8a" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ack </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the acknoledged flag of this frame <dl class="return" compact><dt><b>Returns:</b></dt><dd>The acknoledged flag of this frame </dd></dl>
</div>
</div><p>
<a class="anchor" name="f604560600787ef595f41a70ab37711c"></a><!-- doxytag: member="TelEngine::IAXFrameOut::ackOnly" ref="f604560600787ef595f41a70ab37711c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ackOnly </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the acknoledge only flag of this frame <dl class="return" compact><dt><b>Returns:</b></dt><dd>The acknoledge only flag of this frame </dd></dl>
</div>
</div><p>
<a class="anchor" name="b01a08a955a55cc7dd555681d64a5535"></a><!-- doxytag: member="TelEngine::IAXFrameOut::adjustAuthTimeout" ref="b01a08a955a55cc7dd555681d64a5535" args="(u_int64_t nextTransTime)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void adjustAuthTimeout </td>
<td>(</td>
<td class="paramtype">u_int64_t </td>
<td class="paramname"> <em>nextTransTime</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Increase the timeout for acknoledged authentication frames sent and set the counter to 1 <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>nextTransTime</em> </td><td>Next transmission time </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="6063ca1297a08afac63ae7b6f24b9fa4"></a><!-- doxytag: member="TelEngine::IAXFrameOut::setAck" ref="6063ca1297a08afac63ae7b6f24b9fa4" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setAck </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the acknoledged flag of this frame
</div>
</div><p>
<a class="anchor" name="2319a250ff0c2d14c3a017260d2c479d"></a><!-- doxytag: member="TelEngine::IAXFrameOut::setRetrans" ref="2319a250ff0c2d14c3a017260d2c479d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setRetrans </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the retransmission flag of this frame
</div>
</div><p>
<a class="anchor" name="b0bab6fd2271d118df74de7bec5e03c5"></a><!-- doxytag: member="TelEngine::IAXFrameOut::timeForRetrans" ref="b0bab6fd2271d118df74de7bec5e03c5" args="(u_int64_t time) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool timeForRetrans </td>
<td>(</td>
<td class="paramtype">u_int64_t </td>
<td class="paramname"> <em>time</em> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Ask the frame if it's time for retransmit <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>time</em> </td><td>Current time </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if it's time to retransmit </dd></dl>
</div>
</div><p>
<a class="anchor" name="9c437d53bf2d1e353a45486af2fd3343"></a><!-- doxytag: member="TelEngine::IAXFrameOut::timeout" ref="9c437d53bf2d1e353a45486af2fd3343" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool timeout </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the timeout (retransmission counter) of this frame <dl class="return" compact><dt><b>Returns:</b></dt><dd>True if the retransmission counter is 0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="59f0fa87deba4d638506e176d4f5b5f2"></a><!-- doxytag: member="TelEngine::IAXFrameOut::transmitted" ref="59f0fa87deba4d638506e176d4f5b5f2" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void transmitted </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Update the retransmission counter and the time to next retransmission
</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
>
149
