<!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: RTCPBYEPacket 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 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 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>
<div class="contents">
<h1>RTCPBYEPacket Class Reference</h1><!-- doxytag: class="RTCPBYEPacket" --><!-- doxytag: inherits="RTCPPacket" -->Describes an RTCP BYE packet.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="rtcpbyepacket_8h_source.html">rtcpbyepacket.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for RTCPBYEPacket:</div>
<div class="dynsection">
<p><center><img src="classRTCPBYEPacket__inherit__graph.png" border="0" usemap="#RTCPBYEPacket__inherit__map" alt="Inheritance graph"></center>
<map name="RTCPBYEPacket__inherit__map">
<area shape="rect" href="classRTCPPacket.html" title="Base class for specific types of RTCP packets." alt="" coords="19,7,117,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<div class="dynheader">
Collaboration diagram for RTCPBYEPacket:</div>
<div class="dynsection">
<p><center><img src="classRTCPBYEPacket__coll__graph.png" border="0" usemap="#RTCPBYEPacket__coll__map" alt="Collaboration graph"></center>
<map name="RTCPBYEPacket__coll__map">
<area shape="rect" href="classRTCPPacket.html" title="Base class for specific types of RTCP packets." alt="" coords="19,7,117,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classRTCPBYEPacket-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="classRTCPBYEPacket.html#e5d2acc0560a03f566f9cc063286772f">RTCPBYEPacket</a> (uint8_t *data, size_t datalen)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates an instance based on the data in <code>data</code> with length <code>datalen</code>. <a href="#e5d2acc0560a03f566f9cc063286772f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classRTCPBYEPacket.html#33107723b924c874694df74ea8cc3216">GetSSRCCount</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of SSRC identifiers present in this BYE packet. <a href="#33107723b924c874694df74ea8cc3216"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4a2727f3320970bc6d1d85b8dc73a323"></a><!-- doxytag: member="RTCPBYEPacket::GetSSRC" ref="4a2727f3320970bc6d1d85b8dc73a323" args="(int index) const " -->
uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classRTCPBYEPacket.html#4a2727f3320970bc6d1d85b8dc73a323">GetSSRC</a> (int index) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the SSRC described by <code>index</code> which may have a value from 0 to <a class="el" href="classRTCPBYEPacket.html#33107723b924c874694df74ea8cc3216" title="Returns the number of SSRC identifiers present in this BYE packet.">GetSSRCCount()</a>-1 (note that no check is performed to see if <code>index</code> is valid). <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classRTCPBYEPacket.html#5933bbcba0e9cb18fb336b63de3b2f60">HasReasonForLeaving</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the BYE packet contains a reason for leaving. <a href="#5933bbcba0e9cb18fb336b63de3b2f60"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classRTCPBYEPacket.html#53eff8f51e7d25250d6c3fe1ba2a75ad">GetReasonLength</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the length of the string which describes why the source(s) left. <a href="#53eff8f51e7d25250d6c3fe1ba2a75ad"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="classRTCPBYEPacket.html#5572ceffdae43f4dcd7502014d67ae81">GetReasonData</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the actual reason for leaving data. <a href="#5572ceffdae43f4dcd7502014d67ae81"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="e5d2acc0560a03f566f9cc063286772f"></a><!-- doxytag: member="RTCPBYEPacket::RTCPBYEPacket" ref="e5d2acc0560a03f566f9cc063286772f" args="(uint8_t *data, size_t datalen)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">RTCPBYEPacket::RTCPBYEPacket </td>
<td>(</td>
<td class="paramtype">uint8_t * </td>
<td class="paramname"> <em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>datalen</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Creates an instance based on the data in <code>data</code> with length <code>datalen</code>. Since the <code>data</code> pointer is referenced inside the class (no copy of the data is made) one must make sure that the memory it points to is valid as long as the class instance exists.
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="5572ceffdae43f4dcd7502014d67ae81"></a><!-- doxytag: member="RTCPBYEPacket::GetReasonData" ref="5572ceffdae43f4dcd7502014d67ae81" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t * RTCPBYEPacket::GetReasonData </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="53eff8f51e7d25250d6c3fe1ba2a75ad"></a><!-- doxytag: member="RTCPBYEPacket::GetReasonLength" ref="53eff8f51e7d25250d6c3fe1ba2a75ad" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t RTCPBYEPacket::GetReasonLength </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="33107723b924c874694df74ea8cc3216"></a><!-- doxytag: member="RTCPBYEPacket::GetSSRCCount" ref="33107723b924c874694df74ea8cc3216" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int RTCPBYEPacket::GetSSRCCount </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="5933bbcba0e9cb18fb336b63de3b2f60"></a><!-- doxytag: member="RTCPBYEPacket::HasReasonForLeaving" ref="5933bbcba0e9cb18fb336b63de3b2f60" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool RTCPBYEPacket::HasReasonForLeaving </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>src/<a class="el" href="rtcpbyepacket_8h_source.html">rtcpbyepacket.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Jul 26 09:42:13 2009 for jrtplib by
<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>
