Zend Framework  1.12
Public Member Functions | Public Attributes | Protected Attributes | List of all members
Zend_Queue_Adapter_AdapterAbstract Class Reference

Public Member Functions

 __construct ($options, Zend_Queue $queue=null)
 Constructor.
 
 getQueue ()
 get the Zend_Queue class that is attached to this object
 
 setQueue (Zend_Queue $queue)
 set the Zend_Queue class for this object
 
 getOptions ()
 Returns the configuration options in this adapter.
 
 isSupported ($name)
 Indicates if a function is supported or not.
 
- Public Member Functions inherited from Zend_Queue_Adapter_AdapterInterface
 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.
 
 getCapabilities ()
 Return a list of queue capabilities functions.
 

Public Attributes

const CREATE_TIMEOUT_DEFAULT = 30
 Default timeout for createQueue() function.
 
const RECEIVE_TIMEOUT_DEFAULT = 30
 Default timeout for recieve() function.
 

Protected Attributes

 $_options = array()
 
 $_queues = array()
 
 $_queue = null
 

Constructor & Destructor Documentation

__construct (   $options,
Zend_Queue  $queue = null 
)

Constructor.

$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
array | Zend_Config$configAn array having configuration data
Zend_QueueThe Zend_Queue object that created this class
Returns
void
Exceptions
Zend_Queue_Exception

Implements Zend_Queue_Adapter_AdapterInterface.

Member Function Documentation

getOptions ( )

Returns the configuration options in this adapter.

Returns
array

Implements Zend_Queue_Adapter_AdapterInterface.

getQueue ( )

get the Zend_Queue class that is attached to this object

Returns
Zend_Queue|null

Implements Zend_Queue_Adapter_AdapterInterface.

isSupported (   $name)

Indicates if a function is supported or not.

Parameters
string$name
Returns
boolean

Implements Zend_Queue_Adapter_AdapterInterface.

setQueue ( Zend_Queue  $queue)

set the Zend_Queue class for this object

Parameters
Zend_Queue$queue
Returns
Zend_Queue_Adapter_AdapterInterface

Implements Zend_Queue_Adapter_AdapterInterface.

Member Data Documentation

$_options = array()
protected
$_queue = null
protected
$_queues = array()
protected
const CREATE_TIMEOUT_DEFAULT = 30

Default timeout for createQueue() function.

const RECEIVE_TIMEOUT_DEFAULT = 30

Default timeout for recieve() function.