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 |
|---|---|
| package | Zend_Cloud |
| subpackage | QueueService |
| copyright | Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com) |
| license | New BSD License |
createQueue(string $name, array $options = null) : string
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 (_)
string
array
stringQueue ID (typically URL)deleteMessage(string $queueId, \Zend_Cloud_QueueService_Message $message, array $options = null) : void
string
\Zend_Cloud_QueueService_MessageMessage to delete
array
deleteQueue(string $queueId, array $options = null) : boolean
string
array
booleantrue if successful, false otherwisefetchQueueMetadata(string $queueId, array $options = null) : array
string
array
arraygetClient()
listQueues(array $options = null) : array
array
arrayQueue IDspeekMessages(string $queueId, integer $num= 1, array $options= null) : \array[Zend_Cloud_QueueService_Message]
string
integerHow many messages
array
\array[Zend_Cloud_QueueService_Message]receiveMessages(string $queueId, integer $max= 1, array $options= null) : \array[Zend_Cloud_QueueService_Message]
string
integer
array
\array[Zend_Cloud_QueueService_Message]Array of messagessendMessage(string $queueId, string $message, array $options = null) : string
string
string
array
stringMessage IDstoreQueueMetadata(string $queueId, array $metadata, array $options = null) : void
WARNING: This operation overwrites any metadata that is located at $destinationPath. Some adapters may not support this method.
string
array
array
DEFAULT_TIMEOUT = 30
HTTP_ADAPTER = 'http_adapter'
VISIBILITY_TIMEOUT = 'visibility_timeout'