<!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: RTPTransport 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_1RTPTransport.html">RTPTransport</a>
</div>
</div>
<div class="contents">
<h1>RTPTransport Class Reference</h1><!-- doxytag: class="TelEngine::RTPTransport" --><!-- doxytag: inherits="TelEngine::RTPProcessor" -->Low level transport for RTP and RTCP.
<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 RTPTransport:</div>
<div class="dynsection">
<p><center><img src="classTelEngine_1_1RTPTransport.png" usemap="#RTPTransport_map" border="0" alt=""></center>
<map name="RTPTransport_map">
<area href="classTelEngine_1_1RTPProcessor.html" alt="RTPProcessor" shape="rect" coords="0,56,93,80">
<area href="classTelEngine_1_1GenObject.html" alt="GenObject" shape="rect" coords="0,0,93,24">
</map>
</div>
<p>
<a href="classTelEngine_1_1RTPTransport-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="classTelEngine_1_1RTPTransport.html#83689fe2ddb97d5e71cfdbaa2523e0cd">Activation</a> { <b>Inactive</b>,
<b>Bound</b>,
<b>Active</b>
}</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_1RTPTransport.html#da195ab0cef934fabf210644c922a139">RTPTransport</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_1RTPTransport.html#c0d6a95754e38a463ffdc3c58db21815">~RTPTransport</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_1RTPTransport.html#cc1d6f9ad80027ba394174481bb2ff4b">setProcessor</a> (<a class="el" href="classTelEngine_1_1RTPProcessor.html">RTPProcessor</a> *processor=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1RTPTransport.html#589a02f7b0eb2dc7342a457ac4b79208">setMonitor</a> (<a class="el" href="classTelEngine_1_1RTPProcessor.html">RTPProcessor</a> *monitor=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classTelEngine_1_1SocketAddr.html">SocketAddr</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1RTPTransport.html#45e26e58d122d5bbe6ae8450bbe25bdd">localAddr</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classTelEngine_1_1SocketAddr.html">SocketAddr</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1RTPTransport.html#bd9ce9296c8ed809a32784560b4f949c">remoteAddr</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_1RTPTransport.html#df36c38f34ad741fd4c2e883636349c1">localAddr</a> (<a class="el" href="classTelEngine_1_1SocketAddr.html">SocketAddr</a> &addr, bool rtcp=true)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1RTPTransport.html#6977b0779e8eb6688eeaaf7cd3f83918">remoteAddr</a> (<a class="el" href="classTelEngine_1_1SocketAddr.html">SocketAddr</a> &addr, bool sniff=false)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1RTPTransport.html#1fcca9fb9d420f36291204048a20461d">setTOS</a> (int tos)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1Socket.html">Socket</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1RTPTransport.html#86a95c26181bef5655e58f4735762fe9">rtpSock</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1RTPTransport.html#3937baed68e1a8143bf9ae9d47101de2">drillHole</a> ()</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_1RTPTransport.html#c7cf24f02cfa3147bf2cbf6434edb9c0">timerTick</a> (const <a class="el" href="classTelEngine_1_1Time.html">Time</a> &when)</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_1RTPTransport.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_1RTPTransport.html#a138cb22b90c7395c1a5d13ad507d3fd">rtcpData</a> (const void *data, int len)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Low level transport for RTP and RTCP.
<p>
Class that holds sockets and addresses for transporting RTP and RTCP packets. <hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="83689fe2ddb97d5e71cfdbaa2523e0cd"></a><!-- doxytag: member="TelEngine::RTPTransport::Activation" ref="83689fe2ddb97d5e71cfdbaa2523e0cd" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classTelEngine_1_1RTPTransport.html#83689fe2ddb97d5e71cfdbaa2523e0cd">Activation</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Activation status of the transport
</div>
</div><p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="da195ab0cef934fabf210644c922a139"></a><!-- doxytag: member="TelEngine::RTPTransport::RTPTransport" ref="da195ab0cef934fabf210644c922a139" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1RTPTransport.html">RTPTransport</a> </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor, creates an unconnected transport
</div>
</div><p>
<a class="anchor" name="c0d6a95754e38a463ffdc3c58db21815"></a><!-- doxytag: member="TelEngine::RTPTransport::~RTPTransport" ref="c0d6a95754e38a463ffdc3c58db21815" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ~<a class="el" href="classTelEngine_1_1RTPTransport.html">RTPTransport</a> </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="3937baed68e1a8143bf9ae9d47101de2"></a><!-- doxytag: member="TelEngine::RTPTransport::drillHole" ref="3937baed68e1a8143bf9ae9d47101de2" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool drillHole </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Drill a hole in a firewall or NAT for the RTP and RTCP sockets <dl class="return" compact><dt><b>Returns:</b></dt><dd>True if at least a packet was sent for the RTP socket </dd></dl>
</div>
</div><p>
<a class="anchor" name="df36c38f34ad741fd4c2e883636349c1"></a><!-- doxytag: member="TelEngine::RTPTransport::localAddr" ref="df36c38f34ad741fd4c2e883636349c1" args="(SocketAddr &addr, bool rtcp=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool localAddr </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1SocketAddr.html">SocketAddr</a> & </td>
<td class="paramname"> <em>addr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>rtcp</em> = <code>true</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the local network address of the RTP transport <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>addr</em> </td><td>New local RTP transport address </td></tr>
<tr><td valign="top"></td><td valign="top"><em>rtcp</em> </td><td>Enable RTCP transport </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if address set, false if a failure occured </dd></dl>
</div>
</div><p>
<a class="anchor" name="45e26e58d122d5bbe6ae8450bbe25bdd"></a><!-- doxytag: member="TelEngine::RTPTransport::localAddr" ref="45e26e58d122d5bbe6ae8450bbe25bdd" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classTelEngine_1_1SocketAddr.html">SocketAddr</a>& localAddr </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the local network address of the RTP transport <dl class="return" compact><dt><b>Returns:</b></dt><dd>Reference to the local RTP transport address </dd></dl>
</div>
</div><p>
<a class="anchor" name="6977b0779e8eb6688eeaaf7cd3f83918"></a><!-- doxytag: member="TelEngine::RTPTransport::remoteAddr" ref="6977b0779e8eb6688eeaaf7cd3f83918" args="(SocketAddr &addr, bool sniff=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool remoteAddr </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1SocketAddr.html">SocketAddr</a> & </td>
<td class="paramname"> <em>addr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>sniff</em> = <code>false</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the remote network address of the RTP transport <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>addr</em> </td><td>New remote RTP transport address </td></tr>
<tr><td valign="top"></td><td valign="top"><em>sniff</em> </td><td>Automatically adjust the address from the first incoming packet </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if address set, false if a failure occured </dd></dl>
</div>
</div><p>
<a class="anchor" name="bd9ce9296c8ed809a32784560b4f949c"></a><!-- doxytag: member="TelEngine::RTPTransport::remoteAddr" ref="bd9ce9296c8ed809a32784560b4f949c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classTelEngine_1_1SocketAddr.html">SocketAddr</a>& remoteAddr </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the remote network address of the RTP transport <dl class="return" compact><dt><b>Returns:</b></dt><dd>Reference to the remote RTP transport address </dd></dl>
</div>
</div><p>
<a class="anchor" name="a138cb22b90c7395c1a5d13ad507d3fd"></a><!-- doxytag: member="TelEngine::RTPTransport::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> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This method is called to send 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 from <a class="el" href="classTelEngine_1_1RTPProcessor.html#a138cb22b90c7395c1a5d13ad507d3fd">RTPProcessor</a>.</p>
</div>
</div><p>
<a class="anchor" name="164fa8b4687073cdc12af2afcb48e475"></a><!-- doxytag: member="TelEngine::RTPTransport::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> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This method is called to send 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 from <a class="el" href="classTelEngine_1_1RTPProcessor.html#164fa8b4687073cdc12af2afcb48e475">RTPProcessor</a>.</p>
</div>
</div><p>
<a class="anchor" name="86a95c26181bef5655e58f4735762fe9"></a><!-- doxytag: member="TelEngine::RTPTransport::rtpSock" ref="86a95c26181bef5655e58f4735762fe9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1Socket.html">Socket</a>* rtpSock </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the RTP socket used by this transport <dl class="return" compact><dt><b>Returns:</b></dt><dd>Pointer to the RTP socket </dd></dl>
</div>
</div><p>
<a class="anchor" name="589a02f7b0eb2dc7342a457ac4b79208"></a><!-- doxytag: member="TelEngine::RTPTransport::setMonitor" ref="589a02f7b0eb2dc7342a457ac4b79208" args="(RTPProcessor *monitor=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setMonitor </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1RTPProcessor.html">RTPProcessor</a> * </td>
<td class="paramname"> <em>monitor</em> = <code>0</code> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the RTP/RTCP monitor of data received by this transport <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>monitor</em> </td><td>A pointer to a second <a class="el" href="classTelEngine_1_1RTPProcessor.html" title="Base class to ease creation of RTP forwarders.">RTPProcessor</a> for this transport </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="cc1d6f9ad80027ba394174481bb2ff4b"></a><!-- doxytag: member="TelEngine::RTPTransport::setProcessor" ref="cc1d6f9ad80027ba394174481bb2ff4b" args="(RTPProcessor *processor=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setProcessor </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1RTPProcessor.html">RTPProcessor</a> * </td>
<td class="paramname"> <em>processor</em> = <code>0</code> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the RTP/RTCP processor of data received by this transport <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>processor</em> </td><td>A pointer to the <a class="el" href="classTelEngine_1_1RTPProcessor.html" title="Base class to ease creation of RTP forwarders.">RTPProcessor</a> for this transport </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="1fcca9fb9d420f36291204048a20461d"></a><!-- doxytag: member="TelEngine::RTPTransport::setTOS" ref="1fcca9fb9d420f36291204048a20461d" args="(int tos)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool setTOS </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>tos</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the Type Of Service for the RTP socket <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 bits to set </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if operation was successfull, false if an error occured </dd></dl>
</div>
</div><p>
<a class="anchor" name="c7cf24f02cfa3147bf2cbf6434edb9c0"></a><!-- doxytag: member="TelEngine::RTPTransport::timerTick" ref="c7cf24f02cfa3147bf2cbf6434edb9c0" args="(const Time &when)" -->
<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, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Method called periodically to read data out of sockets <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>Implements <a class="el" href="classTelEngine_1_1RTPProcessor.html#2cc5feab91a437e2a272bc093c0d4ee0">RTPProcessor</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
>
405
