<!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: RTPProcessor 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 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 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 class="navpath"><a class="el" href="namespaceTelEngine.html">TelEngine</a>::<a class="el" href="classTelEngine_1_1RTPProcessor.html">RTPProcessor</a> </div> </div> <div class="contents"> <h1>RTPProcessor Class Reference</h1><!-- doxytag: class="TelEngine::RTPProcessor" --><!-- doxytag: inherits="TelEngine::GenObject" -->Base class to ease creation of RTP forwarders. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="yatertp_8h-source.html">yatertp.h</a>></code> <p> <div class="dynheader"> Inheritance diagram for RTPProcessor:</div> <div class="dynsection"> <p><center><img src="classTelEngine_1_1RTPProcessor.png" usemap="#RTPProcessor_map" border="0" alt=""></center> <map name="RTPProcessor_map"> <area href="classTelEngine_1_1GenObject.html" alt="GenObject" shape="rect" coords="103,0,196,24"> <area href="classTelEngine_1_1RTPDejitter.html" alt="RTPDejitter" shape="rect" coords="0,112,93,136"> <area href="classTelEngine_1_1RTPSession.html" alt="RTPSession" shape="rect" coords="103,112,196,136"> <area href="classTelEngine_1_1RTPTransport.html" alt="RTPTransport" shape="rect" coords="206,112,299,136"> </map> </div> <p> <a href="classTelEngine_1_1RTPProcessor-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="classTelEngine_1_1RTPProcessor.html#4f7292bf43990a204e66e08da31df117">RTPProcessor</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1RTPProcessor.html#eae13e7e1f80752a38933991552c4d9e">~RTPProcessor</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1RTPGroup.html">RTPGroup</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1RTPProcessor.html#84ff68a20732aab228970eecd9fbcd0c">group</a> () const </td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1RTPProcessor.html#164fa8b4687073cdc12af2afcb48e475">rtpData</a> (const void *data, int len)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1RTPProcessor.html#a138cb22b90c7395c1a5d13ad507d3fd">rtcpData</a> (const void *data, int len)</td></tr> <tr><td colspan="2"><br><h2>Protected 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="classTelEngine_1_1RTPProcessor.html#bcbfd3ca03dd93818f1248e60da1e8d4">group</a> (<a class="el" href="classTelEngine_1_1RTPGroup.html">RTPGroup</a> *newgrp)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1RTPProcessor.html#2cc5feab91a437e2a272bc093c0d4ee0">timerTick</a> (const <a class="el" href="classTelEngine_1_1Time.html">Time</a> &when)=0</td></tr> <tr><td colspan="2"><br><h2>Friends</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5aae561bd4662dedc8dbca353b7d3fdf"></a><!-- doxytag: member="TelEngine::RTPProcessor::RTPGroup" ref="5aae561bd4662dedc8dbca353b7d3fdf" args="" --> class </td><td class="memItemRight" valign="bottom"><b>RTPGroup</b></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="63132bd15f8506b1c5e31f3ab53c5707"></a><!-- doxytag: member="TelEngine::RTPProcessor::RTPTransport" ref="63132bd15f8506b1c5e31f3ab53c5707" args="" --> class </td><td class="memItemRight" valign="bottom"><b>RTPTransport</b></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="26e33ecea0308f1345ac1e8010b0ecb8"></a><!-- doxytag: member="TelEngine::RTPProcessor::RTPSession" ref="26e33ecea0308f1345ac1e8010b0ecb8" args="" --> class </td><td class="memItemRight" valign="bottom"><b>RTPSession</b></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="48333a239a24076cbf76c7d79acbacda"></a><!-- doxytag: member="TelEngine::RTPProcessor::RTPSender" ref="48333a239a24076cbf76c7d79acbacda" args="" --> class </td><td class="memItemRight" valign="bottom"><b>RTPSender</b></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e4cddb2feea9c8d0176ba5ae21e45c6a"></a><!-- doxytag: member="TelEngine::RTPProcessor::RTPReceiver" ref="e4cddb2feea9c8d0176ba5ae21e45c6a" args="" --> class </td><td class="memItemRight" valign="bottom"><b>RTPReceiver</b></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> Base class to ease creation of RTP forwarders. <p> A base class that contains just placeholders to process raw RTP and RTCP packets. <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="4f7292bf43990a204e66e08da31df117"></a><!-- doxytag: member="TelEngine::RTPProcessor::RTPProcessor" ref="4f7292bf43990a204e66e08da31df117" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classTelEngine_1_1RTPProcessor.html">RTPProcessor</a> </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p> Constructor - processor should be later inserted in a RTP group </div> </div><p> <a class="anchor" name="eae13e7e1f80752a38933991552c4d9e"></a><!-- doxytag: member="TelEngine::RTPProcessor::~RTPProcessor" ref="eae13e7e1f80752a38933991552c4d9e" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual ~<a class="el" href="classTelEngine_1_1RTPProcessor.html">RTPProcessor</a> </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Destructor - removes itself from the RTP group </div> </div><p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="bcbfd3ca03dd93818f1248e60da1e8d4"></a><!-- doxytag: member="TelEngine::RTPProcessor::group" ref="bcbfd3ca03dd93818f1248e60da1e8d4" args="(RTPGroup *newgrp)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void group </td> <td>(</td> <td class="paramtype"><a class="el" href="classTelEngine_1_1RTPGroup.html">RTPGroup</a> * </td> <td class="paramname"> <em>newgrp</em> </td> <td> ) </td> <td><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Set a new RTP group for this processor <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>newgrp</em> </td><td>New group to join this processor, the old one will be left </td></tr> </table> </dl> </div> </div><p> <a class="anchor" name="84ff68a20732aab228970eecd9fbcd0c"></a><!-- doxytag: member="TelEngine::RTPProcessor::group" ref="84ff68a20732aab228970eecd9fbcd0c" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classTelEngine_1_1RTPGroup.html">RTPGroup</a>* group </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Get the RTP group to which this processor belongs <dl class="return" compact><dt><b>Returns:</b></dt><dd>Pointer to the RTP group this processor has joined </dd></dl> </div> </div><p> <a class="anchor" name="a138cb22b90c7395c1a5d13ad507d3fd"></a><!-- doxytag: member="TelEngine::RTPProcessor::rtcpData" ref="a138cb22b90c7395c1a5d13ad507d3fd" args="(const void *data, int len)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void rtcpData </td> <td>(</td> <td class="paramtype">const void * </td> <td class="paramname"> <em>data</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"> <em>len</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> This method is called to send or process a RTCP packet <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>Pointer to raw RTCP data </td></tr> <tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>Length of the data packet </td></tr> </table> </dl> <p>Reimplemented in <a class="el" href="classTelEngine_1_1RTPTransport.html#a138cb22b90c7395c1a5d13ad507d3fd">RTPTransport</a>, and <a class="el" href="classTelEngine_1_1RTPSession.html#a138cb22b90c7395c1a5d13ad507d3fd">RTPSession</a>.</p> </div> </div><p> <a class="anchor" name="164fa8b4687073cdc12af2afcb48e475"></a><!-- doxytag: member="TelEngine::RTPProcessor::rtpData" ref="164fa8b4687073cdc12af2afcb48e475" args="(const void *data, int len)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void rtpData </td> <td>(</td> <td class="paramtype">const void * </td> <td class="paramname"> <em>data</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"> <em>len</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> This method is called to send or process a RTP packet <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>Pointer to raw RTP data </td></tr> <tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>Length of the data packet </td></tr> </table> </dl> <p>Reimplemented in <a class="el" href="classTelEngine_1_1RTPTransport.html#164fa8b4687073cdc12af2afcb48e475">RTPTransport</a>, and <a class="el" href="classTelEngine_1_1RTPSession.html#164fa8b4687073cdc12af2afcb48e475">RTPSession</a>.</p> </div> </div><p> <a class="anchor" name="2cc5feab91a437e2a272bc093c0d4ee0"></a><!-- doxytag: member="TelEngine::RTPProcessor::timerTick" ref="2cc5feab91a437e2a272bc093c0d4ee0" args="(const Time &when)=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void timerTick </td> <td>(</td> <td class="paramtype">const <a class="el" href="classTelEngine_1_1Time.html">Time</a> & </td> <td class="paramname"> <em>when</em> </td> <td> ) </td> <td><code> [protected, pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Method called periodically to keep the data flowing <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>when</em> </td><td><a class="el" href="classTelEngine_1_1Time.html" title="A time holding class.">Time</a> to use as base in all computing </td></tr> </table> </dl> <p>Implemented in <a class="el" href="classTelEngine_1_1RTPTransport.html#c7cf24f02cfa3147bf2cbf6434edb9c0">RTPTransport</a>, <a class="el" href="classTelEngine_1_1RTPDejitter.html#c7cf24f02cfa3147bf2cbf6434edb9c0">RTPDejitter</a>, and <a class="el" href="classTelEngine_1_1RTPSession.html#c7cf24f02cfa3147bf2cbf6434edb9c0">RTPSession</a>.</p> </div> </div><p> <hr>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="yatertp_8h-source.html">yatertp.h</a></ul> </div> <hr size="1"><address style="text-align: right;"><small>Generated on Sun Dec 7 21:36:13 2008 for Yate by <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>