Zend Framework  1.12
Public Member Functions | List of all members
Zend_Queue_Adapter_Null Class Reference

Public Member Functions

 __construct ($options, Zend_Queue $queue=null)
 Constructor.
 
 isExists ($name)
 Does a queue already exist?
 
 create ($name, $timeout=null)
 Create a new queue.
 
 delete ($name)
 Delete a queue and all of it's 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 Member Functions inherited from Zend_Queue_Adapter_AdapterAbstract
 __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.
 

Additional Inherited Members

- Public Attributes inherited from Zend_Queue_Adapter_AdapterAbstract
const CREATE_TIMEOUT_DEFAULT = 30
 Default timeout for createQueue() function.
 
const RECEIVE_TIMEOUT_DEFAULT = 30
 Default timeout for recieve() function.
 
- Protected Attributes inherited from Zend_Queue_Adapter_AdapterAbstract
 $_options = array()
 
 $_queues = array()
 
 $_queue = null
 

Constructor & Destructor Documentation

__construct (   $options,
Zend_Queue  $queue = null 
)

Constructor.

Parameters
array | Zend_Config$options
null | Zend_Queue$queue
Returns
void

Implements Zend_Queue_Adapter_AdapterInterface.

Member Function Documentation

count ( Zend_Queue  $queue = null)

Return the approximate number of messages in the queue.

Exceptions
Zend_Queue_Exception- not supported.

Implements Zend_Queue_Adapter_AdapterInterface.

create (   $name,
  $timeout = null 
)

Create a new queue.

Exceptions
Zend_Queue_Exception- not supported.

Implements Zend_Queue_Adapter_AdapterInterface.

delete (   $name)

Delete a queue and all of it's messages.

Exceptions
Zend_Queue_Exception- not supported.

Implements Zend_Queue_Adapter_AdapterInterface.

deleteMessage ( Zend_Queue_Message  $message)

Delete a message from the queue.

Exceptions
Zend_Queue_Exception- not supported.

Implements Zend_Queue_Adapter_AdapterInterface.

getCapabilities ( )

Return a list of queue capabilities functions.

$array['function name'] = true or false true is supported, false is not supported.

Parameters
string$name
Returns
array

Implements Zend_Queue_Adapter_AdapterInterface.

getQueues ( )

Get an array of all available queues.

Exceptions
Zend_Queue_Exception- not supported.

Implements Zend_Queue_Adapter_AdapterInterface.

isExists (   $name)

Does a queue already exist?

Exceptions
Zend_Queue_Exception- not supported.

Implements Zend_Queue_Adapter_AdapterInterface.

receive (   $maxMessages = null,
  $timeout = null,
Zend_Queue  $queue = null 
)

Get messages in the queue.

Exceptions
Zend_Queue_Exception- not supported.

Implements Zend_Queue_Adapter_AdapterInterface.

send (   $message,
Zend_Queue  $queue = null 
)

Send a message to the queue.

Exceptions
Zend_Queue_Exception- not supported.

Implements Zend_Queue_Adapter_AdapterInterface.