API Documentation

Zend/Service/WindowsAzure/Storage/Queue.php

Show: inherited
Table of Contents

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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
name_todo  
Package
Zend_Service_WindowsAzure  
Subpackage
Storage  
Version
$Id: Queue.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Service_WindowsAzure_Storage_Queue

Package: Zend\Service\WindowsAzure\Storage

Parent(s)
\Zend_Service_WindowsAzure_Storage
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Constants

Constant  MAX_MESSAGE_SIZE = 8388608

Maximal message size (in bytes)

Constant  MAX_MESSAGE_TTL = 604800

Maximal message ttl (in seconds)

Methods

methodpublic__construct( string $host = Zend_Service_WindowsAzure_Storage::URL_DEV_QUEUE, string $accountName = Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::DEVSTORE_ACCOUNT, string $accountKey = Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::DEVSTORE_KEY, boolean $usePathStyleUri = false, \Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract $retryPolicy = null ) : void

Creates a new Zend_Service_WindowsAzure_Storage_Queue instance

Parameters
Name Type Description
$host string

Storage host name

$accountName string

Account name for Windows Azure

$accountKey string

Account key for Windows Azure

$usePathStyleUri boolean

Use path-style URI's

$retryPolicy \Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract

Retry policy to use when making requests

methodprotected_getErrorMessage( \Zend_Http_Response $response, string $alternativeError = 'Unknown error.' ) : string

Get error message from Zend_Http_Response

Parameters
Name Type Description
$response \Zend_Http_Response

Repsonse

$alternativeError string

Alternative error message

Returns
Type Description
string
methodpublicclearMessages( string $queueName = '' ) : void

Clear queue messages

Parameters
Name Type Description
$queueName string

Queue name

Throws
Exception Description
\Zend_Service_WindowsAzure_Exception
methodpubliccreateQueue( string $queueName = '', array $metadata = array() ) : object

Create queue

Parameters
Name Type Description
$queueName string

Queue name

$metadata array

Key/value pairs of meta data

Returns
Type Description
object Queue properties
Throws
Exception Description
\Zend_Service_WindowsAzure_Exception
methodpublicdeleteMessage( string $queueName = '', \Zend_Service_WindowsAzure_Storage_QueueMessage $message ) : void

Delete queue message

Parameters
Name Type Description
$queueName string

Queue name

$message \Zend_Service_WindowsAzure_Storage_QueueMessage

Message to delete from queue. A message retrieved using "peekMessages" can NOT be deleted!

Throws
Exception Description
\Zend_Service_WindowsAzure_Exception
methodpublicdeleteQueue( string $queueName = '' ) : void

Delete queue

Parameters
Name Type Description
$queueName string

Queue name

Throws
Exception Description
\Zend_Service_WindowsAzure_Exception
methodpublicgetMessages( string $queueName = '', string $numOfMessages = 1, int $visibilityTimeout = null, string $peek = false ) : array

Get queue messages

Parameters
Name Type Description
$queueName string

Queue name

$numOfMessages string

Optional. A nonzero integer value that specifies the number of messages to retrieve from the queue, up to a maximum of 32. By default, a single message is retrieved from the queue with this operation.

$visibilityTimeout int

Optional. An integer value that specifies the message's visibility timeout in seconds. The maximum value is 2 hours. The default message visibility timeout is 30 seconds.

$peek string

Peek only?

Returns
Type Description
array
Throws
Exception Description
\Zend_Service_WindowsAzure_Exception
methodpublicgetQueue( string $queueName = '' ) : \Zend_Service_WindowsAzure_Storage_QueueInstance

Get queue

Parameters
Name Type Description
$queueName string

Queue name

Returns
Type Description
\Zend_Service_WindowsAzure_Storage_QueueInstance
Throws
Exception Description
\Zend_Service_WindowsAzure_Exception
methodpublicgetQueueMetadata( string $queueName = '' ) : array

Get queue metadata

Parameters
Name Type Description
$queueName string

Queue name

Returns
Type Description
array Key/value pairs of meta data
Throws
Exception Description
\Zend_Service_WindowsAzure_Exception
methodpublicisValidQueueName( string $queueName = '' ) : boolean
static

Is valid queue name?

Parameters
Name Type Description
$queueName string

Queue name

Returns
Type Description
boolean
methodpubliclistQueues( string $prefix = null, int $maxResults = null, string $marker = null, string $include = null, int $currentResultCount = 0 ) : array

List queues

Parameters
Name Type Description
$prefix string

Optional. Filters the results to return only queues whose name begins with the specified prefix.

$maxResults int

Optional. Specifies the maximum number of queues to return per call to Azure storage. This does NOT affect list size returned by this function. (maximum: 5000)

$marker string

Optional string value that identifies the portion of the list to be returned with the next list operation.

$include string

Optional. Include this parameter to specify that the queue's metadata be returned as part of the response body. (allowed values: '', 'metadata')

$currentResultCount int

Current result count (internal use)

Returns
Type Description
array
Throws
Exception Description
\Zend_Service_WindowsAzure_Exception
methodpublicpeekMessages( string $queueName = '', string $numOfMessages = 1 ) : array

Peek queue messages

Parameters
Name Type Description
$queueName string

Queue name

$numOfMessages string

Optional. A nonzero integer value that specifies the number of messages to retrieve from the queue, up to a maximum of 32. By default, a single message is retrieved from the queue with this operation.

Returns
Type Description
array
Throws
Exception Description
\Zend_Service_WindowsAzure_Exception
methodpublicputMessage( string $queueName = '', string $message = '', int $ttl = null ) : void

Put message into queue

Parameters
Name Type Description
$queueName string

Queue name

$message string

Message

$ttl int

Message Time-To-Live (in seconds). Defaults to 7 days if the parameter is omitted.

Throws
Exception Description
\Zend_Service_WindowsAzure_Exception
methodpublicqueueExists( string $queueName = '' ) : boolean

Check if a queue exists

Parameters
Name Type Description
$queueName string

Queue name

Returns
Type Description
boolean
methodpublicsetQueueMetadata( string $queueName = '', array $metadata = array() ) : void

Set queue metadata

Calling the Set Queue Metadata operation overwrites all existing metadata that is associated with the queue. It's not possible to modify an individual name/value pair.

Parameters
Name Type Description
$queueName string

Queue name

$metadata array

Key/value pairs of meta data

Throws
Exception Description
\Zend_Service_WindowsAzure_Exception
Documentation was generated by DocBlox 0.15.1.