\CGMessageQueueMessageBase

__construct()

__construct() 

Constructor

get_name()

get_name() : string

Get the name of this message object.

By default it returns the class name.

Returns

set_name()

set_name(string  $str) 

Set the name of this message object.

Parameters

get_queue()

get_queue() : \CGMessageQueue\string.

Get the name of the queue that this message object is to be placed in.

There is no default value for the queue name, but one is required before sending the message.

Returns

set_queue()

set_queue(string  $str) 

Set the queue name.

Parameters

get_module()

get_module() : \CGMessageQueue\strung

Get the name of the module that is sending this message.

There is no default value for the module name, however one must be set before sending the message.

Returns

set_module()

set_module(string  $str) 

Set the module name for this message.

Parameters

get_expiry()

get_expiry() 

Get the expiry time (in minutes) for this message.

return int

set_expiry()

set_expiry(integer|null  $val) 

Set the expiry time (in minutes) for this message.

Parameters

is_valid()

is_valid() : boolean

Test if this message is minimally valid, and can be sent.

Returns

handle()

handle() : void

An abstract method to handle this message once it is popped off of the queue.

All processing should be done from within this method.

This method is called by the asynchronous process handler.

send()

send() : void

Place this message intot he queue for asynchrnous processing.

This method throws an exception if the message is not valid.