<!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: RTPBaseIO 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_1RTPBaseIO.html">RTPBaseIO</a>
</div>
</div>
<div class="contents">
<h1>RTPBaseIO Class Reference</h1><!-- doxytag: class="TelEngine::RTPBaseIO" -->Common send/recv variables holder.
<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 RTPBaseIO:</div>
<div class="dynsection">
<p><center><img src="classTelEngine_1_1RTPBaseIO.png" usemap="#RTPBaseIO_map" border="0" alt=""></center>
<map name="RTPBaseIO_map">
<area href="classTelEngine_1_1RTPReceiver.html" alt="RTPReceiver" shape="rect" coords="0,56,86,80">
<area href="classTelEngine_1_1RTPSender.html" alt="RTPSender" shape="rect" coords="96,56,182,80">
</map>
</div>
<p>
<a href="classTelEngine_1_1RTPBaseIO-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_1RTPBaseIO.html#c1e34dceee04e0dea318d29d3a898c63">RTPBaseIO</a> (<a class="el" href="classTelEngine_1_1RTPSession.html">RTPSession</a> *session=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1RTPBaseIO.html#a14fd94429acc8dda16955f479aa9c0c">~RTPBaseIO</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1RTPBaseIO.html#fda7d5d66e54f54d31cfae7e3dd62610">dataPayload</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1RTPBaseIO.html#eb1428e94394422817571038283d9cf4">dataPayload</a> (int type)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1RTPBaseIO.html#77dcda3e3023b505bd3aa0615483d59a">eventPayload</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1RTPBaseIO.html#84a2c14507b3a9dfb577f7446412abe3">eventPayload</a> (int type)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1RTPBaseIO.html#81537afc6785957e4ed44fa5d288af55">silencePayload</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1RTPBaseIO.html#7b250a94c61f6e820856a6196ea2845a">silencePayload</a> (int type)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1RTPBaseIO.html#6c66115bc5b252363a1122941f72794a">ssrcInit</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1RTPBaseIO.html#d20897c5c8bd47f5d4005989bead0e55">reset</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1RTPBaseIO.html#d4290dd7f97a07cee15983189a40ecaa">ssrc</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1RTPBaseIO.html#32bc94e72f1a3d88343e5be151994fdd">ssrc</a> (unsigned int src)</td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></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_1RTPBaseIO.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>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7b228b6e1e5aa6e437131e78e68d6752"></a><!-- doxytag: member="TelEngine::RTPBaseIO::m_session" ref="7b228b6e1e5aa6e437131e78e68d6752" args="" -->
<a class="el" href="classTelEngine_1_1RTPSession.html">RTPSession</a> * </td><td class="memItemRight" valign="bottom"><b>m_session</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bdfaae36b9ba5b354b9b6c177f13017c"></a><!-- doxytag: member="TelEngine::RTPBaseIO::m_ssrcInit" ref="bdfaae36b9ba5b354b9b6c177f13017c" args="" -->
bool </td><td class="memItemRight" valign="bottom"><b>m_ssrcInit</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="009fc5112c7d6b6a869e17f29aa946d1"></a><!-- doxytag: member="TelEngine::RTPBaseIO::m_ssrc" ref="009fc5112c7d6b6a869e17f29aa946d1" args="" -->
u_int32_t </td><td class="memItemRight" valign="bottom"><b>m_ssrc</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6bc37a14a0d91faa129ab53231c5f730"></a><!-- doxytag: member="TelEngine::RTPBaseIO::m_ts" ref="6bc37a14a0d91faa129ab53231c5f730" args="" -->
u_int32_t </td><td class="memItemRight" valign="bottom"><b>m_ts</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8dd70c3b4ae238ec7f7e8861470ea642"></a><!-- doxytag: member="TelEngine::RTPBaseIO::m_seq" ref="8dd70c3b4ae238ec7f7e8861470ea642" args="" -->
u_int16_t </td><td class="memItemRight" valign="bottom"><b>m_seq</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1145f18a8a69cf9dc2991ea3327aca87"></a><!-- doxytag: member="TelEngine::RTPBaseIO::m_evTs" ref="1145f18a8a69cf9dc2991ea3327aca87" args="" -->
u_int32_t </td><td class="memItemRight" valign="bottom"><b>m_evTs</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="55f2da00042442efc50147dfc0ae1f79"></a><!-- doxytag: member="TelEngine::RTPBaseIO::m_evNum" ref="55f2da00042442efc50147dfc0ae1f79" args="" -->
int </td><td class="memItemRight" valign="bottom"><b>m_evNum</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5e1a54a04df6b94f7d239e67b7f94a59"></a><!-- doxytag: member="TelEngine::RTPBaseIO::m_evVol" ref="5e1a54a04df6b94f7d239e67b7f94a59" args="" -->
int </td><td class="memItemRight" valign="bottom"><b>m_evVol</b></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="26e33ecea0308f1345ac1e8010b0ecb8"></a><!-- doxytag: member="TelEngine::RTPBaseIO::RTPSession" ref="26e33ecea0308f1345ac1e8010b0ecb8" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>RTPSession</b></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Common send/recv variables holder.
<p>
Base class that holds common sender and receiver methods <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="c1e34dceee04e0dea318d29d3a898c63"></a><!-- doxytag: member="TelEngine::RTPBaseIO::RTPBaseIO" ref="c1e34dceee04e0dea318d29d3a898c63" args="(RTPSession *session=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1RTPBaseIO.html">RTPBaseIO</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1RTPSession.html">RTPSession</a> * </td>
<td class="paramname"> <em>session</em> = <code>0</code> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Default constructor.
</div>
</div><p>
<a class="anchor" name="a14fd94429acc8dda16955f479aa9c0c"></a><!-- doxytag: member="TelEngine::RTPBaseIO::~RTPBaseIO" ref="a14fd94429acc8dda16955f479aa9c0c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ~<a class="el" href="classTelEngine_1_1RTPBaseIO.html">RTPBaseIO</a> </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Do-nothing destructor
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="eb1428e94394422817571038283d9cf4"></a><!-- doxytag: member="TelEngine::RTPBaseIO::dataPayload" ref="eb1428e94394422817571038283d9cf4" args="(int type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool dataPayload </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>type</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the payload type for data packets <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>Payload type, -1 to disable </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if changed, false if invalid payload type </dd></dl>
</div>
</div><p>
<a class="anchor" name="fda7d5d66e54f54d31cfae7e3dd62610"></a><!-- doxytag: member="TelEngine::RTPBaseIO::dataPayload" ref="fda7d5d66e54f54d31cfae7e3dd62610" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int dataPayload </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the payload type for data packets <dl class="return" compact><dt><b>Returns:</b></dt><dd>Payload type, -1 if not set </dd></dl>
</div>
</div><p>
<a class="anchor" name="84a2c14507b3a9dfb577f7446412abe3"></a><!-- doxytag: member="TelEngine::RTPBaseIO::eventPayload" ref="84a2c14507b3a9dfb577f7446412abe3" args="(int type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool eventPayload </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>type</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the payload type for event packets <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>Payload type, -1 to disable </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if changed, false if invalid payload type </dd></dl>
</div>
</div><p>
<a class="anchor" name="77dcda3e3023b505bd3aa0615483d59a"></a><!-- doxytag: member="TelEngine::RTPBaseIO::eventPayload" ref="77dcda3e3023b505bd3aa0615483d59a" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int eventPayload </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the payload type for event packets <dl class="return" compact><dt><b>Returns:</b></dt><dd>Payload type, -1 if not set </dd></dl>
</div>
</div><p>
<a class="anchor" name="d20897c5c8bd47f5d4005989bead0e55"></a><!-- doxytag: member="TelEngine::RTPBaseIO::reset" ref="d20897c5c8bd47f5d4005989bead0e55" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void reset </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Requesting generation/grabbing of a new SSRC
</div>
</div><p>
<a class="anchor" name="7b250a94c61f6e820856a6196ea2845a"></a><!-- doxytag: member="TelEngine::RTPBaseIO::silencePayload" ref="7b250a94c61f6e820856a6196ea2845a" args="(int type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool silencePayload </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>type</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the payload type for Silence event packets. Thanks, Silence, for a new and incompatible way of sending events. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>Payload type, -1 to disable </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if changed, false if invalid payload type </dd></dl>
</div>
</div><p>
<a class="anchor" name="81537afc6785957e4ed44fa5d288af55"></a><!-- doxytag: member="TelEngine::RTPBaseIO::silencePayload" ref="81537afc6785957e4ed44fa5d288af55" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int silencePayload </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the payload type for Silence event packets <dl class="return" compact><dt><b>Returns:</b></dt><dd>Payload type, -1 if not set </dd></dl>
</div>
</div><p>
<a class="anchor" name="32bc94e72f1a3d88343e5be151994fdd"></a><!-- doxytag: member="TelEngine::RTPBaseIO::ssrc" ref="32bc94e72f1a3d88343e5be151994fdd" args="(unsigned int src)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ssrc </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>src</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Force a new known SSRC for all further packets
</div>
</div><p>
<a class="anchor" name="d4290dd7f97a07cee15983189a40ecaa"></a><!-- doxytag: member="TelEngine::RTPBaseIO::ssrc" ref="d4290dd7f97a07cee15983189a40ecaa" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int ssrc </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the value of the current SSRC, zero if not initialized yet <dl class="return" compact><dt><b>Returns:</b></dt><dd>Value of SSRC, zero if not initialized </dd></dl>
</div>
</div><p>
<a class="anchor" name="6c66115bc5b252363a1122941f72794a"></a><!-- doxytag: member="TelEngine::RTPBaseIO::ssrcInit" ref="6c66115bc5b252363a1122941f72794a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int ssrcInit </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return SSRC value, initialize to a new, random value if needed <dl class="return" compact><dt><b>Returns:</b></dt><dd>Current value of SSRC </dd></dl>
</div>
</div><p>
<a class="anchor" name="2cc5feab91a437e2a272bc093c0d4ee0"></a><!-- doxytag: member="TelEngine::RTPBaseIO::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_1RTPReceiver.html#c7cf24f02cfa3147bf2cbf6434edb9c0">RTPReceiver</a>, and <a class="el" href="classTelEngine_1_1RTPSender.html#c7cf24f02cfa3147bf2cbf6434edb9c0">RTPSender</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>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
eeacaa4eb55fa544d622989e42fc27b1
>
files
>
384
