Dispatcher

Engine/source/util/messaging/dispatcher.cpp

Namespace for the message dispatcher functions.

More...

Classes:

class

Dispatcher::IMessageListener

Listener interface for objects that receive messages.

class

Dispatcher::MessageQueue

Internal class for tracking message queues.

Message Queue Management

bool

isQueueRegistered(const char * name)

Check if a message queue is registered.

void

registerMessageQueue(const char * name)

const char *

registerAnonMessageQueue()

void

unregisterMessageQueue(const char * name)

Unregister a message queue.

bool

registerMessageListener(const char * queue, IMessageListener * listener)

void

unregisterMessageListener(const char * queue, IMessageListener * listener)

Unregister a listener with a queue.

Message Dispatcher

bool

dispatchMessage(const char * queue, const char * msg, const char * data)

Dispatch a message to a queue.

bool

dispatchMessageObject(const char * queue, Message * msg)

Dispatch a message object to a queue.

Internal Functions

MessageQueue *

getMessageQueue(const char * name)

Internal function: obtain message queue.

bool

lockDispatcherMutex()

Internal function: Lock the dispatcher mutex.

void

unlockDispatcherMutex()

Internal function: Unlock the dispatcher mutex.

Public Functions

_DispatchData &

_dispatcherGetGDispatchData()

Detailed Description

Namespace for the message dispatcher functions.

Message Queue Management

isQueueRegistered(const char * name)

Check if a message queue is registered.

Parameters:

name	The name of the message queue

return:

true if the queue is registered, false otherwise

see:

registerMessageQueue(), unregisterMessageQueue()

registerMessageQueue(const char * name)

Parameters:

name	The name of the message queue to register

see:

isQueueRegistered(), unregisterMessageQueue()

registerAnonMessageQueue()

return:

name of anonymous message queue for passing to other functions

see:

isQueueRegistered(), unregisterMessageQueue()

unregisterMessageQueue(const char * name)

Unregister a message queue.

Parameters:

name	The name of the message queue

see:

registerMessageQueue(), isQueueRegistered()

registerMessageListener(const char * queue, IMessageListener * listener)

Parameters:

queue	The name of the queue to register the listener with
listener	The listener interface that receives messages

return:

true for success, false otherwise

see:

unregisterMessageListener()

unregisterMessageListener(const char * queue, IMessageListener * listener)

Unregister a listener with a queue.

Parameters:

queue	The name of the queue to unregister the listener
listener	The listener interface that was passed to registerMessageListener()

see:

registerMessageListener()

Message Dispatcher

dispatchMessage(const char * queue, const char * msg, const char * data)

Dispatch a message to a queue.

Parameters:

queue	Queue to dispatch the message to
msg	Message to dispatch
data	Data for message

return:

true for success, false for failure

see:

dispatchMessageObject()

dispatchMessageObject(const char * queue, Message * msg)

Dispatch a message object to a queue.

Parameters:

queue	Queue to dispatch the message to
msg	Message to dispatch

return:

true for success, false for failure

see:

dispatchMessage()

Internal Functions

getMessageQueue(const char * name)

Internal function: obtain message queue.

Dispatcher mutex must be locked.

Parameters:

name	Name of the queue

return:

Message queue

see:

lockDispatcherMutex(), unlockDispatcherMutex()

lockDispatcherMutex()

Internal function: Lock the dispatcher mutex.

return:

true for success, false for failure

see:

unlockDispatcherMutex()

unlockDispatcherMutex()

Internal function: Unlock the dispatcher mutex.

see:

lockDispatcherMutex()

Public Functions

_dispatcherGetGDispatchData()