Interface for common queue operations
| category | Zend |
|---|---|
| package | Zend_Queue |
| subpackage | Adapter |
| copyright | Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com) |
| license | New BSD License |
__construct(array|\Zend_Config $options, \Zend_Queue $queue = null) : void
array\Zend_Config
\Zend_Queue
count(\Zend_Queue|null $queue = null) : integer
\Zend_Queuenull
integercreate(string $name, integer $timeout = null) : boolean
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.
stringQueue name
integerDefault visibility timeout
booleandelete(string $name) : boolean
Return false if the queue is not found, true if the queue exists.
stringQueue name
booleandeleteMessage(\Zend_Queue_Message $message) : boolean
Return true if the message is deleted, false if the deletion is unsuccessful.
\Zend_Queue_Message
booleangetCapabilities() : array
$array['function name'] = true or false true is supported, false is not supported.
arraygetOptions() : array
arraygetQueue() : \Zend_Queue
\Zend_QueuegetQueues() : array
Not all adapters support getQueues(); use isSupported('getQueues') to determine if the adapter supports this feature.
arrayisExists(string $name) : boolean
Use isSupported('isExists') to determine if an adapter can test for queue existance.
stringQueue name
booleanisSupported(string $name) : boolean
stringFunction name
booleanreceive(integer|null $maxMessages= null, integer|null $timeout= null, \Zend_Queue|null $queue= null) : \Zend_Queue_Message_Iterator
integernullMaximum number of messages to return
integernullVisibility timeout for these messages
\Zend_Queuenull
\Zend_Queue_Message_Iteratorsend(mixed $message, \Zend_Queue|null $queue = null) : \Zend_Queue_Message
mixedMessage to send to the active queue
\Zend_Queuenull
\Zend_Queue_MessagesetQueue(\Zend_Queue $queue) : \Zend_Queue_Adapter_AdapterInterface
\Zend_Queue
\Zend_Queue_Adapter_AdapterInterface