Cloud/QueueService/Adapter/WindowsAzure.php

Show: PublicProtectedPrivateinherited
Table of Contents
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-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Cloud  
Subpackage
QueueService  

\Zend_Cloud_QueueService_Adapter_WindowsAzure

Package: Zend_Cloud\QueueService
WindowsAzure adapter for simple queue service.
Provides functionality around setting message and message set classes.
Parent(s)
\Zend_Cloud_QueueService_Adapter_AbstractAdapter
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Constants

>VConstant  ACCOUNT_NAME = 'storage_accountname'
Option array keys for the Windows Azure adapter.
>VConstant  ACCOUNT_KEY = 'storage_accountkey'
>VConstant  HOST = "storage_host"
>VConstant  PROXY_HOST = "storage_proxy_host"
>VConstant  PROXY_PORT = "storage_proxy_port"
>VConstant  PROXY_CREDENTIALS = "storage_proxy_credentials"
>VConstant  LIST_PREFIX = 'prefix'
list options
>VConstant  LIST_MAX_RESULTS = 'max_results'
>VConstant  MESSAGE_TTL = 'ttl'
message options
>VConstant  DEFAULT_HOST = \Zend_Service_WindowsAzure_Storage::URL_CLOUD_QUEUE

Properties

>VPropertyprotected\Zend_Service_WindowsAzure_Storage_Queue $_storageClient = null
Storage client
Default valuenullDetails
Type
\Zend_Service_WindowsAzure_Storage_Queue

Methods

methodpublic__construct(array | \Zend_Config $options = array()) : void

Constructor

Parameters
NameTypeDescription
$optionsarray | \Zend_Config
methodprotected_makeMessages(array $messages) : \Zend_Cloud_QueueService_Message[]

Create Zend_Cloud_QueueService_Message array for Azure messages.

Parameters
NameTypeDescription
$messagesarray
Returns
TypeDescription
\Zend_Cloud_QueueService_Message[]
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.
Parameters
NameTypeDescription
$namestring
$optionsarray
Returns
TypeDescription
stringQueue ID (typically URL)
methodpublicdeleteMessage(string $queueId, \Zend_Cloud_QueueService_Message $message, array $options = null) : void

Delete the specified message from the specified queue.

Parameters
NameTypeDescription
$queueIdstring
$message\Zend_Cloud_QueueService_Message

Message ID or message

$optionsarray
methodpublicdeleteQueue(string $queueId, array $options = null) : boolean

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

Parameters
NameTypeDescription
$queueIdstring
$optionsarray
Returns
TypeDescription
booleantrue if successful, false otherwise
methodpublicfetchQueueMetadata(string $queueId, array $options = null) : array

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

Parameters
NameTypeDescription
$queueIdstring
$optionsarray
Returns
TypeDescription
array
methodpublicgetClient() : \Zend_Service_Azure_Storage_Queue

Get Azure implementation

Returns
TypeDescription
\Zend_Service_Azure_Storage_Queue
methodpubliclistQueues(array $options = null) : array

List all queues.

Parameters
NameTypeDescription
$optionsarray
Returns
TypeDescription
arrayQueue IDs
methodpublicpeekMessages(string $queueId, int $num = 1, array $options = null) : \Zend_Cloud_QueueService_Message[]

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

Parameters
NameTypeDescription
$queueIdstring
$numint

How many messages

$optionsarray
Returns
TypeDescription
\Zend_Cloud_QueueService_Message[]
methodpublicreceiveMessages(string $queueId, int $max = 1, array $options = null) : \Zend_Cloud_QueueService_Message[]

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

Parameters
NameTypeDescription
$queueIdstring
$maxint
$optionsarray
Returns
TypeDescription
\Zend_Cloud_QueueService_Message[]
methodpublicsendMessage(string $queueId, string $message, array $options = null) : string

Send a message to the specified queue.

Parameters
NameTypeDescription
$queueIdstring
$messagestring
$optionsarray
Returns
TypeDescription
stringMessage 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
NameTypeDescription
$queueIdstring
$metadataarray
$optionsarray
Documentation was generated by phpDocumentor 2.2.0 .