TorqueScript Reference
Functions
Message Queue (Dispatcher)

Functions

Boolean dispatchMessage (queueName, event, data)
 
Boolean dispatchMessageObject (queueName, message)
 
Boolean isQueueRegistered (queueName)
 
Boolean registerMessageListener (queueName, listener)
 
void registerMessageQueue (queueName)
 
void unregisterMessageListener (queueName, listener)
 
void unregisterMessageQueue (queueName)
 

Detailed Description

Function Documentation

◆ dispatchMessage()

Boolean dispatchMessage ( queueName  ,
event  ,
data   
)

Dispatches a message to given message queue

Parameters
queueNameThe queue to dispatch to
eventThe message you are passing
dataData
Returns
Returns true on success and false otherwise

◆ dispatchMessageObject()

Boolean dispatchMessageObject ( queueName  ,
message   
)

Dispatches a message object to the given queue

Parameters
queueNameThe name of the queue to dispatch object to
messageThe message object

◆ isQueueRegistered()

Boolean isQueueRegistered ( queueName  )

Checks whether message queue is registered

Parameters
queueNameThe name of the queue to check
Returns
Returns true if registered and false if not

◆ registerMessageListener()

Boolean registerMessageListener ( queueName  ,
listener   
)

Registers a message listener on a message queue

Parameters
queueNameThe name of the message queue
listenerThe name of the listener to register
Returns
Returns true on success, and false otherwise (probably not found)

◆ registerMessageQueue()

void registerMessageQueue ( queueName  )

Registers given message queue

Parameters
queueNameThe name of the message queue
Returns
No Return Value

◆ unregisterMessageListener()

void unregisterMessageListener ( queueName  ,
listener   
)

Unregisters the message listener on given message queue

Parameters
queueNameThe name of the message queue
listenerThe name of the listener to unregister
Returns
No Return Value

◆ unregisterMessageQueue()

void unregisterMessageQueue ( queueName  )

Unregisters given message queue

Parameters
Thename of the message queue
Returns
No Return Value