API Documentation

Queue/Adapter/AdapterInterface.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Queue  
subpackage
Adapter  
version
$Id: AdapterInterface.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Queue_Adapter_AdapterInterface

Interface for common queue operations

category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Queue  
subpackage
Adapter  

Methods

methodpublic__construct( array|\Zend_Config $options, \Zend_Queue $queue = null ) : void

Constructor

Parameters
Name Type Description
$options array|\Zend_Config
$queue \Zend_Queue
methodpubliccount( \Zend_Queue|null $queue = null ) : integer

Return the approximate number of messages in the queue

Parameters
Name Type Description
$queue \Zend_Queue|null
Returns
Type Description
integer
methodpubliccreate( string $name, integer $timeout = null ) : boolean

Create a new queue

Visibility timeout is how long a message is left in the queue "invisible" to other readers. If the message is acknowleged (deleted) before the timeout, then the message is deleted. However, if the timeout expires then the message will be made available to other queue readers.

Parameters
Name Type Description
$name string Queue name
$timeout integer Default visibility timeout
Returns
Type Description
boolean
methodpublicdelete( string $name ) : boolean

Delete a queue and all of its messages

Return false if the queue is not found, true if the queue exists.

Parameters
Name Type Description
$name string Queue name
Returns
Type Description
boolean
methodpublicdeleteMessage( \Zend_Queue_Message $message ) : boolean

Delete a message from the queue

Return true if the message is deleted, false if the deletion is unsuccessful.

Parameters
Name Type Description
$message \Zend_Queue_Message
Returns
Type Description
boolean
methodpublicgetCapabilities( ) : array

Return a list of queue capabilities functions

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

Returns
Type Description
array
methodpublicgetOptions( ) : array

Returns the configuration options in this adapter.

Returns
Type Description
array
methodpublicgetQueue( ) : \Zend_Queue

Retrieve queue instance

Returns
Type Description
\Zend_Queue
methodpublicgetQueues( ) : array

Get an array of all available queues

Not all adapters support getQueues(); use isSupported('getQueues') to determine if the adapter supports this feature.

Returns
Type Description
array
methodpublicisExists( string $name ) : boolean

Does a queue already exist?

Use isSupported('isExists') to determine if an adapter can test for queue existance.

Parameters
Name Type Description
$name string Queue name
Returns
Type Description
boolean
methodpublicisSupported( string $name ) : boolean

Indicates if a function is supported or not.

Parameters
Name Type Description
$name string Function name
Returns
Type Description
boolean
methodpublicreceive( integer|null $maxMessages = null, integer|null $timeout = null, \Zend_Queue|null $queue = null ) : \Zend_Queue_Message_Iterator

Get messages in the queue

Parameters
Name Type Description
$maxMessages integer|null Maximum number of messages to return
$timeout integer|null Visibility timeout for these messages
$queue \Zend_Queue|null
Returns
Type Description
\Zend_Queue_Message_Iterator
methodpublicsend( mixed $message, \Zend_Queue|null $queue = null ) : \Zend_Queue_Message

Send a message to the queue

Parameters
Name Type Description
$message mixed Message to send to the active queue
$queue \Zend_Queue|null
Returns
Type Description
\Zend_Queue_Message
methodpublicsetQueue( \Zend_Queue $queue ) : \Zend_Queue_Adapter_AdapterInterface

Set queue instnace

Parameters
Name Type Description
$queue \Zend_Queue
Returns
Type Description
\Zend_Queue_Adapter_AdapterInterface
Documentation was generated by DocBlox 0.13.3.