<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <title>ccRTP: RTPApplication Class Reference</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> </head><body> <!-- Generated by Doxygen 1.4.4 --> <div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a> | <a class="qindex" href="pages.html">Related Pages</a> | <a class="qindex" href="examples.html">Examples</a></div> <h1>RTPApplication Class Reference<br> <small> [<a class="el" href="group__sources.html">Participants and synchronization sources.</a>, <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> <p>Inheritance diagram for RTPApplication: <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> <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>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#a0">RTPApplication</a> (const std::string &cname)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new RTP application. <a href="#a0"></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#a1">~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#a2">setSDESItem</a> (<a class="el" href="group__rtcppacket.html#ga2">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#a3">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#a4">getSDESItem</a> (<a class="el" href="group__rtcppacket.html#ga2">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#a5">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#a6">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#a7">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#a8">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#n0">ApplicationHandler</a></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> </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 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#_a17">ccrtptest.cpp</a>.</dl> <p> <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="a0"></a><!-- doxytag: member="RTPApplication::RTPApplication" ref="a0" args="(const std::string &cname)" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">RTPApplication::RTPApplication </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const std::string & </td> <td class="mdname1" valign="top" nowrap> <em>cname</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <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> </td> </tr> </table> <a class="anchor" name="a1"></a><!-- doxytag: member="RTPApplication::~RTPApplication" ref="a1" args="()" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">RTPApplication::~RTPApplication </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> </td> </tr> </table> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="a6"></a><!-- doxytag: member="RTPApplication::begin" ref="a6" args="()" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"><a class="el" href="class_r_t_p_application_1_1_participants_iterator.html">ParticipantsIterator</a> RTPApplication::begin </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [inline]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> <dl compact><dt><b>Examples: </b></dt><dd> <a class="el" href="ccrtptest_8cpp-example.html#a31">ccrtptest.cpp</a>.</dl> </td> </tr> </table> <a class="anchor" name="a7"></a><!-- doxytag: member="RTPApplication::end" ref="a7" args="()" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"><a class="el" href="class_r_t_p_application_1_1_participants_iterator.html">ParticipantsIterator</a> RTPApplication::end </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [inline]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> <dl compact><dt><b>Examples: </b></dt><dd> <a class="el" href="ccrtptest_8cpp-example.html#a32">ccrtptest.cpp</a>.</dl> </td> </tr> </table> <a class="anchor" name="a8"></a><!-- doxytag: member="RTPApplication::getParticipant" ref="a8" args="(const std::string &cname) const " --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">const <a class="el" href="class_participant.html">Participant</a>* RTPApplication::getParticipant </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const std::string & </td> <td class="mdname1" valign="top" nowrap> <em>cname</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap> const</td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> </td> </tr> </table> <a class="anchor" name="a5"></a><!-- doxytag: member="RTPApplication::getPRIVPrefix" ref="a5" args="() const " --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">const std::string& RTPApplication::getPRIVPrefix </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap> const<code> [inline]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> <p> Reimplemented from <a class="el" href="class_s_d_e_s_items_holder.html#a1">SDESItemsHolder</a>. </td> </tr> </table> <a class="anchor" name="a4"></a><!-- doxytag: member="RTPApplication::getSDESItem" ref="a4" args="(SDESItemType item) const " --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">const std::string& RTPApplication::getSDESItem </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="group__rtcppacket.html#ga2">SDESItemType</a> </td> <td class="mdname1" valign="top" nowrap> <em>item</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap> const<code> [inline]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> </td> </tr> </table> <a class="anchor" name="a3"></a><!-- doxytag: member="RTPApplication::setPRIVPrefix" ref="a3" args="(const std::string &val)" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">void RTPApplication::setPRIVPrefix </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const std::string & </td> <td class="mdname1" valign="top" nowrap> <em>val</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [inline]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> <p> Reimplemented from <a class="el" href="class_s_d_e_s_items_holder.html#a3">SDESItemsHolder</a>. </td> </tr> </table> <a class="anchor" name="a2"></a><!-- doxytag: member="RTPApplication::setSDESItem" ref="a2" args="(SDESItemType item, const std::string &val)" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">void RTPApplication::setSDESItem </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="group__rtcppacket.html#ga2">SDESItemType</a> </td> <td class="mdname" nowrap> <em>item</em>, </td> </tr> <tr> <td class="md" nowrap align="right"></td> <td class="md"></td> <td class="md" nowrap>const std::string & </td> <td class="mdname" nowrap> <em>val</em></td> </tr> <tr> <td class="md"></td> <td class="md">) </td> <td class="md" colspan="2"><code> [inline]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> <dl compact><dt><b>Examples: </b></dt><dd> <a class="el" href="ccrtptest_8cpp-example.html#a19">ccrtptest.cpp</a>, <a class="el" href="rtplisten_8cpp-example.html#a48">rtplisten.cpp</a>, and <a class="el" href="rtpsend_8cpp-example.html#a66">rtpsend.cpp</a>.</dl> </td> </tr> </table> <hr><h2>Friends And Related Function Documentation</h2> <a class="anchor" name="n0"></a><!-- doxytag: member="RTPApplication::ApplicationHandler" ref="n0" args="" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">friend class <a class="el" href="class_application_handler.html">ApplicationHandler</a><code> [friend]</code> </td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> </td> </tr> </table> <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> <hr size="1"><address style="align: right;"><small>Generated on Fri Dec 9 22:32:04 2005 for ccRTP by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4 </small></address> </body> </html>