Messaging

More...

Classes:

class

EventManager

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

class

Message

Base class for messages.

class

MessageForwarder

Forward messages from one queue to another.

class

ScriptMsgListener

Script accessible version of Dispatcher::IMessageListener. Often used in conjunction with EventManager.

Functions

bool

dispatchMessage(string queueName, string message, string data)

Dispatch a message to a queue.

bool

dispatchMessageObject(string queueName, string message)

Dispatch a message object to a queue.

bool

isQueueRegistered(string queueName)

Determines if a dispatcher queue exists.

bool

registerMessageListener(string queueName, string listenerName)

Registers an event message.

void

registerMessageQueue(string queueName)

Registeres a dispatcher queue.

void

unregisterMessageListener(string queueName, string listenerName)

Unregisters an event message.

void

unregisterMessageQueue(string queueName)

Unregisters a dispatcher queue.

Detailed Description

Functions

dispatchMessage(string queueName, string message, string data)

Dispatch a message to a queue.

Parameters:

queueName	Queue to dispatch the message to
message	Message to dispatch
data	Data for message

return:

True for success, false for failure

see:

dispatchMessageObject

dispatchMessageObject(string queueName, string message)

Dispatch a message object to a queue.

Parameters:

queueName	Queue to dispatch the message to
message	Message to dispatch

return:

true for success, false for failure

see:

dispatchMessage

isQueueRegistered(string queueName)

Determines if a dispatcher queue exists.

Parameters:

queueName

String containing the name of queue

registerMessageListener(string queueName, string listenerName)

Registers an event message.

Parameters:

queueName	String containing the name of queue to attach listener to
listener	Name of event messenger

registerMessageQueue(string queueName)

Registeres a dispatcher queue.

Parameters:

queueName

String containing the name of queue

unregisterMessageListener(string queueName, string listenerName)

Unregisters an event message.

Parameters:

queueName	String containing the name of queue
listener	Name of event messenger

unregisterMessageQueue(string queueName)

Unregisters a dispatcher queue.

Parameters:

queueName

String containing the name of queue