API Documentation

Cloud/QueueService/Adapter.php

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_Cloud  
subpackage
QueueService  

\Zend_Cloud_QueueService_Adapter

Common interface for queue services in the cloud. This interface supports most queue services and provides some flexibility for vendor-specific features and requirements via an optional $options array in each method signature. Classes implementing this interface should implement URI construction for queues from the parameters given in each method and the account data passed in to the constructor. Classes implementing this interface are also responsible for security; access control isn't currently supported in this interface, although we are considering access control support in future versions of the interface.

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

Constants

Constant  HTTP_ADAPTER = 'http_adapter'

Ctor HTTP adapter option

Constant  VISIBILITY_TIMEOUT = 'visibility_timeout'

Message visibility timeout option

Constant  DEFAULT_TIMEOUT = '30'

Default visibility timeout

Methods

methodpubliccreateQueue( string $name, array $options = null ) : string

Create a queue. Returns the ID of the created queue (typically the URL).

It may take some time to create the queue. Check your vendor's documentation for details.

Name constraints: Maximum 80 characters Only alphanumeric characters, hyphens (-), and underscores (_)

Parameters
Name Type Description
$name string
$options array
Returns
Type Description
string Queue ID (typically URL)
methodpublicdeleteMessage( string $queueId, \Zend_Cloud_QueueService_Message $message, array $options = null ) : void

Delete the specified message from the specified queue.

Parameters
Name Type Description
$queueId string
$message \Zend_Cloud_QueueService_Message Message to delete
$options array
methodpublicdeleteQueue( string $queueId, array $options = null ) : boolean

Delete a queue. All messages in the queue will also be deleted.

Parameters
Name Type Description
$queueId string
$options array
Returns
Type Description
boolean true if successful, false otherwise
methodpublicfetchQueueMetadata( string $queueId, array $options = null ) : array

Get a key/value array of metadata for the given queue.

Parameters
Name Type Description
$queueId string
$options array
Returns
Type Description
array
methodpublicgetClient( ) : void

Get the concrete adapter.

methodpubliclistQueues( array $options = null ) : array

List all queues.

Parameters
Name Type Description
$options array
Returns
Type Description
array Queue IDs
methodpublicpeekMessages( string $queueId, int $num = 1, array $options = null ) : \array[Zend_Cloud_QueueService_Message]

Peek at the messages from the specified queue without removing them.

Parameters
Name Type Description
$queueId string
$num int How many messages
$options array
Returns
Type Description
\array[Zend_Cloud_QueueService_Message]
methodpublicreceiveMessages( string $queueId, int $max = 1, array $options = null ) : \array[Zend_Cloud_QueueService_Message]

Recieve at most $max messages from the specified queue and return the message IDs for messages recieved.

Parameters
Name Type Description
$queueId string
$max int
$options array
Returns
Type Description
\array[Zend_Cloud_QueueService_Message] Array of messages
methodpublicsendMessage( string $queueId, string $message, array $options = null ) : string

Send a message to the specified queue.

Parameters
Name Type Description
$queueId string
$message string
$options array
Returns
Type Description
string Message ID
methodpublicstoreQueueMetadata( string $queueId, array $metadata, array $options = null ) : void

Store a key/value array of metadata for the specified queue.

WARNING: This operation overwrites any metadata that is located at $destinationPath. Some adapters may not support this method.

Parameters
Name Type Description
$queueId string
$metadata array
$options array
Documentation was generated by DocBlox 0.13.3.