Zend_Queue_Adapter_AdapterInterface Interface Reference

Public Member Functions
	__construct ($options, Zend_Queue $queue=null)
	Constructor.
	getQueue ()
	Retrieve queue instance.
	setQueue (Zend_Queue $queue)
	Set queue instnace.
	isExists ($name)
	Does a queue already exist?
	create ($name, $timeout=null)
	Create a new queue.
	delete ($name)
	Delete a queue and all of its messages.
	getQueues ()
	Get an array of all available queues.
	count (Zend_Queue $queue=null)
	Return the approximate number of messages in the queue.
	send ($message, Zend_Queue $queue=null)
	Send a message to the queue.
	receive ($maxMessages=null, $timeout=null, Zend_Queue $queue=null)
	Get messages in the queue.
	deleteMessage (Zend_Queue_Message $message)
	Delete a message from the queue.
	getOptions ()
	Returns the configuration options in this adapter.
	getCapabilities ()
	Return a list of queue capabilities functions.
	isSupported ($name)
	Indicates if a function is supported or not.

Constructor & Destructor Documentation

__construct	(		$options,
		Zend_Queue	$queue = null
	)

Constructor.

Parameters

array | Zend_Config	$options
Zend_Queue	$queue

Returns

void

Implemented in Zend_Queue_Adapter_AdapterAbstract, Zend_Queue_Adapter_Db, Zend_Queue_Adapter_Memcacheq, Zend_Queue_Adapter_Activemq, Zend_Queue_Adapter_Array, Zend_Queue_Adapter_PlatformJobQueue, and Zend_Queue_Adapter_Null.

Member Function Documentation

count

(

Zend_Queue

$queue = null

)

Return the approximate number of messages in the queue.

Parameters

Zend_Queue | null

$queue

Returns

integer

Implemented in Zend_Queue_Adapter_Activemq, Zend_Queue_Adapter_Db, Zend_Queue_Adapter_Memcacheq, Zend_Queue_Adapter_PlatformJobQueue, Zend_Queue_Adapter_Array, and Zend_Queue_Adapter_Null.

create	(		$name,
			$timeout = null
	)

Create a new queue.

Visibility timeout is how long a message is left in the queue "invisible" to other readers. If the message is acknowleged (deleted) before the timeout, then the message is deleted. However, if the timeout expires then the message will be made available to other queue readers.

Parameters

string	$name	Queue name
integer	$timeout	Default visibility timeout

Returns

boolean

Implemented in Zend_Queue_Adapter_Db, Zend_Queue_Adapter_Memcacheq, Zend_Queue_Adapter_Activemq, Zend_Queue_Adapter_PlatformJobQueue, Zend_Queue_Adapter_Array, and Zend_Queue_Adapter_Null.

delete

(

$name

)

Delete a queue and all of its messages.

Return false if the queue is not found, true if the queue exists.

Parameters

string

$name

Queue name

Returns

boolean

Implemented in Zend_Queue_Adapter_Db, Zend_Queue_Adapter_Memcacheq, Zend_Queue_Adapter_Activemq, Zend_Queue_Adapter_PlatformJobQueue, Zend_Queue_Adapter_Array, and Zend_Queue_Adapter_Null.

deleteMessage

(

Zend_Queue_Message

$message

)

Delete a message from the queue.

Return true if the message is deleted, false if the deletion is unsuccessful.

Parameters

Zend_Queue_Message

$message

Returns

boolean

Implemented in Zend_Queue_Adapter_Db, Zend_Queue_Adapter_Memcacheq, Zend_Queue_Adapter_Array, Zend_Queue_Adapter_PlatformJobQueue, Zend_Queue_Adapter_Activemq, and Zend_Queue_Adapter_Null.

getCapabilities

(

)

Return a list of queue capabilities functions.

$array['function name'] = true or false true is supported, false is not supported.

Returns

array

Implemented in Zend_Queue_Adapter_Db, Zend_Queue_Adapter_Memcacheq, Zend_Queue_Adapter_Activemq, Zend_Queue_Adapter_Array, Zend_Queue_Adapter_PlatformJobQueue, and Zend_Queue_Adapter_Null.

getOptions

(

)

Returns the configuration options in this adapter.

Returns

array

Implemented in Zend_Queue_Adapter_AdapterAbstract.

getQueue

(

)

Retrieve queue instance.

Returns

Zend_Queue

Implemented in Zend_Queue_Adapter_AdapterAbstract.

getQueues

(

)

Get an array of all available queues.

Not all adapters support getQueues(); use isSupported('getQueues') to determine if the adapter supports this feature.

Returns

array

Implemented in Zend_Queue_Adapter_Db, Zend_Queue_Adapter_Memcacheq, Zend_Queue_Adapter_Activemq, Zend_Queue_Adapter_PlatformJobQueue, Zend_Queue_Adapter_Array, and Zend_Queue_Adapter_Null.

isExists

(

$name

)

Does a queue already exist?

Use isSupported('isExists') to determine if an adapter can test for queue existance.

Parameters

string

$name

Queue name

Returns

boolean

Implemented in Zend_Queue_Adapter_Activemq, Zend_Queue_Adapter_Db, Zend_Queue_Adapter_Memcacheq, Zend_Queue_Adapter_PlatformJobQueue, Zend_Queue_Adapter_Array, and Zend_Queue_Adapter_Null.

isSupported

(

$name

)

Indicates if a function is supported or not.

Parameters

string

$name

Function name

Returns

boolean

Implemented in Zend_Queue_Adapter_AdapterAbstract.

receive	(		$maxMessages = null,
			$timeout = null,
		Zend_Queue	$queue = null
	)

Get messages in the queue.

Parameters

integer | null	$maxMessages	Maximum number of messages to return
integer | null	$timeout	Visibility timeout for these messages
Zend_Queue | null	$queue

Returns

Zend_Queue_Message_Iterator

Implemented in Zend_Queue_Adapter_Db, Zend_Queue_Adapter_Memcacheq, Zend_Queue_Adapter_PlatformJobQueue, Zend_Queue_Adapter_Activemq, Zend_Queue_Adapter_Array, and Zend_Queue_Adapter_Null.

send	(		$message,
		Zend_Queue	$queue = null
	)

Send a message to the queue.

Parameters

mixed	$message	Message to send to the active queue
Zend_Queue | null	$queue

Returns

Zend_Queue_Message

Implemented in Zend_Queue_Adapter_Db, Zend_Queue_Adapter_Activemq, Zend_Queue_Adapter_Memcacheq, Zend_Queue_Adapter_PlatformJobQueue, Zend_Queue_Adapter_Array, and Zend_Queue_Adapter_Null.

setQueue

(

Zend_Queue

$queue

)

Set queue instnace.

Parameters

Zend_Queue

$queue

Returns

Zend_Queue_Adapter_AdapterInterface

Implemented in Zend_Queue_Adapter_AdapterAbstract.