<!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: MessageDispatcher 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_1MessageDispatcher.html">MessageDispatcher</a>
</div>
</div>
<div class="contents">
<h1>MessageDispatcher Class Reference</h1><!-- doxytag: class="TelEngine::MessageDispatcher" --><!-- doxytag: inherits="TelEngine::GenObject" -->A message dispatching hub.
<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 MessageDispatcher:</div>
<div class="dynsection">
<p><center><img src="classTelEngine_1_1MessageDispatcher.png" usemap="#MessageDispatcher_map" border="0" alt=""></center>
<map name="MessageDispatcher_map">
<area href="classTelEngine_1_1GenObject.html" alt="GenObject" shape="rect" coords="0,0,124,24">
</map>
</div>
<p>
<a href="classTelEngine_1_1MessageDispatcher-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_1MessageDispatcher.html#ac6d9035790c0445fa5b482f88dc9c02">MessageDispatcher</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1MessageDispatcher.html#022fedc8ebf9e431b861f85f6450ea6d">~MessageDispatcher</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_1MessageDispatcher.html#4053c4b3d4b4d4ad7066b9322ca0ade7">install</a> (<a class="el" href="classTelEngine_1_1MessageHandler.html">MessageHandler</a> *handler)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1MessageDispatcher.html#9532f9ba56758e828f49aca3c3a0f43d">uninstall</a> (<a class="el" href="classTelEngine_1_1MessageHandler.html">MessageHandler</a> *handler)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1MessageDispatcher.html#b409b31bce56e26c2f80376b5509b3e0">dispatch</a> (<a class="el" href="classTelEngine_1_1Message.html">Message</a> &msg)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1MessageDispatcher.html#28bd61c3c48f431384bda74bc18e6f7b">enqueue</a> (<a class="el" href="classTelEngine_1_1Message.html">Message</a> *msg)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1MessageDispatcher.html#851b6644e3e336c07f8e6fe77234b97f">dequeue</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_1MessageDispatcher.html#937eba31ec984f89eae2ebb411c6e419">dequeueOne</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_1MessageDispatcher.html#1daac6d09975ec8b1ee34fd6cb87033e">warnTime</a> (u_int64_t usec)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1MessageDispatcher.html#c8bb3912a3ce86b15842e79d0b421204">clear</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_1MessageDispatcher.html#da7d3d221ee0d87bb9f927f58fc61985">messageCount</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_1MessageDispatcher.html#4da8395b9ce6b8554d26dc8905e2e69b">handlerCount</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_1MessageDispatcher.html#26b1251594cbd70dc5774518ec7b42ba">setHook</a> (<a class="el" href="classTelEngine_1_1MessagePostHook.html">MessagePostHook</a> *hook, bool remove=false)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A message dispatching hub.
<p>
The dispatcher class is a hub that holds a list of handlers to be called for the messages that pass trough the hub. It can also handle a queue of messages that are typically dispatched by a separate thread. <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="ac6d9035790c0445fa5b482f88dc9c02"></a><!-- doxytag: member="TelEngine::MessageDispatcher::MessageDispatcher" ref="ac6d9035790c0445fa5b482f88dc9c02" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1MessageDispatcher.html">MessageDispatcher</a> </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Creates a new message dispatcher.
</div>
</div><p>
<a class="anchor" name="022fedc8ebf9e431b861f85f6450ea6d"></a><!-- doxytag: member="TelEngine::MessageDispatcher::~MessageDispatcher" ref="022fedc8ebf9e431b861f85f6450ea6d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">~<a class="el" href="classTelEngine_1_1MessageDispatcher.html">MessageDispatcher</a> </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destroys the dispatcher and the installed handlers.
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="c8bb3912a3ce86b15842e79d0b421204"></a><!-- doxytag: member="TelEngine::MessageDispatcher::clear" ref="c8bb3912a3ce86b15842e79d0b421204" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void clear </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Clear all the message handlers and post-dispatch hooks
</div>
</div><p>
<a class="anchor" name="851b6644e3e336c07f8e6fe77234b97f"></a><!-- doxytag: member="TelEngine::MessageDispatcher::dequeue" ref="851b6644e3e336c07f8e6fe77234b97f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void dequeue </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Dispatch all messages from the waiting queue
</div>
</div><p>
<a class="anchor" name="937eba31ec984f89eae2ebb411c6e419"></a><!-- doxytag: member="TelEngine::MessageDispatcher::dequeueOne" ref="937eba31ec984f89eae2ebb411c6e419" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool dequeueOne </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Dispatch one message from the waiting queue <dl class="return" compact><dt><b>Returns:</b></dt><dd>True if success, false if the queue is empty </dd></dl>
</div>
</div><p>
<a class="anchor" name="b409b31bce56e26c2f80376b5509b3e0"></a><!-- doxytag: member="TelEngine::MessageDispatcher::dispatch" ref="b409b31bce56e26c2f80376b5509b3e0" args="(Message &msg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool dispatch </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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Synchronously dispatch a message to the installed handlers <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 message to dispatch </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if one handler accepted it, false if all ignored </dd></dl>
</div>
</div><p>
<a class="anchor" name="28bd61c3c48f431384bda74bc18e6f7b"></a><!-- doxytag: member="TelEngine::MessageDispatcher::enqueue" ref="28bd61c3c48f431384bda74bc18e6f7b" args="(Message *msg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool enqueue </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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Put a message in the waiting queue for asynchronous dispatching <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 message to enqueue, will be destroyed after dispatching </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if successfully queued, false otherwise </dd></dl>
</div>
</div><p>
<a class="anchor" name="4da8395b9ce6b8554d26dc8905e2e69b"></a><!-- doxytag: member="TelEngine::MessageDispatcher::handlerCount" ref="4da8395b9ce6b8554d26dc8905e2e69b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int handlerCount </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the number of handlers in this dispatcher <dl class="return" compact><dt><b>Returns:</b></dt><dd>Count of handlers </dd></dl>
</div>
</div><p>
<a class="anchor" name="4053c4b3d4b4d4ad7066b9322ca0ade7"></a><!-- doxytag: member="TelEngine::MessageDispatcher::install" ref="4053c4b3d4b4d4ad7066b9322ca0ade7" args="(MessageHandler *handler)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool install </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1MessageHandler.html">MessageHandler</a> * </td>
<td class="paramname"> <em>handler</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Installs a handler in the dispatcher. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>handler</em> </td><td>A pointer to the handler to install </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True on success, false on failure </dd></dl>
</div>
</div><p>
<a class="anchor" name="da7d3d221ee0d87bb9f927f58fc61985"></a><!-- doxytag: member="TelEngine::MessageDispatcher::messageCount" ref="da7d3d221ee0d87bb9f927f58fc61985" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int messageCount </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the number of messages waiting in the queue <dl class="return" compact><dt><b>Returns:</b></dt><dd>Count of messages in the queue </dd></dl>
</div>
</div><p>
<a class="anchor" name="26b1251594cbd70dc5774518ec7b42ba"></a><!-- doxytag: member="TelEngine::MessageDispatcher::setHook" ref="26b1251594cbd70dc5774518ec7b42ba" args="(MessagePostHook *hook, bool remove=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setHook </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1MessagePostHook.html">MessagePostHook</a> * </td>
<td class="paramname"> <em>hook</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>remove</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>
Install or remove a hook to catch messages after being dispatched <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>hook</em> </td><td>Pointer to a post-dispatching message hook </td></tr>
<tr><td valign="top"></td><td valign="top"><em>remove</em> </td><td>Set to True to remove the hook instead of adding </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="9532f9ba56758e828f49aca3c3a0f43d"></a><!-- doxytag: member="TelEngine::MessageDispatcher::uninstall" ref="9532f9ba56758e828f49aca3c3a0f43d" args="(MessageHandler *handler)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool uninstall </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1MessageHandler.html">MessageHandler</a> * </td>
<td class="paramname"> <em>handler</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Uninstalls a handler from the dispatcher. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>handler</em> </td><td>A pointer to the handler to uninstall </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True on success, false on failure </dd></dl>
</div>
</div><p>
<a class="anchor" name="1daac6d09975ec8b1ee34fd6cb87033e"></a><!-- doxytag: member="TelEngine::MessageDispatcher::warnTime" ref="1daac6d09975ec8b1ee34fd6cb87033e" args="(u_int64_t usec)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void warnTime </td>
<td>(</td>
<td class="paramtype">u_int64_t </td>
<td class="paramname"> <em>usec</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set a limit to generate warning when a message took too long to dispatch <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>usec</em> </td><td>Warning time limit in microseconds, zero to disable </td></tr>
</table>
</dl>
</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>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
eeacaa4eb55fa544d622989e42fc27b1
>
files
>
321
