Queue/Adapter/AdapterAbstract.php
Show:
inherited
inherited
Classes
Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled
with this package in the file LICENSE.txt.
It is also available through the world-wide-web at this URL:
http://framework.zend.com/license/new-bsd
If you did not receive a copy of the license and are unable to
obtain it through the world-wide-web, please send an email
to license@zend.com so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Queue
- Subpackage
- Adapter
- Version
- $Id$
\Zend_Queue_Adapter_AdapterAbstract
Package: Zend_Queue\Adapter
Throws
Class for connecting to queues performing common operations.
- Implements
- Children
- \Zend_Queue_Adapter_Array
- \Zend_Queue_Adapter_Null
- \Zend_Queue_Adapter_Activemq
- \Zend_Queue_Adapter_PlatformJobQueue
- \Zend_Queue_Adapter_Db
- \Zend_Queue_Adapter_Memcacheq
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Constants
CREATE_TIMEOUT_DEFAULT
= 30Default timeout for createQueue() function
RECEIVE_TIMEOUT_DEFAULT
= 30Default timeout for recieve() function
Properties
array $_options = array()User-provided options
Default value
array()Details- Type
- array
\Zend_Queue_Adapter_Abstract $_queue = nullContains the Zend_Queue that this object
Default value
nullDetailsarray $_queues = array()Internal array of queues to save on lookups
Default value
array()Details- Type
- array
Methods
__construct( $options, $queue = null) : voidConstructor.
$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
Parameters| Name | Type | Description |
|---|---|---|
| $options | ||
| $queue |
| Exception | Description |
|---|---|
| \Zend_Queue_Exception |
getOptions() : arrayReturns the configuration options in this adapter.
Returns
| Type | Description |
|---|---|
| array |
getQueue() : \Zend_Queue | nullget the Zend_Queue class that is attached to this object
Returns
| Type | Description |
|---|---|
| \Zend_Queue | null |
isSupported(string $name) : booleanIndicates if a function is supported or not.
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $name | string |
| Type | Description |
|---|---|
| boolean |
setQueue(\Zend_Queue $queue) : \Zend_Queue_Adapter_AdapterInterfaceset the Zend_Queue class for this object
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $queue | \Zend_Queue |
| Type | Description |
|---|---|
| \Zend_Queue_Adapter_AdapterInterface |