<!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: RTPDataQueue 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>RTPDataQueue Class Reference<br>
<small>
[<a class="el" href="group__ioqueue.html">Generic RTP input/output queues.</a>]</small>
</h1><!-- doxytag: class="RTPDataQueue" --><!-- doxytag: inherits="IncomingDataQueue,OutgoingDataQueue" -->A packet queue handler for building different kinds of RTP protocol systems.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="ioqueue_8h_source.html">ioqueue.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for RTPDataQueue:</div>
<div class="dynsection">
<p><center><img src="class_r_t_p_data_queue.png" usemap="#RTPDataQueue_map" border="0" alt=""></center>
<map name="RTPDataQueue_map">
<area href="class_incoming_data_queue.html" alt="IncomingDataQueue" shape="rect" coords="247,112,402,136">
<area href="class_outgoing_data_queue.html" alt="OutgoingDataQueue" shape="rect" coords="1072,112,1227,136">
<area href="class_incoming_data_queue_base.html" alt="IncomingDataQueueBase" shape="rect" coords="0,56,155,80">
<area href="class_membership_bookkeeping.html" alt="MembershipBookkeeping" shape="rect" coords="495,56,650,80">
<area href="class_outgoing_data_queue_base.html" alt="OutgoingDataQueueBase" shape="rect" coords="990,56,1145,80">
<area href="class_destination_list_handler.html" alt="DestinationListHandler" shape="rect" coords="1155,56,1310,80">
<area href="class_r_t_p_queue_base.html" alt="RTPQueueBase" shape="rect" coords="0,0,155,24">
<area href="class_sync_source_handler.html" alt="SyncSourceHandler" shape="rect" coords="165,0,320,24">
<area href="class_participant_handler.html" alt="ParticipantHandler" shape="rect" coords="330,0,485,24">
<area href="class_application_handler.html" alt="ApplicationHandler" shape="rect" coords="495,0,650,24">
<area href="class_conflict_handler.html" alt="ConflictHandler" shape="rect" coords="660,0,815,24">
<area href="class_members.html" alt="Members" shape="rect" coords="825,0,980,24">
<area href="class_r_t_p_queue_base.html" alt="RTPQueueBase" shape="rect" coords="990,0,1145,24">
<area href="class_queue_r_t_c_p_manager.html" alt="QueueRTCPManager" shape="rect" coords="577,224,732,248">
<area href="class_r_t_p_duplex.html" alt="RTPDuplex" shape="rect" coords="742,224,897,248">
<area href="class_a_v_p_queue.html" alt="AVPQueue" shape="rect" coords="577,280,732,304">
</map>
</div>
<p>
<a href="class_r_t_p_data_queue-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 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_p_data_queue.html#fa5169fe853e891b04897fab6f8efca1">Tos</a> { <a class="el" href="class_r_t_p_data_queue.html#fa5169fe853e891b04897fab6f8efca16dc3c20fe1dd9d54192e897866e3768a">tosBestEffort</a>,
<a class="el" href="class_r_t_p_data_queue.html#fa5169fe853e891b04897fab6f8efca1e36023f8f3626a08e501ba65e4fefc24">tosEnhanced</a>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="rtp_8h.html" title="Generic and audio/video profile specific RTP interface of ccRTP.">rtp.h</a> cc++/rtp.h <a href="class_r_t_p_data_queue.html#fa5169fe853e891b04897fab6f8efca1">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_p_data_queue.html#0edd2b1a8a22780b60da8eb05921ad16">setTypeOfService</a> (<a class="el" href="class_r_t_p_data_queue.html#fa5169fe853e891b04897fab6f8efca1">Tos</a> tos)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Specify the kind of service the application expects to use. <a href="#0edd2b1a8a22780b60da8eb05921ad16"></a><br></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_p_data_queue.html#fee8bf2e2943d8785352eef2b804a91d">enableStack</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enable packet queue processing in the stack. <a href="#fee8bf2e2943d8785352eef2b804a91d"></a><br></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_p_data_queue.html#a68b9d380c05c3c2c18ad6920aab9179">disableStack</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Disable packet queue processing in the stack. <a href="#a68b9d380c05c3c2c18ad6920aab9179"></a><br></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_p_data_queue.html#3d2531b75d7c79d815cff5c487d4ecc8">isActive</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get active connection state flag. <a href="#3d2531b75d7c79d815cff5c487d4ecc8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">uint32 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_p_data_queue.html#bf7ff6490ae207bd2588bc0c69f8034a">getCurrentTimestamp</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the timestamp that should be given for a packet whose payload sampling instant corresponds to the current system time. <a href="#bf7ff6490ae207bd2588bc0c69f8034a"></a><br></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_p_data_queue.html#fa51bc8859fd4c7e5460caa31d8c518b">setSessionBandwidth</a> (uint32 bw)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Specify the bandwidth of the current session. <a href="#fa51bc8859fd4c7e5460caa31d8c518b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">uint32 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_p_data_queue.html#ed0854a61cdd61dc2c6915d81da44d88">getDefaultSessionBandwidth</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">uint32 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_p_data_queue.html#90a9016c723622f778aa9b078f400ab2">getSessionBandwidth</a> () const </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_p_data_queue.html#3c16280cc4b45de49acd61d0dc1f53b8">setTimeclock</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the packet timeclock for synchronizing timestamps. <a href="#3c16280cc4b45de49acd61d0dc1f53b8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">timeout_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_p_data_queue.html#1007b5aceb1feb516cdd5bdd34318b6b">getTimeclock</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the packet timeclock for synchronizing timestamps. <a href="#1007b5aceb1feb516cdd5bdd34318b6b"></a><br></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_p_data_queue.html#02a7fec519ec7c15650224e108959a62">RTPDataQueue</a> (uint32 size=<a class="el" href="class_membership_bookkeeping.html#53ba5e9495dfdb9ec16c551206796d99">defaultMembersHashSize</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#02a7fec519ec7c15650224e108959a62"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_p_data_queue.html#767fd472543461067810641e8ce11bf3">RTPDataQueue</a> (uint32 *ssrc, uint32 size=<a class="el" href="class_membership_bookkeeping.html#53ba5e9495dfdb9ec16c551206796d99">defaultMembersHashSize</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Using this constructor you can start a session with the given ssrc, instead of the usual randomly generated one. <a href="#767fd472543461067810641e8ce11bf3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_p_data_queue.html#15ff7c0ccea0eb5749b60c4ef7d08f0d">~RTPDataQueue</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The queue destructor flushes the queue and stops all services. <a href="#15ff7c0ccea0eb5749b60c4ef7d08f0d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_p_data_queue.html#e9f0d6236da0cee4c6b5189c0daa633d">timerTick</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A plugin point for timer tick driven events. <a href="#e9f0d6236da0cee4c6b5189c0daa633d"></a><br></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_p_data_queue.html#3cda7f313b23c9e00df8e54ed091e6a7">renewLocalSSRC</a> ()</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_p_data_queue.html#73039fed28d74fc6fdae60ecf94a0fe9">endQueue</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This method ends the queue. <a href="#73039fed28d74fc6fdae60ecf94a0fe9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_p_data_queue.html#55e55a5fe67dfd3bec5ed7ea553b9c8d">isPendingData</a> (<a class="el" href="base_8h.html#c16d853255145e6a903914eb376a84bb">microtimeout_t</a> timeout)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This function is used to check for and schedule against arriving packets based on the derived connection type. <a href="#55e55a5fe67dfd3bec5ed7ea553b9c8d"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A packet queue handler for building different kinds of RTP protocol systems.
<p>
The queue manages both incoming and outgoing RTP packets, as well as synchronization and transmission/reception timers. By making the queue handler a seperate base class it becomes possible to define RTP classes for RTP profiles and sessions of different types.<p>
Outgoing packets are sent via the <a class="el" href="class_outgoing_data_queue.html#c47cec242d96bc326f0292890e570d64" title="This is used to create a data packet in the send queue.">OutgoingDataQueue::putData</a> method.<p>
Incoming packets can be retrieved via <a class="el" href="class_incoming_data_queue.html#830c8a49a36dcd3e30c4e98f15e8af14" title="Retreive data from a specific timestamped packet if such a packet is currently available...">IncomingDataQueue::getData</a> method.<p>
<dl class="author" compact><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@ostel.com">dyfet@ostel.com</a>> RTP data queue handler. </dd></dl>
<hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="fa5169fe853e891b04897fab6f8efca1"></a><!-- doxytag: member="RTPDataQueue::Tos" ref="fa5169fe853e891b04897fab6f8efca1" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="class_r_t_p_data_queue.html#fa5169fe853e891b04897fab6f8efca1">RTPDataQueue::Tos</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<a class="el" href="rtp_8h.html" title="Generic and audio/video profile specific RTP interface of ccRTP.">rtp.h</a> cc++/rtp.h
<p>
Type of network service the application uses.<p>
If the application uses enhanced network service, for instance Integrated Services or Differentiated Services, it <em>has not</em> to ensure fair competition with TCP, provided that the requested service is actually being delivered. Whenever the application uses best-effort service or the requested enhanced service is not actually being delivered, it <em>has</em> to ensure fair competition with TCP. By default, best-effot is assumed.<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>Although not required, RTP packets are always sent on top of UDP segments. No other underlying transport protocol is supported at present.</dd></dl>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="fa5169fe853e891b04897fab6f8efca16dc3c20fe1dd9d54192e897866e3768a"></a><!-- doxytag: member="tosBestEffort" ref="fa5169fe853e891b04897fab6f8efca16dc3c20fe1dd9d54192e897866e3768a" args="" -->tosBestEffort</em> </td><td>
Best-effort network service. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="fa5169fe853e891b04897fab6f8efca1e36023f8f3626a08e501ba65e4fefc24"></a><!-- doxytag: member="tosEnhanced" ref="fa5169fe853e891b04897fab6f8efca1e36023f8f3626a08e501ba65e4fefc24" args="" -->tosEnhanced</em> </td><td>
Enhanced network service. </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="02a7fec519ec7c15650224e108959a62"></a><!-- doxytag: member="RTPDataQueue::RTPDataQueue" ref="02a7fec519ec7c15650224e108959a62" args="(uint32 size=defaultMembersHashSize)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">RTPDataQueue::RTPDataQueue </td>
<td>(</td>
<td class="paramtype">uint32 </td>
<td class="paramname"> <em>size</em> = <code><a class="el" href="class_membership_bookkeeping.html#53ba5e9495dfdb9ec16c551206796d99">defaultMembersHashSize</a></code> </td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor.
<p>
This will generate a random application SSRC identifier.<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>size</em> </td><td>an estimation of the number of participants in the session </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="767fd472543461067810641e8ce11bf3"></a><!-- doxytag: member="RTPDataQueue::RTPDataQueue" ref="767fd472543461067810641e8ce11bf3" args="(uint32 *ssrc, uint32 size=defaultMembersHashSize)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">RTPDataQueue::RTPDataQueue </td>
<td>(</td>
<td class="paramtype">uint32 * </td>
<td class="paramname"> <em>ssrc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32 </td>
<td class="paramname"> <em>size</em> = <code><a class="el" href="class_membership_bookkeeping.html#53ba5e9495dfdb9ec16c551206796d99">defaultMembersHashSize</a></code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Using this constructor you can start a session with the given ssrc, instead of the usual randomly generated one.
<p>
This is necessary when you need to initiate several sessions having the same SSRC identifier, for instance, to implement layered encoding, in which case each layer is managed through a different session but all sessions share the same SSRC identifier.<p>
<dl class="warning" compact><dt><b>Warning:</b></dt><dd>This doesn't seem to be a good solution</dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ssrc</em> </td><td>Synchronization SouRCe identifier for this session </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>an estimation of the number of participants in the session </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="15ff7c0ccea0eb5749b60c4ef7d08f0d"></a><!-- doxytag: member="RTPDataQueue::~RTPDataQueue" ref="15ff7c0ccea0eb5749b60c4ef7d08f0d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual RTPDataQueue::~RTPDataQueue </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The queue destructor flushes the queue and stops all services.
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a68b9d380c05c3c2c18ad6920aab9179"></a><!-- doxytag: member="RTPDataQueue::disableStack" ref="a68b9d380c05c3c2c18ad6920aab9179" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RTPDataQueue::disableStack </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Disable packet queue processing in the stack.
<p>
</div>
</div><p>
<a class="anchor" name="fee8bf2e2943d8785352eef2b804a91d"></a><!-- doxytag: member="RTPDataQueue::enableStack" ref="fee8bf2e2943d8785352eef2b804a91d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RTPDataQueue::enableStack </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Enable packet queue processing in the stack.
<p>
This method will not any thread of execution.
</div>
</div><p>
<a class="anchor" name="73039fed28d74fc6fdae60ecf94a0fe9"></a><!-- doxytag: member="RTPDataQueue::endQueue" ref="73039fed28d74fc6fdae60ecf94a0fe9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RTPDataQueue::endQueue </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This method ends the queue.
<p>
</div>
</div><p>
<a class="anchor" name="bf7ff6490ae207bd2588bc0c69f8034a"></a><!-- doxytag: member="RTPDataQueue::getCurrentTimestamp" ref="bf7ff6490ae207bd2588bc0c69f8034a" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32 RTPDataQueue::getCurrentTimestamp </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the timestamp that should be given for a packet whose payload sampling instant corresponds to the current system time.
<p>
The timestamp applications should provide for each packet represents the sampling instant of its payload and should not be a reading of the system clock. Nevertheless, the internal operation of the RTP stack relies on the accuracy of the provided timestamp, since several computations assume that there is a certain degree of correspondence between the timestamp and the system clock.<p>
It is recommended that applications use this method in order to <em>periodically adjust the RTP timestamp</em>.<p>
In particular, it is advisable getting the timestamp corresponding to the first sampling instant or any instant after a period of inactivity through a call to this method.<p>
Applications should use the nominal sampling or any other value provided by the coder in order to compute the next timestamps with minimum computational requirement.<p>
For instance, an application using an RTP profile that specifies a fixed sampling rate of 8 Khz with eight bits per sample, continuously transmitting audio blocks 80 octets long, would transmit 100 packets every second. Every packet would carry a timestamp 80 units greater than the previous one. So, the first timestamp would be obtained from this method, whereas the following ones would be computed adding 80 every time. Also the timestamp should be increased for every block whether it is put in the queue or dropped.<p>
The aforementioned increment can be obtained from the RTPDataQueue::getTimestampIncrement() method rather than computing it by hand in the application.<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>Frame based applications must follow a specific timestamping method, probably specified in a profile.<p>
You should take into account that by default ccRTP assumes that the application begins sampling at the queue creation time. Moreover, the first sampling instant is assigned a "user visible" timestamp of 0, although the RTP stack will then add internally a ramdom offset unknown to the application. That is to say, the application may count samples from 0 in order to get the timestamp for the next packet, provided that the first sampling instant is the same as the queue creation time. Nevertheless, this simpler way of starting will not be as accurate as it would be if the application got at least the first timestamp through getCurrentTimestamp. <em>We provide this option since ccRTP interface is evolving, but we admit that it is ugly, we could remove this option or even replace uint32 timestamps with a restrictively regulated object; suggestions are gladly welcomed</em> </dd></dl>
</div>
</div><p>
<a class="anchor" name="ed0854a61cdd61dc2c6915d81da44d88"></a><!-- doxytag: member="RTPDataQueue::getDefaultSessionBandwidth" ref="ed0854a61cdd61dc2c6915d81da44d88" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32 RTPDataQueue::getDefaultSessionBandwidth </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="90a9016c723622f778aa9b078f400ab2"></a><!-- doxytag: member="RTPDataQueue::getSessionBandwidth" ref="90a9016c723622f778aa9b078f400ab2" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32 RTPDataQueue::getSessionBandwidth </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="1007b5aceb1feb516cdd5bdd34318b6b"></a><!-- doxytag: member="RTPDataQueue::getTimeclock" ref="1007b5aceb1feb516cdd5bdd34318b6b" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">timeout_t RTPDataQueue::getTimeclock </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the packet timeclock for synchronizing timestamps.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>runtime in milliseconds since last set. </dd></dl>
</div>
</div><p>
<a class="anchor" name="3d2531b75d7c79d815cff5c487d4ecc8"></a><!-- doxytag: member="RTPDataQueue::isActive" ref="3d2531b75d7c79d815cff5c487d4ecc8" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool RTPDataQueue::isActive </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get active connection state flag.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if connection "active". </dd></dl>
</div>
</div><p>
<a class="anchor" name="55e55a5fe67dfd3bec5ed7ea553b9c8d"></a><!-- doxytag: member="RTPDataQueue::isPendingData" ref="55e55a5fe67dfd3bec5ed7ea553b9c8d" args="(microtimeout_t timeout)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool RTPDataQueue::isPendingData </td>
<td>(</td>
<td class="paramtype"><a class="el" href="base_8h.html#c16d853255145e6a903914eb376a84bb">microtimeout_t</a> </td>
<td class="paramname"> <em>timeout</em> </td>
<td> ) </td>
<td><code> [protected, pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function is used to check for and schedule against arriving packets based on the derived connection type.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if packet waiting for processing. </dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>number</em> </td><td>of microseconds to wait. </td></tr>
</table>
</dl>
<p>Implemented in <a class="el" href="class_r_t_p_duplex.html#48eea122a1f60c696a5b181ee56ceeef">RTPDuplex</a>.</p>
</div>
</div><p>
<a class="anchor" name="3cda7f313b23c9e00df8e54ed091e6a7"></a><!-- doxytag: member="RTPDataQueue::renewLocalSSRC" ref="3cda7f313b23c9e00df8e54ed091e6a7" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RTPDataQueue::renewLocalSSRC </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Reimplemented from <a class="el" href="class_incoming_data_queue.html#7a8b5c6c0e3c934cece8e909a499efd6">IncomingDataQueue</a>.</p>
</div>
</div><p>
<a class="anchor" name="fa51bc8859fd4c7e5460caa31d8c518b"></a><!-- doxytag: member="RTPDataQueue::setSessionBandwidth" ref="fa51bc8859fd4c7e5460caa31d8c518b" args="(uint32 bw)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RTPDataQueue::setSessionBandwidth </td>
<td>(</td>
<td class="paramtype">uint32 </td>
<td class="paramname"> <em>bw</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Specify the bandwidth of the current session.
<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>bw</em> </td><td>bandwidth of the current session, in bits/s.</td></tr>
</table>
</dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="class_a_v_p_queue.html#3fd139decfd1175b7ad6a8abeed65bf5" title="Specify the bandwith available for control (RTCP) packets.">AVPQueue::setControlBandwidth()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="3c16280cc4b45de49acd61d0dc1f53b8"></a><!-- doxytag: member="RTPDataQueue::setTimeclock" ref="3c16280cc4b45de49acd61d0dc1f53b8" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RTPDataQueue::setTimeclock </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the packet timeclock for synchronizing timestamps.
<p>
</div>
</div><p>
<a class="anchor" name="0edd2b1a8a22780b60da8eb05921ad16"></a><!-- doxytag: member="RTPDataQueue::setTypeOfService" ref="0edd2b1a8a22780b60da8eb05921ad16" args="(Tos tos)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RTPDataQueue::setTypeOfService </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_r_t_p_data_queue.html#fa5169fe853e891b04897fab6f8efca1">Tos</a> </td>
<td class="paramname"> <em>tos</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Specify the kind of service the application expects to use.
<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>tos</em> </td><td>type of service the application expects to use</td></tr>
</table>
</dl>
<dl class="note" compact><dt><b>Note:</b></dt><dd>If enhanced service is specified but packet loss is high (the requested service does not appear to actually be delivered) ccRTP defaults to best-effort suitable behaviour: guarantee fair competition with TCP.</dd></dl>
</div>
</div><p>
<a class="anchor" name="e9f0d6236da0cee4c6b5189c0daa633d"></a><!-- doxytag: member="RTPDataQueue::timerTick" ref="e9f0d6236da0cee4c6b5189c0daa633d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void RTPDataQueue::timerTick </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
A plugin point for timer tick driven events.
<p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="ioqueue_8h_source.html">ioqueue.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>
