CGMessageQueue 1.0.1
\
CGMessageQueue

\CGMessageQueueQueueManager

The Queue Manager class handles interacting with the queue.

This is a singleton object.

Summary

Methods
Properties
Constants
get_instance()
get_meta()
send()
get_first_queue()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

get_instance()

get_instance() : \CGMessageQueue\QueueManager

Get a reference to the only instance of this object.

Returns

\CGMessageQueue\QueueManager

get_meta()

get_meta(string  $queue)

Get the metadata for a message from the specified queue.

This method does not pop the message out of the queue.

Parameters

string $queue

The queue name

send()

send(\CGMessageQueue\MessageBase  $msg)

Place a message on the queue for asynchronous processing.

Parameters

\CGMessageQueue\MessageBase $msg

The message object.

get_first_queue()

get_first_queue() : \CGMessageQueue\string.

Get the name of the queue associated with the first message in the database.

If there are no messages in the database an empty string will be returned.

Returns

\CGMessageQueue\string.