<!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: MessageRelay 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_1MessageRelay.html">MessageRelay</a> </div> </div> <div class="contents"> <h1>MessageRelay Class Reference</h1><!-- doxytag: class="TelEngine::MessageRelay" --><!-- doxytag: inherits="TelEngine::MessageHandler" -->A message handler relay. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="yatengine_8h-source.html">yatengine.h</a>></code> <p> <div class="dynheader"> Inheritance diagram for MessageRelay:</div> <div class="dynsection"> <p><center><img src="classTelEngine_1_1MessageRelay.png" usemap="#MessageRelay_map" border="0" alt=""></center> <map name="MessageRelay_map"> <area href="classTelEngine_1_1MessageHandler.html" alt="MessageHandler" shape="rect" coords="0,112,108,136"> <area href="classTelEngine_1_1String.html" alt="String" shape="rect" coords="0,56,108,80"> <area href="classTelEngine_1_1GenObject.html" alt="GenObject" shape="rect" coords="0,0,108,24"> </map> </div> <p> <a href="classTelEngine_1_1MessageRelay-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_1MessageRelay.html#97d63a3dc135a71143376c097f36e887">MessageRelay</a> (const char *name, <a class="el" href="classTelEngine_1_1MessageReceiver.html">MessageReceiver</a> *receiver, int id, int priority=100)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1MessageRelay.html#349325c8b3b3ebebffca0d35e4613b31">received</a> (<a class="el" href="classTelEngine_1_1Message.html">Message</a> &msg)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1MessageRelay.html#e0c063cfb2479f614be43b9d2f92ba63">id</a> () const </td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> A message handler relay. <p> A message handler that allows to relay several messages to a single receiver <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="97d63a3dc135a71143376c097f36e887"></a><!-- doxytag: member="TelEngine::MessageRelay::MessageRelay" ref="97d63a3dc135a71143376c097f36e887" args="(const char *name, MessageReceiver *receiver, int id, int priority=100)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classTelEngine_1_1MessageRelay.html">MessageRelay</a> </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>name</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classTelEngine_1_1MessageReceiver.html">MessageReceiver</a> * </td> <td class="paramname"> <em>receiver</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"> <em>id</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"> <em>priority</em> = <code>100</code></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> Creates a new message relay. <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Name of the handled message - may be NULL </td></tr> <tr><td valign="top"></td><td valign="top"><em>receiver</em> </td><td>Receiver of th relayed messages </td></tr> <tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>Numeric identifier to pass to receiver </td></tr> <tr><td valign="top"></td><td valign="top"><em>priority</em> </td><td>Priority of the handler, 0 = top </td></tr> </table> </dl> </div> </div><p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="e0c063cfb2479f614be43b9d2f92ba63"></a><!-- doxytag: member="TelEngine::MessageRelay::id" ref="e0c063cfb2479f614be43b9d2f92ba63" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int id </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Get the ID of this message relay <dl class="return" compact><dt><b>Returns:</b></dt><dd>Numeric identifier passed to receiver </dd></dl> </div> </div><p> <a class="anchor" name="349325c8b3b3ebebffca0d35e4613b31"></a><!-- doxytag: member="TelEngine::MessageRelay::received" ref="349325c8b3b3ebebffca0d35e4613b31" args="(Message &msg)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual bool received </td> <td>(</td> <td class="paramtype"><a class="el" href="classTelEngine_1_1Message.html">Message</a> & </td> <td class="paramname"> <em>msg</em> </td> <td> ) </td> <td><code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> This method is called whenever the registered name matches the message. <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>The received message </td></tr> </table> </dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd>True to stop processing, false to try other handlers </dd></dl> <p>Implements <a class="el" href="classTelEngine_1_1MessageHandler.html#2f4d06dad5d96372c3f4d9c6a21cd1e6">MessageHandler</a>.</p> </div> </div><p> <hr>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="yatengine_8h-source.html">yatengine.h</a></ul> </div> <hr size="1"><address style="text-align: right;"><small>Generated on Sun Dec 7 21:36:12 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>