Torque 3D 3.7
ContentsIndexHome
PreviousUpNext
Dispatcher Namespace

brief Namespace for the message dispatcher functions

Name 
Description 
The following table lists classes in this documentation. 
The following table lists functions in this documentation. 
The following table lists macros in this documentation. 
 
Name 
Description 
 
brief Internal class used by the dispatcher 
 
@brief Listener interface for objects that receive messages
@see ScriptMsgListener 
 
brief Internal class for tracking message queues 
 
Name 
Description 
 
brief Dispatch a message to a queue
param queue Queue to dispatch the message to param msg Message to dispatch param data Data for message return true for success, false for failure see dispatchMessageObject() 
 
brief Dispatch a message object to a queue
param queue Queue to dispatch the message to param msg Message to dispatch return true for success, false for failure see dispatchMessage() 
 
brief Internal function: obtain message queue. Dispatcher mutex must be locked.
param name Name of the queue return Message queue see lockDispatcherMutex(), unlockDispatcherMutex()
Internal Functions 
 
brief Check if a message queue is registered
param name The name of the message queue return true if the queue is registered, false otherwise see registerMessageQueue(), unregisterMessageQueue()
Queue Registration 
 
brief Internal function: Lock the dispatcher mutex. return true for success, false for failure see unlockDispatcherMutex() 
 
brief Register an anonymous message queue
return name of anonymous message queue for passing to other functions see isQueueRegistered(), unregisterMessageQueue() 
 
brief Register a listener with a queue to receive messages
param queue The name of the queue to register the listener with param listener The listener interface that receives messages return true for success, false otherwise see unregisterMessageListener()
Message Listener Registration 
 
brief Register a message queue
param name The name of the message queue to register see isQueueRegistered(), unregisterMessageQueue() 
 
brief Internal function: Unlock the dispatcher mutex. see lockDispatcherMutex() 
 
brief Unregister a listener with a queue
param queue The name of the queue to unregister the listener param listener The listener interface that was passed to registerMessageListener() see registerMessageListener() 
 
brief Unregister a message queue
param name The name of the message queue see registerMessageQueue(), isQueueRegistered() 
Name 
Description 
This is macro Dispatcher::gDispatchData. 
Copyright (c) 2015. All rights reserved.
What do you think about this topic? Send feedback!