Service/WindowsAzure/Storage/Queue.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://todo name_todo
package: Zend_Service_WindowsAzure
subpackage: Storage
version: $Id$
Classes: Zend_Service_WindowsAzure_Storage_Queue

Description

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.

Zend_Service_WindowsAzure_Storage_Queue
jump to top

Extends from: Zend_Service_WindowsAzure_Storage
category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Service_WindowsAzure
subpackage: Storage
Constants: MAX_MESSAGE_SIZE; MAX_MESSAGE_TTL
Methods: __construct; queueExists; createQueue; getQueue; getQueueMetadata; setQueueMetadata; deleteQueue; listQueues; putMessage; getMessages; peekMessages; clearMessages; deleteMessage; isValidQueueName; _getErrorMessage

Description

Constants

MAX_MESSAGE_SIZE
jump to class

 MAX_MESSAGE_SIZE = '8388608'

Maximal message size (in bytes)

Details

value: 8388608

MAX_MESSAGE_TTL
jump to class

 MAX_MESSAGE_TTL = '604800'

Maximal message ttl (in seconds)

Details

value: 604800

Methods

__construct
jump to class

__construct(
          string $host
              =
              Zend_Service_WindowsAzure_Storage, string $accountName
              =
              Zend_Service_WindowsAzure_Credentials_CredentialsAbstract, string $accountKey
              =
              Zend_Service_WindowsAzure_Credentials_CredentialsAbstract, boolean $usePathStyleUri
              =
              false, Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract $retryPolicy
              =
              null
          )
        
        :

Creates a new Zend_Service_WindowsAzure_Storage_Queue instance

Arguments

$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

Details

visibility: public
final: false
static: false

_getErrorMessage
jump to class

_getErrorMessage(
          Zend_Http_Response $response, string $alternativeError
              =
              Unknown error.
          )
        
        :
        string

Get error message from Zend_Http_Response

Arguments

$response: Zend_Http_Response
Repsonse
$alternativeError: string
Alternative error message

Output

string

Details

visibility: protected
final: false
static: false

clearMessages
jump to class

clearMessages(
          string $queueName
          )
        
        :

Clear queue messages

Arguments

$queueName: string
Queue name

Details

visibility: public
final: false
static: false
throws

createQueue
jump to class

createQueue(
          string $queueName, array $metadata
              =
              array
          )
        
        :
        object

Create queue

Arguments

$queueName: string
Queue name
$metadata: array
Key/value pairs of meta data

Output

object: Queue properties

Details

visibility: public
final: false
static: false
throws

deleteMessage
jump to class

deleteMessage(
          string $queueName, Zend_Service_WindowsAzure_Storage_QueueMessage $message
          )
        
        :

Delete queue message

Arguments

$queueName: string
Queue name
$message: Zend_Service_WindowsAzure_Storage_QueueMessage
Message to delete from queue. A message retrieved using "peekMessages" can NOT be deleted!

Details

visibility: public
final: false
static: false
throws

deleteQueue
jump to class

deleteQueue(
          string $queueName
          )
        
        :

Delete queue

Arguments

$queueName: string
Queue name

Details

visibility: public
final: false
static: false
throws

getMessages
jump to class

getMessages(
          string $queueName, string $numOfMessages
              =
              1, int $visibilityTimeout
              =
              null, string $peek
              =
              false
          )
        
        :
        array

Get queue messages

Arguments

$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?

Output

array

Details

visibility: public
final: false
static: false
throws

getQueue
jump to class

getQueue(
          string $queueName
          )
        
        :
        Zend_Service_WindowsAzure_Storage_QueueInstance

Get queue

Arguments

$queueName: string
Queue name

Output

Zend_Service_WindowsAzure_Storage_QueueInstance

Details

visibility: public
final: false
static: false
throws

getQueueMetadata
jump to class

getQueueMetadata(
          string $queueName
          )
        
        :
        array

Get queue metadata

Arguments

$queueName: string
Queue name

Output

array: Key/value pairs of meta data

Details

visibility: public
final: false
static: false
throws

isValidQueueName
jump to class

isValidQueueName(
          string $queueName
          )
        
        :
        boolean

Is valid queue name?

Arguments

$queueName: string
Queue name

Output

boolean

Details

visibility: public
final: false
static: true

listQueues
jump to class

listQueues(
          string $prefix
              =
              null, int $maxResults
              =
              null, string $marker
              =
              null, string $include
              =
              null, int $currentResultCount
              =
              0
          )
        
        :
        array

List queues

Arguments

$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)

Output

array

Details

visibility: public
final: false
static: false
throws

peekMessages
jump to class

peekMessages(
          string $queueName, string $numOfMessages
              =
              1
          )
        
        :
        array

Peek queue messages

Arguments

$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.

Output

array

Details

visibility: public
final: false
static: false
throws

putMessage
jump to class

putMessage(
          string $queueName, string $message, int $ttl
              =
              null
          )
        
        :

Put message into queue

Arguments

$queueName: string
Queue name
$message: string
Message
$ttl: int
Message Time-To-Live (in seconds). Defaults to 7 days if the parameter is omitted.

Details

visibility: public
final: false
static: false
throws

queueExists
jump to class

queueExists(
          string $queueName
          )
        
        :
        boolean

Check if a queue exists

Arguments

$queueName: string
Queue name

Output

boolean

Details

visibility: public
final: false
static: false

setQueueMetadata
jump to class

setQueueMetadata(
          string $queueName, array $metadata
              =
              array
          )
        
        :

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.

Arguments

$queueName: string
Queue name
$metadata: array
Key/value pairs of meta data

Details

visibility: public
final: false
static: false
throws

API Documentation

Service/WindowsAzure/Storage/Queue.php

Description

Zend_Service_WindowsAzure_Storage_Queuejump to top

Description

Constants

MAX_MESSAGE_SIZEjump to class

Details

MAX_MESSAGE_TTLjump to class

Details

Methods

__constructjump to class

Arguments

Details

_getErrorMessagejump to class

Arguments

Output

Details

clearMessagesjump to class

Arguments

Details

createQueuejump to class

Arguments

Output

Details

deleteMessagejump to class

Arguments

Details

deleteQueuejump to class

Arguments

Details

getMessagesjump to class

Arguments

Output

Details

getQueuejump to class

Arguments

Output

Details

getQueueMetadatajump to class

Arguments

Output

Details

isValidQueueNamejump to class

Arguments

Output

Details

listQueuesjump to class

Arguments

Output

Details

peekMessagesjump to class

Arguments

Output

Details

putMessagejump to class

Arguments

Details

queueExistsjump to class

Arguments

Output

Details

setQueueMetadatajump to class

Arguments

Details

Zend_Service_WindowsAzure_Storage_Queue
jump to top

MAX_MESSAGE_SIZE
jump to class

MAX_MESSAGE_TTL
jump to class

__construct
jump to class

_getErrorMessage
jump to class

clearMessages
jump to class

createQueue
jump to class

deleteMessage
jump to class

deleteQueue
jump to class

getMessages
jump to class

getQueue
jump to class

getQueueMetadata
jump to class

isValidQueueName
jump to class

listQueues
jump to class

peekMessages
jump to class

putMessage
jump to class

queueExists
jump to class

setQueueMetadata
jump to class