<!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: RTPApplication 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>RTPApplication Class Reference<br>
<small>
[<a class="el" href="group__sources.html">Participants and synchronization sources.</a>]</small>
</h1><!-- doxytag: class="RTPApplication" --><!-- doxytag: inherits="SDESItemsHolder" -->An RTP application, holding identifying RTCP SDES item values.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="sources_8h_source.html">sources.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for RTPApplication:</div>
<div class="dynsection">
<p><center><img src="class_r_t_p_application.png" usemap="#RTPApplication_map" border="0" alt=""></center>
<map name="RTPApplication_map">
<area href="class_s_d_e_s_items_holder.html" alt="SDESItemsHolder" shape="rect" coords="0,0,111,24">
</map>
</div>
<p>
<a href="class_r_t_p_application-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"><b>ParticipantLink</b></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_p_application_1_1_participants_iterator.html">ParticipantsIterator</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Iterator through the list of participants in this session. <a href="class_r_t_p_application_1_1_participants_iterator.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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_p_application.html#c12eb8d0ffc989199cffad9b25116e67">RTPApplication</a> (const std::string &cname)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new RTP application. <a href="#c12eb8d0ffc989199cffad9b25116e67"></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_application.html#088665500f42ed6f542799b764a771ab">~RTPApplication</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_application.html#8f508dc361e2127b6ce494af67ca41c6">setSDESItem</a> (<a class="el" href="group__rtcppacket.html#gf6d38e5ccbbcdf2a24ebbd4fc5b4eeac">SDESItemType</a> item, const std::string &val)</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_application.html#14ab3a89494164c1127bbdc0253acb54">setPRIVPrefix</a> (const std::string &val)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_p_application.html#decf13b59affe92deb0471dd06ffb38f">getSDESItem</a> (<a class="el" href="group__rtcppacket.html#gf6d38e5ccbbcdf2a24ebbd4fc5b4eeac">SDESItemType</a> item) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_p_application.html#5e195a1b1634df9d6e49e298926a95f2">getPRIVPrefix</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_r_t_p_application_1_1_participants_iterator.html">ParticipantsIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_p_application.html#8b50b594ea5e44690c95fde779b0a698">begin</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_r_t_p_application_1_1_participants_iterator.html">ParticipantsIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_p_application.html#6d08c520e5dd2409206f196f6d5ca2a1">end</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="class_participant.html">Participant</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_p_application.html#36a5a7f4ecc1aa05c762fb57cef9edff">getParticipant</a> (const std::string &cname) const </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_p_application.html#7401d03ad7238950fb4e46a9e77fef43">ApplicationHandler</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
An RTP application, holding identifying RTCP SDES item values.
<p>
Represents local participants.<p>
An application in the context of RTP: an entity that has a CNAME (unique identifier in the form of user@host.domain) as well as other RTCP SDES items (such as NAME or TOOL), and may open a number of RTP sessions. Each application is a different source of synchronization (with a potentially diferent SSRC identifier) in each RTP session it participates. All the sources of synchronization from a participant are tied together by means of the CNAME.<p>
The definition of this class allows applications based on ccRTP to implement several "RTP applications" in the same process. Each object of this class represents a local participant.<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>
<dl compact><dt><b>Examples: </b></dt><dd>
<p>
<a class="el" href="ccrtptest_8cpp-example.html#_a6">ccrtptest.cpp</a>.</dl><hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="c12eb8d0ffc989199cffad9b25116e67"></a><!-- doxytag: member="RTPApplication::RTPApplication" ref="c12eb8d0ffc989199cffad9b25116e67" args="(const std::string &cname)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">RTPApplication::RTPApplication </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>cname</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create a new RTP application.
<p>
If the CNAME string provided has zero length, it is guessed from the user and machine name.<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>cname</em> </td><td>Local participant canonical name. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="088665500f42ed6f542799b764a771ab"></a><!-- doxytag: member="RTPApplication::~RTPApplication" ref="088665500f42ed6f542799b764a771ab" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">RTPApplication::~RTPApplication </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="8b50b594ea5e44690c95fde779b0a698"></a><!-- doxytag: member="RTPApplication::begin" ref="8b50b594ea5e44690c95fde779b0a698" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_r_t_p_application_1_1_participants_iterator.html">ParticipantsIterator</a> RTPApplication::begin </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="ccrtptest_8cpp-example.html#a20">ccrtptest.cpp</a>.</dl>
</div>
</div><p>
<a class="anchor" name="6d08c520e5dd2409206f196f6d5ca2a1"></a><!-- doxytag: member="RTPApplication::end" ref="6d08c520e5dd2409206f196f6d5ca2a1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_r_t_p_application_1_1_participants_iterator.html">ParticipantsIterator</a> RTPApplication::end </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="ccrtptest_8cpp-example.html#a21">ccrtptest.cpp</a>.</dl>
</div>
</div><p>
<a class="anchor" name="36a5a7f4ecc1aa05c762fb57cef9edff"></a><!-- doxytag: member="RTPApplication::getParticipant" ref="36a5a7f4ecc1aa05c762fb57cef9edff" args="(const std::string &cname) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="class_participant.html">Participant</a>* RTPApplication::getParticipant </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>cname</em> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="5e195a1b1634df9d6e49e298926a95f2"></a><!-- doxytag: member="RTPApplication::getPRIVPrefix" ref="5e195a1b1634df9d6e49e298926a95f2" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string& RTPApplication::getPRIVPrefix </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Reimplemented from <a class="el" href="class_s_d_e_s_items_holder.html#75c4089724bf170b962417818ee025b2">SDESItemsHolder</a>.</p>
</div>
</div><p>
<a class="anchor" name="decf13b59affe92deb0471dd06ffb38f"></a><!-- doxytag: member="RTPApplication::getSDESItem" ref="decf13b59affe92deb0471dd06ffb38f" args="(SDESItemType item) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string& RTPApplication::getSDESItem </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__rtcppacket.html#gf6d38e5ccbbcdf2a24ebbd4fc5b4eeac">SDESItemType</a> </td>
<td class="paramname"> <em>item</em> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="14ab3a89494164c1127bbdc0253acb54"></a><!-- doxytag: member="RTPApplication::setPRIVPrefix" ref="14ab3a89494164c1127bbdc0253acb54" args="(const std::string &val)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RTPApplication::setPRIVPrefix </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>val</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Reimplemented from <a class="el" href="class_s_d_e_s_items_holder.html#8c1fe0c3f96576d3ac7f419c20806e71">SDESItemsHolder</a>.</p>
</div>
</div><p>
<a class="anchor" name="8f508dc361e2127b6ce494af67ca41c6"></a><!-- doxytag: member="RTPApplication::setSDESItem" ref="8f508dc361e2127b6ce494af67ca41c6" args="(SDESItemType item, const std::string &val)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RTPApplication::setSDESItem </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__rtcppacket.html#gf6d38e5ccbbcdf2a24ebbd4fc5b4eeac">SDESItemType</a> </td>
<td class="paramname"> <em>item</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>val</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="ccrtptest_8cpp-example.html#a8">ccrtptest.cpp</a>, <a class="el" href="rtplisten_8cpp-example.html#a3">rtplisten.cpp</a>, and <a class="el" href="rtpsend_8cpp-example.html#a3">rtpsend.cpp</a>.</dl>
</div>
</div><p>
<hr><h2>Friends And Related Function Documentation</h2>
<a class="anchor" name="7401d03ad7238950fb4e46a9e77fef43"></a><!-- doxytag: member="RTPApplication::ApplicationHandler" ref="7401d03ad7238950fb4e46a9e77fef43" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="class_application_handler.html">ApplicationHandler</a><code> [friend]</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="sources_8h_source.html">sources.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>
