Torque 3D 3.8
ContentsIndexHome
PreviousUpNext
IMessageListener Members

The following tables list the members exposed by IMessageListener.

 
Name 
Description 
 
List of queues this listener is registered with. 
 
Name 
Description 
 
IMessageListener Methods 
 
@brief Callback for when the listener is added to a queue
The default implementation of onAddToQueue() and onRemoveFromQueue() provide tracking of the queues this listener is added to through the #mQueues member. Overrides of onAddToQueue() or onRemoveFromQueue() should ensure they call the parent implementation in any overrides.
@param queue The name of the queue that the listener added to @see onRemoveFromQueue() 
 
brief Callback for when message objects are received
param queue The name of the queue the message was dispatched to param msg The message object return false to prevent other listeners receiving this message, true otherwise see onMessageReceived() 
 
brief Callback for when messages are received
param queue The name of the queue the message was dispatched to param msg The type of message param data The data for the message return false to prevent other listeners receiving this message, true otherwise see onMessageObjectReceived() 
 
@brief Callback for when the listener is removed from a queue
The default implementation of onAddToQueue() and onRemoveFromQueue() provide tracking of the queues this listener is added to through the #mQueues member. Overrides of onAddToQueue() or onRemoveFromQueue() should ensure they call the parent implementation in any overrides.
@param queue The name of the queue the listener was removed from @see onAddToQueue() 
Copyright (c) 2015. All rights reserved.
What do you think about this topic? Send feedback!