Class for connecting to queues performing common 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

 Methods

Constructor.

__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()

Parameters

$options

$queue

Exceptions

\Zend_Queue_Exception

Returns the configuration options in this adapter.

getOptions() : array
inherited_from \Zend_Queue_Adapter_AdapterInterface::getOptions()

Returns

array

get the Zend_Queue class that is attached to this object

getQueue() : \Zend_Queue | null
inherited_from \Zend_Queue_Adapter_AdapterInterface::getQueue()

Returns

\Zend_Queuenull

Indicates if a function is supported or not.

isSupported(string $name) : boolean
inherited_from \Zend_Queue_Adapter_AdapterInterface::isSupported()

Parameters

$name

string

Returns

boolean

set the Zend_Queue class for this object

setQueue(\Zend_Queue $queue) : \Zend_Queue_Adapter_AdapterInterface
inherited_from \Zend_Queue_Adapter_AdapterInterface::setQueue()

Parameters

$queue

\Zend_Queue

Returns

\Zend_Queue_Adapter_AdapterInterface

 Properties

 

User-provided options

$_options : array

Default

array()
 

Contains the Zend_Queue that this object

$_queue : \Zend_Queue_Adapter_Abstract

Default

null
 

Internal array of queues to save on lookups

$_queues : array

Default

array()

 Constants

 

Default timeout for createQueue() function

CREATE_TIMEOUT_DEFAULT = 30 
 

Default timeout for recieve() function

RECEIVE_TIMEOUT_DEFAULT = 30