Zend Platform JobQueue adapter
category | Zend |
---|---|
package | Zend_Queue |
subpackage | Adapter |
copyright | Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com) |
license | New BSD License |
inherited_from | \Zend_Queue_Adapter_AdapterAbstract |
__construct(array|\Zend_Config $options, \Zend_Queue|null $queue = null
) : void
$options is an array of key/value pairs or an instance of Zend_Config containing configuration options. These options are common to most adapters:
See the Zend_Queue Adapter Notes documentation for example configurations.
Some options are used on a case-by-case basis by adapters:
access_key => (string) Amazon AWS Access Key secret_key => (string) Amazon AWS Secret Key dbname => (string) The name of the database to user username => (string) Connect to the database as this username. password => (string) Password associated with the username. host => (string) What host to connect to, defaults to localhost port => (string) The port of the database
inherited_from | \Zend_Queue_Adapter_AdapterAbstract::__construct() |
---|
array
\Zend_Config
\Zend_Queue
null
__construct(array|\Zend_Config $options, \Zend_Queue $queue = null
) : void
$options is an array of key/value pairs or an instance of Zend_Config containing configuration options. These options are common to most adapters:
See the Zend_Queue Adapter Notes documentation for example configurations.
Some options are used on a case-by-case basis by adapters:
access_key => (string) Amazon AWS Access Key secret_key => (string) Amazon AWS Secret Key dbname => (string) The name of the database to user username => (string) Connect to the database as this username. password => (string) Password associated with the username. host => (string) What host to connect to, defaults to localhost port => (string) The port of the database
inherited_from | \Zend_Queue_Adapter_AdapterInterface::__construct() |
---|
\Zend_Queue_Exception |
---|
__sleep() : array
array
__wakeup() : void
count(\Zend_Queue|null $queue = null
) : integer
\Zend_Queue
null
integer
create(string $name, integer $timeout = null
) : void
string
queue name
integer
default visibility timeout
\Zend_Queue_Exception |
---|
delete(string $name) : void
string
queue name
\Zend_Queue_Exception |
---|
deleteMessage(\Zend_Queue_Message $message) : boolean
Returns true if the message is deleted, false if the deletion is unsuccessful.
\Zend_Queue_Message
\Zend_Queue_Exception |
---|
boolean
getCapabilities() : array
$array['function name'] = true or false true is supported, false is not supported.
array
getOptions() : array
inherited_from | \Zend_Queue_Adapter_AdapterInterface::getOptions() |
---|
array
getQueue() : \Zend_Queue | null
inherited_from | \Zend_Queue_Adapter_AdapterInterface::getQueue() |
---|
\Zend_Queue
null
getQueues() : void
\Zend_Queue_Exception |
---|
isExists(string $name) : boolean
string
\Zend_Queue_Exception |
(not supported) |
---|
boolean
isJobIdExist($id)
isSupported(string $name) : boolean
inherited_from | \Zend_Queue_Adapter_AdapterInterface::isSupported() |
---|
string
boolean
receive(integer $maxMessages= null
, integer $timeout= null
, \Zend_Queue $queue= null
) : \ArrayIterator
integer
Maximum number of messages to return
integer
Ignored
\Zend_Queue
Not supported
\Zend_Queue_Exception |
---|
\ArrayIterator
send($message, \Zend_Queue $queue = null
) : \Zend_Queue_Message
\Zend_Queue
Not supported
\Zend_Queue_Exception |
---|
\Zend_Queue_Message
setQueue(\Zend_Queue $queue) : \Zend_Queue_Adapter_AdapterInterface
inherited_from | \Zend_Queue_Adapter_AdapterInterface::setQueue() |
---|
\Zend_Queue
\Zend_Queue_Adapter_AdapterInterface
$_queue : \Zend_Queue_Adapter_Abstract
null
$_queues : array
array()
$_zendQueue : \ZendApi_JobQueue
CREATE_TIMEOUT_DEFAULT = 30
RECEIVE_TIMEOUT_DEFAULT = 30