1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
|
<HTML>
<HEAD>
<TITLE>class MessageDispatcher</TITLE>
<META NAME="Generator" CONTENT="KDOC ">
</HEAD>
<BODY bgcolor="#ffffff" text="#000000" link="#0000ff" vlink="#000099" alink= "#ffffff">
<TABLE WIDTH="100%" BORDER="0">
<TR>
<TD>
<TABLE BORDER="0">
<TR><TD valign="top" align="left" cellspacing="10">
<h1>class MessageDispatcher</h1>
</TD>
<TD valign="top" align="right" colspan="1">A message dispatching hub. <small><A HREF="#longdesc">More...</A></small></TD></TR>
</TABLE>
<HR>
<TABLE BORDER="0">
<TR><TH>Full name</TH><TD><code><A HREF="TelEngine.html">TelEngine</A>::MessageDispatcher</code></TD></TR>
<TR><TH>Definition</TH><TD><code>#include <<A HREF="yatengine_h.html">yatengine.h</A>></code></TD></TR>
<TR><TH>Inherits</TH><TD><A HREF="TelEngine__GenObject.html">TelEngine::GenObject</A> <small>[public ]</small>, <A HREF="TelEngine__Mutex.html">TelEngine::Mutex</A> <small>[public ]</small></TD></TR>
<TR><TH><A HREF="full-list-TelEngine__MessageDispatcher.html">List of all Methods</A></TH></TR>
</TABLE>
</TD>
<TD align="right"><TABLE BORDER="0"><TR><TD><small><A HREF="index-long.html">Annotated List</A></small></TD></TR>
<TR><TD><small><A HREF="header-list.html">Files</A></small></TD></TR>
<TR><TD><small><A HREF="all-globals.html">Globals</A></small></TD></TR>
<TR><TD><small><A HREF="hier.html">Hierarchy</A></small></TD></TR>
<TR><TD><small><A HREF="index.html">Index</A></small></TD></TR>
</TABLE></TD></TR></TABLE>
<h4>Public Methods</h4><ul><LI> <b><A HREF="#ref1">MessageDispatcher</A></b> ()
</LI>
<LI> <b><A HREF="#ref2">~MessageDispatcher</A></b> ()
</LI>
<LI>bool <b><A HREF="#ref3">install</A></b> (MessageHandler* handler)
</LI>
<LI>bool <b><A HREF="#ref4">uninstall</A></b> (MessageHandler* handler)
</LI>
<LI>bool <b><A HREF="#ref5">dispatch</A></b> (Message& msg)
</LI>
<LI>bool <b><A HREF="#ref6">enqueue</A></b> (Message* msg)
</LI>
<LI>void <b><A HREF="#ref7">dequeue</A></b> ()
</LI>
<LI>bool <b><A HREF="#ref8">dequeueOne</A></b> ()
</LI>
<LI>inline void <b><A HREF="#ref9">warnTime</A></b> (<A HREF="#u_int64_t">u_int64_t</A> usec)
</LI>
<LI>inline void <b><A HREF="#ref10">clear</A></b> ()
</LI>
<LI>unsigned int <b><A HREF="#ref11">messageCount</A></b> ()
</LI>
<LI>unsigned int <b><A HREF="#ref12">handlerCount</A></b> ()
</LI>
<LI>void <b><A HREF="#ref13">setHook</A></b> (MessagePostHook* hook, bool remove = false)
</LI>
</ul><HR><H2><A NAME="longdesc">Detailed Description</A></H2><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.
</p>
<A NAME="MessageDispatcher"></A><A NAME="ref1"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>MessageDispatcher</strong> ()
<br></td><td align="right"><h3><strong>MessageDispatcher</strong></h3></td></tr></table><p></p><p>
Creates a new message dispatcher.
</p>
<A NAME="~MessageDispatcher"></A><A NAME="ref2"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>~MessageDispatcher</strong> ()
<br></td><td align="right"><h3><strong>~MessageDispatcher</strong></h3></td></tr></table><p></p><p>
Destroys the dispatcher and the installed handlers.
</p>
<A NAME="install"></A><A NAME="ref3"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>install</strong> (MessageHandler* handler)
<br></td><td align="right"><h3><strong>install</strong></h3></td></tr></table><p></p><p>
Installs a handler in the dispatcher.
The handlers are installed in ascending order of their priorities.
There is NO GUARANTEE on the order of handlers with equal priorities
although for avoiding uncertainity such handlers are sorted by address.
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>handler</i></TD><TD align="left" valign="top">A pointer to the handler to install
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True on success, false on failure
</p>
<A NAME="uninstall"></A><A NAME="ref4"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>uninstall</strong> (MessageHandler* handler)
<br></td><td align="right"><h3><strong>uninstall</strong></h3></td></tr></table><p></p><p>
Uninstalls a handler from the dispatcher.
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>handler</i></TD><TD align="left" valign="top">A pointer to the handler to uninstall
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True on success, false on failure
</p>
<A NAME="dispatch"></A><A NAME="ref5"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>dispatch</strong> (Message& msg)
<br></td><td align="right"><h3><strong>dispatch</strong></h3></td></tr></table><p></p><p>
Synchronously dispatch a message to the installed handlers.
Handlers matching the message name and filter parameter are called in
their installed order (based on priority) until one returns true.
Note that in some cases when a handler is removed from the list
other handlers with equal priority may be called twice.
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>msg</i></TD><TD align="left" valign="top">The message to dispatch
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if one handler accepted it, false if all ignored
</p>
<A NAME="enqueue"></A><A NAME="ref6"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>enqueue</strong> (Message* msg)
<br></td><td align="right"><h3><strong>enqueue</strong></h3></td></tr></table><p></p><p>
Put a message in the waiting queue for asynchronous dispatching
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>msg</i></TD><TD align="left" valign="top">The message to enqueue, will be destroyed after dispatching
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if successfully queued, false otherwise
</p>
<A NAME="dequeue"></A><A NAME="ref7"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>dequeue</strong> ()
<br></td><td align="right"><h3><strong>dequeue</strong></h3></td></tr></table><p></p><p>
Dispatch all messages from the waiting queue
</p>
<A NAME="dequeueOne"></A><A NAME="ref8"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>dequeueOne</strong> ()
<br></td><td align="right"><h3><strong>dequeueOne</strong></h3></td></tr></table><p></p><p>
Dispatch one message from the waiting queue
</p>
<p><b>Returns</b>: True if success, false if the queue is empty
</p>
<A NAME="warnTime"></A><A NAME="ref9"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline void <strong>warnTime</strong> (<A HREF="#u_int64_t">u_int64_t</A> usec)
<br></td><td align="right"><h3><strong>warnTime</strong></h3></td></tr></table><p></p><p>
Set a limit to generate warning when a message took too long to dispatch
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>usec</i></TD><TD align="left" valign="top">Warning time limit in microseconds, zero to disable
</TD></TR>
</TABLE></P>
<A NAME="clear"></A><A NAME="ref10"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline void <strong>clear</strong> ()
<br></td><td align="right"><h3><strong>clear</strong></h3></td></tr></table><p></p><p>
Clear all the message handlers and post-dispatch hooks
</p>
<A NAME="messageCount"></A><A NAME="ref11"></A><table width="100%"><tr bgcolor="#eeeeee"><td>unsigned int <strong>messageCount</strong> ()
<br></td><td align="right"><h3><strong>messageCount</strong></h3></td></tr></table><p></p><p>
Get the number of messages waiting in the queue
</p>
<p><b>Returns</b>: Count of messages in the queue
</p>
<A NAME="handlerCount"></A><A NAME="ref12"></A><table width="100%"><tr bgcolor="#eeeeee"><td>unsigned int <strong>handlerCount</strong> ()
<br></td><td align="right"><h3><strong>handlerCount</strong></h3></td></tr></table><p></p><p>
Get the number of handlers in this dispatcher
</p>
<p><b>Returns</b>: Count of handlers
</p>
<A NAME="setHook"></A><A NAME="ref13"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>setHook</strong> (MessagePostHook* hook, bool remove = false)
<br></td><td align="right"><h3><strong>setHook</strong></h3></td></tr></table><p></p><p>
Install or remove a hook to catch messages after being dispatched
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>hook</i></TD><TD align="left" valign="top">Pointer to a post-dispatching message hook
</TD></TR>
<TR><TD align="left" valign="top"><i>remove</i></TD><TD align="left" valign="top">Set to True to remove the hook instead of adding
</TD></TR>
</TABLE></P>
<HR>
<table>
<tr><td><small>Generated by: paulc on bussard on Mon Mar 8 12:18:15 2010, using kdoc 2.0a54.</small></td></tr>
</table>
</BODY>
</HTML>
|
