<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>ccRTP: RTCPCompoundHandler Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.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><a href="modules.html"><span>Modules</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="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</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>RTCPCompoundHandler Class Reference<br>
<small>
[<a class="el" href="group__rtcppacket.html">RTCP compound packets manipulation.</a>]</small>
</h1><!-- doxytag: class="RTCPCompoundHandler" -->low level structs and RTCP packet parsing and building methods.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="rtcppkt_8h_source.html">rtcppkt.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for RTCPCompoundHandler:</div>
<div class="dynsection">
<p><center><img src="class_r_t_c_p_compound_handler.png" usemap="#RTCPCompoundHandler_map" border="0" alt=""></center>
<map name="RTCPCompoundHandler_map">
<area href="class_queue_r_t_c_p_manager.html" alt="QueueRTCPManager" shape="rect" coords="0,56,149,80">
<area href="class_a_v_p_queue.html" alt="AVPQueue" shape="rect" coords="0,112,149,136">
</map>
</div>
<p>
<a href="class_r_t_c_p_compound_handler-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_r_t_c_p_compound_handler_1_1_a_p_p_packet.html">APPPacket</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Struct for APP (application specific) RTCP packets. <a href="struct_r_t_c_p_compound_handler_1_1_a_p_p_packet.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_r_t_c_p_compound_handler_1_1_b_y_e_packet.html">BYEPacket</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Struct for BYE (leaving session) RTCP packets. <a href="struct_r_t_c_p_compound_handler_1_1_b_y_e_packet.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_r_t_c_p_compound_handler_1_1_f_i_r_packet.html">FIRPacket</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Struct for Full Intra-frame Request (FIR) RTCP packet. <a href="struct_r_t_c_p_compound_handler_1_1_f_i_r_packet.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_r_t_c_p_compound_handler_1_1_n_a_c_k_packet.html">NACKPacket</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Struct for Negative ACKnowledgements (NACK) RTCP packet. <a href="struct_r_t_c_p_compound_handler_1_1_n_a_c_k_packet.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_r_t_c_p_compound_handler_1_1_receiver_info.html">ReceiverInfo</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Struct for the data contained in a receiver info block. <a href="struct_r_t_c_p_compound_handler_1_1_receiver_info.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_r_t_c_p_compound_handler_1_1_recv_report.html">RecvReport</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">raw structure of the source and every receiver report in an SR or RR RTCP packet. <a href="struct_r_t_c_p_compound_handler_1_1_recv_report.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_r_t_c_p_compound_handler_1_1_r_r_block.html">RRBlock</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Struct for a receiver info block in a SR (sender report) or an RR (receiver report) RTCP packet. <a href="struct_r_t_c_p_compound_handler_1_1_r_r_block.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_r_t_c_p_compound_handler_1_1_r_t_c_p_fixed_header.html">RTCPFixedHeader</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Fixed RTCP packet header. <a href="struct_r_t_c_p_compound_handler_1_1_r_t_c_p_fixed_header.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_r_t_c_p_compound_handler_1_1_r_t_c_p_packet.html">RTCPPacket</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Struct representing general RTCP packet headers as they are sent through the network. <a href="struct_r_t_c_p_compound_handler_1_1_r_t_c_p_packet.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_r_t_c_p_compound_handler_1_1_s_d_e_s_chunk.html">SDESChunk</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Struct for a chunk of items in a SDES RTCP packet. <a href="struct_r_t_c_p_compound_handler_1_1_s_d_e_s_chunk.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_r_t_c_p_compound_handler_1_1_s_d_e_s_item.html">SDESItem</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Struct for an item description of a SDES packet. <a href="struct_r_t_c_p_compound_handler_1_1_s_d_e_s_item.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_r_t_c_p_compound_handler_1_1_sender_info.html">SenderInfo</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Struct for the sender info block in a SR (sender report) RTCP packet. <a href="struct_r_t_c_p_compound_handler_1_1_sender_info.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_r_t_c_p_compound_handler_1_1_send_report.html">SendReport</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Struct for SR (sender report) RTCP packets. <a href="struct_r_t_c_p_compound_handler_1_1_send_report.html#_details">More...</a><br></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_c_p_compound_handler.html#3623ef29bb08c07c38c36baecbe29deb">setPathMTU</a> (uint16 mtu)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">uint16 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_c_p_compound_handler.html#9e7ab53e1ade61ebb3251cc092742ff7">getPathMTU</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Protected Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom">{ <a class="el" href="class_r_t_c_p_compound_handler.html#e9b0b9f5a967506a540084d3370490bf09de71c940cfdbd49cc1c49fe58220b7">defaultPathMTU</a> = 1500
}</td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_c_p_compound_handler.html#87cdcd49fa5135bd8b5130071b706b03">RTCPCompoundHandler</a> (uint16 mtu=defaultPathMTU)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_c_p_compound_handler.html#13188245db9df964c0b43524fe2c40bb">~RTCPCompoundHandler</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_c_p_compound_handler.html#13efdbbec15da67084780dc41b330c73">checkCompoundRTCPHeader</a> (size_t len)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Perform RTCP compound packet header validity check as specified in draft-ietv-avt-rtp-new. <a href="#13efdbbec15da67084780dc41b330c73"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned char * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_c_p_compound_handler.html#51035644bd0291c76238b39be6745570">rtcpSendBuffer</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned char * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_c_p_compound_handler.html#b8d2a43b8e5ac42e4faa11a005b8cfc2">rtcpRecvBuffer</a></td></tr>
<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_c_p_compound_handler.html#2a20d7d348fbd23cb074951ba06ae9f6">RTCPSenderInfo</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_c_p_compound_handler.html#9aa5832d33dc9fc7a7d8157fe45c6da3">RTCPReceiverInfo</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
low level structs and RTCP packet parsing and building methods.
<p>
Intended to be used, through inheritance, in RTCP management classes, such as <a class="el" href="class_queue_r_t_c_p_manager.html" title="Adds generic management of RTCP functions to an RTP data queue.">QueueRTCPManager</a>.<p>
<dl class="author" compact><dt><b>Author:</b></dt><dd>Federico Montesino Pouzols <<a href="mailto:fedemp@altern.org">fedemp@altern.org</a>> </dd></dl>
<hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="e9b0b9f5a967506a540084d3370490bf"></a><!-- doxytag: member="RTCPCompoundHandler::@2" ref="e9b0b9f5a967506a540084d3370490bf" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">anonymous enum<code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="e9b0b9f5a967506a540084d3370490bf09de71c940cfdbd49cc1c49fe58220b7"></a><!-- doxytag: member="defaultPathMTU" ref="e9b0b9f5a967506a540084d3370490bf09de71c940cfdbd49cc1c49fe58220b7" args="" -->defaultPathMTU</em> </td><td>
</td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="87cdcd49fa5135bd8b5130071b706b03"></a><!-- doxytag: member="RTCPCompoundHandler::RTCPCompoundHandler" ref="87cdcd49fa5135bd8b5130071b706b03" args="(uint16 mtu=defaultPathMTU)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">RTCPCompoundHandler::RTCPCompoundHandler </td>
<td>(</td>
<td class="paramtype">uint16 </td>
<td class="paramname"> <em>mtu</em> = <code>defaultPathMTU</code> </td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="13188245db9df964c0b43524fe2c40bb"></a><!-- doxytag: member="RTCPCompoundHandler::~RTCPCompoundHandler" ref="13188245db9df964c0b43524fe2c40bb" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">RTCPCompoundHandler::~RTCPCompoundHandler </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="13efdbbec15da67084780dc41b330c73"></a><!-- doxytag: member="RTCPCompoundHandler::checkCompoundRTCPHeader" ref="13efdbbec15da67084780dc41b330c73" args="(size_t len)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool RTCPCompoundHandler::checkCompoundRTCPHeader </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>len</em> </td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Perform RTCP compound packet header validity check as specified in draft-ietv-avt-rtp-new.
<p>
This method follows appendix A.2. Correct version, payload type, padding bit and length of every RTCP packet in the compound are verified.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>length of the RTCP compound packet in the reception buffer </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>whether the header is valid. </dd></dl>
</div>
</div><p>
<a class="anchor" name="9e7ab53e1ade61ebb3251cc092742ff7"></a><!-- doxytag: member="RTCPCompoundHandler::getPathMTU" ref="9e7ab53e1ade61ebb3251cc092742ff7" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16 RTCPCompoundHandler::getPathMTU </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="3623ef29bb08c07c38c36baecbe29deb"></a><!-- doxytag: member="RTCPCompoundHandler::setPathMTU" ref="3623ef29bb08c07c38c36baecbe29deb" args="(uint16 mtu)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RTCPCompoundHandler::setPathMTU </td>
<td>(</td>
<td class="paramtype">uint16 </td>
<td class="paramname"> <em>mtu</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Friends And Related Function Documentation</h2>
<a class="anchor" name="9aa5832d33dc9fc7a7d8157fe45c6da3"></a><!-- doxytag: member="RTCPCompoundHandler::RTCPReceiverInfo" ref="9aa5832d33dc9fc7a7d8157fe45c6da3" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="class_r_t_c_p_receiver_info.html">RTCPReceiverInfo</a><code> [friend]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="2a20d7d348fbd23cb074951ba06ae9f6"></a><!-- doxytag: member="RTCPCompoundHandler::RTCPSenderInfo" ref="2a20d7d348fbd23cb074951ba06ae9f6" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="class_r_t_c_p_sender_info.html">RTCPSenderInfo</a><code> [friend]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="b8d2a43b8e5ac42e4faa11a005b8cfc2"></a><!-- doxytag: member="RTCPCompoundHandler::rtcpRecvBuffer" ref="b8d2a43b8e5ac42e4faa11a005b8cfc2" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned char* <a class="el" href="class_r_t_c_p_compound_handler.html#b8d2a43b8e5ac42e4faa11a005b8cfc2">RTCPCompoundHandler::rtcpRecvBuffer</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="51035644bd0291c76238b39be6745570"></a><!-- doxytag: member="RTCPCompoundHandler::rtcpSendBuffer" ref="51035644bd0291c76238b39be6745570" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned char* <a class="el" href="class_r_t_c_p_compound_handler.html#51035644bd0291c76238b39be6745570">RTCPCompoundHandler::rtcpSendBuffer</a><code> [protected]</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><a class="el" href="rtcppkt_8h_source.html">rtcppkt.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Jul 24 21:42:25 2009 for ccRTP 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>
