Message System

Detailed Description

Most of the message system docs are currently just stubs and will be fleshed out soon.

Namespaces

namespace Dispatcher

Namespace for the message dispatcher functions.

Classes

class Dispatcher::IMessageListener

Listener interface for objects that receive messages. More...

struct Dispatcher::MessageQueue

Internal class for tracking message queues. More...

class EventManager

The EventManager class is a wrapper for the standard messaging system. More...

class Message

Base class for messages. More...

class MessageForwarder

Forward messages from one queue to another. More...

class ScriptMsgListener

Script accessible version of Dispatcher::IMessageListener. More...

Message Queue Management

bool Dispatcher::isQueueRegistered (const char *name)

Check if a message queue is registered.

void Dispatcher::registerMessageQueue (const char *name)

Register a message queue.

const char * Dispatcher::registerAnonMessageQueue ()

Register an anonymous message queue.

void Dispatcher::unregisterMessageQueue (const char *name)

Unregister a message queue.

bool Dispatcher::registerMessageListener (const char *queue, IMessageListener *listener)

Register a listener with a queue to receive messages.

void Dispatcher::unregisterMessageListener (const char *queue, IMessageListener *listener)

Unregister a listener with a queue.

Message Dispatcher

bool Dispatcher::dispatchMessage (const char *queue, const char *msg, const char *data)

Dispatch a message to a queue.

bool Dispatcher::dispatchMessageObject (const char *queue, Message *msg)

Dispatch a message object to a queue.

Internal Functions

bool Dispatcher::lockDispatcherMutex ()

Internal function: Lock the dispatcher mutex.

void Dispatcher::unlockDispatcherMutex ()

Internal function: Unlock the dispatcher mutex.

MessageQueue * Dispatcher::getMessageQueue (const char *name)

Internal function: obtain message queue.

Function Documentation

bool Dispatcher::isQueueRegistered ( const char * name )

Check if a message queue is registered.

Parameters:

name

The name of the message queue

Returns:: true if the queue is registered, false otherwise

See also:: registerMessageQueue(), unregisterMessageQueue()

void Dispatcher::registerMessageQueue ( const char * name )

Register a message queue.

Parameters:

name

The name of the message queue to register

See also:: isQueueRegistered(), unregisterMessageQueue()

const char* Dispatcher::registerAnonMessageQueue ( )

Register an anonymous message queue.

Returns:: name of anonymous message queue for passing to other functions

See also:: isQueueRegistered(), unregisterMessageQueue()

void Dispatcher::unregisterMessageQueue ( const char * name )

Unregister a message queue.

Parameters:

name

The name of the message queue

See also:: registerMessageQueue(), isQueueRegistered()

bool Dispatcher::registerMessageListener	(	const char *	queue,
		IMessageListener *	listener
	)

Register a listener with a queue to receive messages.

Parameters:

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

Returns:: true for success, false otherwise

See also:: unregisterMessageListener()

void Dispatcher::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 also:: registerMessageListener()

bool 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

Returns:: true for success, false for failure

See also:: dispatchMessageObject()

bool Dispatcher::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

Returns:: true for success, false for failure

See also:: dispatchMessage()

bool Dispatcher::lockDispatcherMutex ( )

Internal function: Lock the dispatcher mutex.

Returns:: true for success, false for failure

See also:: unlockDispatcherMutex()

void Dispatcher::unlockDispatcherMutex ( )

Internal function: Unlock the dispatcher mutex.

See also:: lockDispatcherMutex()

MessageQueue* Dispatcher::getMessageQueue ( const char * name )

Internal function: obtain message queue.

Dispatcher mutex must be locked.

Parameters:

name

Name of the queue

Returns:: Message queue

See also:: lockDispatcherMutex(), unlockDispatcherMutex()