Sophie

Sophie

distrib > Fedora > 14 > x86_64 > by-pkgid > 7c0c66d6521a2c8efa0ef6bf03291d7f > files > 182

jrtplib-devel-3.7.1-7.fc12.i686.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>jrtplib: RTPRawPacket Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="jrtplib.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.9 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</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>
      <li><a href="dirs.html"><span>Directories</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>
<div class="contents">
<h1>RTPRawPacket Class Reference</h1><!-- doxytag: class="RTPRawPacket" --><!-- doxytag: inherits="RTPMemoryObject" -->This class is used by the transmission component to store the incoming RTP and RTCP data in.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="rtprawpacket_8h_source.html">rtprawpacket.h</a>&gt;</code>
<p>
Inherits RTPMemoryObject.
<p>
<div class="dynheader">
Collaboration diagram for RTPRawPacket:</div>
<div class="dynsection">
<p><center><img src="classRTPRawPacket__coll__graph.png" border="0" usemap="#RTPRawPacket__coll__map" alt="Collaboration graph"></center>
<map name="RTPRawPacket__coll__map">
<area shape="rect" href="classRTPAddress.html" title="This class is an abstract class which is used to specify destinations, multicast..." alt="" coords="5,7,101,33"><area shape="rect" href="classRTPTime.html" title="This class is used to specify wallclock time, delay intervals etc." alt="" coords="131,7,208,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="classRTPRawPacket-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="classRTPRawPacket.html#14d548caabd76373d7a7b9934d50c347">RTPRawPacket</a> (uint8_t *data, size_t datalen, <a class="el" href="classRTPAddress.html">RTPAddress</a> *address, <a class="el" href="classRTPTime.html">RTPTime</a> &amp;recvtime, bool rtp, <a class="el" href="classRTPMemoryManager.html">RTPMemoryManager</a> *mgr=0)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates an instance which stores data from <code>data</code> with length <code>datalen</code>.  <a href="#14d548caabd76373d7a7b9934d50c347"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">uint8_t *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRTPRawPacket.html#ad140a0782b591f65aaf77cc816200ea">GetData</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the pointer to the data which is contained in this packet.  <a href="#ad140a0782b591f65aaf77cc816200ea"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRTPRawPacket.html#e287edfac37627aa4f5372efeabbe338">GetDataLength</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the length of the packet described by this instance.  <a href="#e287edfac37627aa4f5372efeabbe338"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classRTPTime.html">RTPTime</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRTPRawPacket.html#cf2182fe1695edd57a168f89fe533f52">GetReceiveTime</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the time at which this packet was received.  <a href="#cf2182fe1695edd57a168f89fe533f52"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classRTPAddress.html">RTPAddress</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRTPRawPacket.html#a4d40dbf612760fc983693ec942f2b66">GetSenderAddress</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the address stored in this packet.  <a href="#a4d40dbf612760fc983693ec942f2b66"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRTPRawPacket.html#49fd661b45e46c901be6196476035a6a">IsRTP</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns <code>true</code> if this data is RTP data, <code>false</code> if it is RTCP data.  <a href="#49fd661b45e46c901be6196476035a6a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRTPRawPacket.html#7e18ffb342b9e70f6c8a1c462a5ea751">ZeroData</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the pointer to the data stored in this packet to zero.  <a href="#7e18ffb342b9e70f6c8a1c462a5ea751"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="14d548caabd76373d7a7b9934d50c347"></a><!-- doxytag: member="RTPRawPacket::RTPRawPacket" ref="14d548caabd76373d7a7b9934d50c347" args="(uint8_t *data, size_t datalen, RTPAddress *address, RTPTime &amp;recvtime, bool rtp, RTPMemoryManager *mgr=0)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">RTPRawPacket::RTPRawPacket           </td>
          <td>(</td>
          <td class="paramtype">uint8_t *&nbsp;</td>
          <td class="paramname"> <em>data</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&nbsp;</td>
          <td class="paramname"> <em>datalen</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classRTPAddress.html">RTPAddress</a> *&nbsp;</td>
          <td class="paramname"> <em>address</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classRTPTime.html">RTPTime</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>recvtime</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>rtp</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classRTPMemoryManager.html">RTPMemoryManager</a> *&nbsp;</td>
          <td class="paramname"> <em>mgr</em> = <code>0</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Creates an instance which stores data from <code>data</code> with length <code>datalen</code>. Only the pointer to the data is stored, no actual copy is made! The address from which this packet originated is set to <code>address</code> and the time at which the packet was received is set to <code>recvtime</code>. The flag which indicates whether this data is RTP or RTCP data is set to <code>rtp</code>. A memory manager can be installed as well. 
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="ad140a0782b591f65aaf77cc816200ea"></a><!-- doxytag: member="RTPRawPacket::GetData" ref="ad140a0782b591f65aaf77cc816200ea" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t* RTPRawPacket::GetData           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="e287edfac37627aa4f5372efeabbe338"></a><!-- doxytag: member="RTPRawPacket::GetDataLength" ref="e287edfac37627aa4f5372efeabbe338" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">size_t RTPRawPacket::GetDataLength           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="cf2182fe1695edd57a168f89fe533f52"></a><!-- doxytag: member="RTPRawPacket::GetReceiveTime" ref="cf2182fe1695edd57a168f89fe533f52" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classRTPTime.html">RTPTime</a> RTPRawPacket::GetReceiveTime           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="a4d40dbf612760fc983693ec942f2b66"></a><!-- doxytag: member="RTPRawPacket::GetSenderAddress" ref="a4d40dbf612760fc983693ec942f2b66" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="classRTPAddress.html">RTPAddress</a>* RTPRawPacket::GetSenderAddress           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="49fd661b45e46c901be6196476035a6a"></a><!-- doxytag: member="RTPRawPacket::IsRTP" ref="49fd661b45e46c901be6196476035a6a" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool RTPRawPacket::IsRTP           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="7e18ffb342b9e70f6c8a1c462a5ea751"></a><!-- doxytag: member="RTPRawPacket::ZeroData" ref="7e18ffb342b9e70f6c8a1c462a5ea751" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void RTPRawPacket::ZeroData           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Sets the pointer to the data stored in this packet to zero. This will prevent a <code>delete</code> call for the actual data when the destructor of <a class="el" href="classRTPRawPacket.html" title="This class is used by the transmission component to store the incoming RTP and RTCP...">RTPRawPacket</a> is called. This function is used by the <a class="el" href="classRTPPacket.html" title="Represents an RTP Packet.">RTPPacket</a> and <a class="el" href="classRTCPCompoundPacket.html" title="Represents an RTCP compound packet.">RTCPCompoundPacket</a> classes to obtain the packet data (without having to copy it) and to make sure the data isn't deleted when the destructor of <a class="el" href="classRTPRawPacket.html" title="This class is used by the transmission component to store the incoming RTP and RTCP...">RTPRawPacket</a> is called. 
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>src/<a class="el" href="rtprawpacket_8h_source.html">rtprawpacket.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Jul 26 09:42:14 2009 for jrtplib by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
</body>
</html>