Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > eeacaa4eb55fa544d622989e42fc27b1 > files > 169

libyate-devel-2.0.0-2mdv2009.1.i586.rpm

<!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: IAXMetaTrunkFrame 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&nbsp;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&nbsp;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
  <div class="navpath"><a class="el" href="namespaceTelEngine.html">TelEngine</a>::<a class="el" href="classTelEngine_1_1IAXMetaTrunkFrame.html">IAXMetaTrunkFrame</a>
  </div>
</div>
<div class="contents">
<h1>IAXMetaTrunkFrame Class Reference</h1><!-- doxytag: class="TelEngine::IAXMetaTrunkFrame" --><!-- doxytag: inherits="TelEngine::RefObject,TelEngine::Mutex" -->Meta trunk frame.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="yateiax_8h-source.html">yateiax.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for IAXMetaTrunkFrame:</div>
<div class="dynsection">

<p><center><img src="classTelEngine_1_1IAXMetaTrunkFrame.png" usemap="#IAXMetaTrunkFrame_map" border="0" alt=""></center>
<map name="IAXMetaTrunkFrame_map">
<area href="classTelEngine_1_1RefObject.html" alt="RefObject" shape="rect" coords="0,56,129,80">
<area href="classTelEngine_1_1Mutex.html" alt="Mutex" shape="rect" coords="139,56,268,80">
<area href="classTelEngine_1_1GenObject.html" alt="GenObject" shape="rect" coords="0,0,129,24">
</map>
</div>

<p>
<a href="classTelEngine_1_1IAXMetaTrunkFrame-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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1IAXMetaTrunkFrame.html#39e9061942f91731a6938da8f3fa05e3">IAXMetaTrunkFrame</a> (<a class="el" href="classTelEngine_1_1IAXEngine.html">IAXEngine</a> *engine, const <a class="el" href="classTelEngine_1_1SocketAddr.html">SocketAddr</a> &amp;addr)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1IAXMetaTrunkFrame.html#09abd6e8033f48f9f8f5323d43db45ff">~IAXMetaTrunkFrame</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classTelEngine_1_1SocketAddr.html">SocketAddr</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1IAXMetaTrunkFrame.html#37daa045dcf7a1b182cda22f09ae61a4">addr</a> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">u_int32_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1IAXMetaTrunkFrame.html#b44dae4b981d4ea77ff8e8ba3c7e099e">timestamp</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1IAXMetaTrunkFrame.html#8d0e7504abd3d8fd549114425eb43f4b">setTimestamp</a> (u_int32_t tStamp)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1IAXMetaTrunkFrame.html#9221d26dbcd460d9c39896580f9ab3fa">add</a> (u_int16_t sCallNo, const <a class="el" href="classTelEngine_1_1DataBlock.html">DataBlock</a> &amp;data, u_int32_t tStamp)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1IAXMetaTrunkFrame.html#49ab93612f046923ba476964890a28ac">send</a> (u_int32_t tStamp)</td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Meta trunk frame. 
<p>
Handle meta trunk frame with timestamps <hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="39e9061942f91731a6938da8f3fa05e3"></a><!-- doxytag: member="TelEngine::IAXMetaTrunkFrame::IAXMetaTrunkFrame" ref="39e9061942f91731a6938da8f3fa05e3" args="(IAXEngine *engine, const SocketAddr &amp;addr)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classTelEngine_1_1IAXMetaTrunkFrame.html">IAXMetaTrunkFrame</a>           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classTelEngine_1_1IAXEngine.html">IAXEngine</a> *&nbsp;</td>
          <td class="paramname"> <em>engine</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classTelEngine_1_1SocketAddr.html">SocketAddr</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>addr</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Constructor. Constructs an outgoing meta trunk 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>engine</em>&nbsp;</td><td>The engine that owns this frame </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>addr</em>&nbsp;</td><td>Remote peer address </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="09abd6e8033f48f9f8f5323d43db45ff"></a><!-- doxytag: member="TelEngine::IAXMetaTrunkFrame::~IAXMetaTrunkFrame" ref="09abd6e8033f48f9f8f5323d43db45ff" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual ~<a class="el" href="classTelEngine_1_1IAXMetaTrunkFrame.html">IAXMetaTrunkFrame</a>           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</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="9221d26dbcd460d9c39896580f9ab3fa"></a><!-- doxytag: member="TelEngine::IAXMetaTrunkFrame::add" ref="9221d26dbcd460d9c39896580f9ab3fa" args="(u_int16_t sCallNo, const DataBlock &amp;data, u_int32_t tStamp)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool add           </td>
          <td>(</td>
          <td class="paramtype">u_int16_t&nbsp;</td>
          <td class="paramname"> <em>sCallNo</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classTelEngine_1_1DataBlock.html">DataBlock</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>data</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u_int32_t&nbsp;</td>
          <td class="paramname"> <em>tStamp</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Add a mini frame. If no room, send before adding <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>sCallNo</em>&nbsp;</td><td>Sorce call number </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>data</em>&nbsp;</td><td>Mini frame data </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>tStamp</em>&nbsp;</td><td>Mini frame timestamp </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>False if the frame was sent and the write operation failed </dd></dl>

</div>
</div><p>
<a class="anchor" name="37daa045dcf7a1b182cda22f09ae61a4"></a><!-- doxytag: member="TelEngine::IAXMetaTrunkFrame::addr" ref="37daa045dcf7a1b182cda22f09ae61a4" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="classTelEngine_1_1SocketAddr.html">SocketAddr</a>&amp; addr           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the remote peer address <dl class="return" compact><dt><b>Returns:</b></dt><dd>The remote peer address </dd></dl>

</div>
</div><p>
<a class="anchor" name="49ab93612f046923ba476964890a28ac"></a><!-- doxytag: member="TelEngine::IAXMetaTrunkFrame::send" ref="49ab93612f046923ba476964890a28ac" args="(u_int32_t tStamp)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool send           </td>
          <td>(</td>
          <td class="paramtype">u_int32_t&nbsp;</td>
          <td class="paramname"> <em>tStamp</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Send this frame to remote peer <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>tStamp</em>&nbsp;</td><td>Frame timestamp </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The result of the write operation </dd></dl>

</div>
</div><p>
<a class="anchor" name="8d0e7504abd3d8fd549114425eb43f4b"></a><!-- doxytag: member="TelEngine::IAXMetaTrunkFrame::setTimestamp" ref="8d0e7504abd3d8fd549114425eb43f4b" args="(u_int32_t tStamp)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void setTimestamp           </td>
          <td>(</td>
          <td class="paramtype">u_int32_t&nbsp;</td>
          <td class="paramname"> <em>tStamp</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set the timestamp of 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>tStamp</em>&nbsp;</td><td>Timestamp value to set </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="b44dae4b981d4ea77ff8e8ba3c7e099e"></a><!-- doxytag: member="TelEngine::IAXMetaTrunkFrame::timestamp" ref="b44dae4b981d4ea77ff8e8ba3c7e099e" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u_int32_t timestamp           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the timestamp of this frame <dl class="return" compact><dt><b>Returns:</b></dt><dd>The timestamp of this frame </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&nbsp;
<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>