Microsoft_WindowsAzure
[ class tree: Microsoft_WindowsAzure ] [ index: Microsoft_WindowsAzure ] [ all elements ]
Packages:
Microsoft_WindowsAzure
Microsoft
Microsoft_Http
Microsoft_WindowsAzure_Storage


Files:
Credentials.php
SharedAccessSignatureCredentials.php
SharedKeyCredentials.php
SharedKeyLiteCredentials.php

subpackage Exception
Exception.php

subpackage RetryPolicy
Exception.php
NoRetry.php
RetryN.php
RetryPolicy.php

subpackage Session
SessionHandler.php

subpackage Storage
Batch.php
BatchStorage.php
Blob.php
BlobContainer.php
BlobInstance.php
DynamicTableEntity.php
Queue.php
QueueInstance.php
QueueMessage.php
SignedIdentifier.php
Storage.php
Table.php
TableEntity.php
TableEntityQuery.php
TableInstance.php

Classes:
Storage
   Microsoft_WindowsAzure_Storage
   Microsoft_WindowsAzure_Storage_Batch
   Microsoft_WindowsAzure_Storage_BatchStorage
   Microsoft_WindowsAzure_Storage_Blob
   Microsoft_WindowsAzure_Storage_BlobContainer
   Microsoft_WindowsAzure_Storage_BlobInstance
   Microsoft_WindowsAzure_Storage_DynamicTableEntity
   Microsoft_WindowsAzure_Storage_Queue
   Microsoft_WindowsAzure_Storage_QueueInstance
   Microsoft_WindowsAzure_Storage_QueueMessage
   Microsoft_WindowsAzure_Storage_SignedIdentifier
   Microsoft_WindowsAzure_Storage_Table
   Microsoft_WindowsAzure_Storage_TableEntity
   Microsoft_WindowsAzure_Storage_TableEntityQuery
   Microsoft_WindowsAzure_Storage_TableInstance
Microsoft_WindowsAzure_Credentials
Microsoft_WindowsAzure_SharedAccessSignatureCredentials
Microsoft_WindowsAzure_SharedKeyCredentials
Microsoft_WindowsAzure_SharedKeyLiteCredentials
Exception
   Microsoft_WindowsAzure_Exception
RetryPolicy
   Microsoft_WindowsAzure_RetryPolicy
   Microsoft_WindowsAzure_RetryPolicy_Exception
   Microsoft_WindowsAzure_RetryPolicy_NoRetry
   Microsoft_WindowsAzure_RetryPolicy_RetryN
Session
   Microsoft_WindowsAzure_SessionHandler

Class: Microsoft_WindowsAzure_Storage_Queue

Source Location: /WindowsAzure/Storage/Queue.php

Class Overview

Microsoft_WindowsAzure_Storage
   |
   --Microsoft_WindowsAzure_Storage_Queue



Author(s):

Copyright:

  • Copyright (c) 2009, RealDolmen (http://www.realdolmen.com)

Constants

Methods

Inherited Constants

Class: Microsoft_WindowsAzure_Storage

Microsoft_WindowsAzure_Storage::RESOURCE_BLOB
Microsoft_WindowsAzure_Storage::RESOURCE_CONTAINER
Microsoft_WindowsAzure_Storage::RESOURCE_ENTITY
Microsoft_WindowsAzure_Storage::RESOURCE_QUEUE
Microsoft_WindowsAzure_Storage::RESOURCE_TABLE
Microsoft_WindowsAzure_Storage::RESOURCE_UNKNOWN
Microsoft_WindowsAzure_Storage::URL_CLOUD_BLOB
Microsoft_WindowsAzure_Storage::URL_CLOUD_QUEUE
Microsoft_WindowsAzure_Storage::URL_CLOUD_TABLE
Microsoft_WindowsAzure_Storage::URL_DEV_BLOB
Microsoft_WindowsAzure_Storage::URL_DEV_QUEUE
Microsoft_WindowsAzure_Storage::URL_DEV_TABLE

Inherited Variables

Class: Microsoft_WindowsAzure_Storage

Microsoft_WindowsAzure_Storage::$_accountKey
Microsoft_WindowsAzure_Storage::$_accountName
Microsoft_WindowsAzure_Storage::$_apiVersion
Microsoft_WindowsAzure_Storage::$_credentials
Microsoft_WindowsAzure_Storage::$_host
Microsoft_WindowsAzure_Storage::$_proxyCredentials
Microsoft_WindowsAzure_Storage::$_proxyPort
Microsoft_WindowsAzure_Storage::$_proxyUrl
Microsoft_WindowsAzure_Storage::$_retryPolicy
Microsoft_WindowsAzure_Storage::$_usePathStyleUri
Microsoft_WindowsAzure_Storage::$_useProxy

Inherited Methods

Class: Microsoft_WindowsAzure_Storage

Microsoft_WindowsAzure_Storage::__construct()
Creates a new Microsoft_WindowsAzure_Storage instance
Microsoft_WindowsAzure_Storage::getAccountName()
Returns the Windows Azure account name
Microsoft_WindowsAzure_Storage::getBaseUrl()
Get base URL for creating requests
Microsoft_WindowsAzure_Storage::getCredentials()
Get Microsoft_WindowsAzure_Credentials instance
Microsoft_WindowsAzure_Storage::isoDate()
Generate ISO 8601 compliant date string in UTC time zone
Microsoft_WindowsAzure_Storage::parseResponse()
Parse result from Microsoft_Http_Response
Microsoft_WindowsAzure_Storage::performRequest()
Perform request using Microsoft_Http_Transport channel
Microsoft_WindowsAzure_Storage::setCredentials()
Set Microsoft_WindowsAzure_Credentials instance
Microsoft_WindowsAzure_Storage::setProxy()
Set proxy
Microsoft_WindowsAzure_Storage::setRetryPolicy()
Set retry policy to use when making requests
Microsoft_WindowsAzure_Storage::urlencode()
URL encode function

Class Details

[line 84]


Tags:

copyright:  Copyright (c) 2009, RealDolmen (http://www.realdolmen.com)
license:  http://phpazure.codeplex.com/license


[ Top ]

Class Methods

static method isValidQueueName [line 517]

static boolean isValidQueueName( [string $queueName = ''])

Is valid queue name?



Tags:

access:  public


Parameters:

string   $queueName   Queue name

[ Top ]

constructor __construct [line 105]

Microsoft_WindowsAzure_Storage_Queue __construct( [string $host = Microsoft_WindowsAzure_Storage::URL_DEV_QUEUE], [string $accountName = Microsoft_WindowsAzure_SharedKeyCredentials::DEVSTORE_ACCOUNT], [string $accountKey = Microsoft_WindowsAzure_SharedKeyCredentials::DEVSTORE_KEY], [boolean $usePathStyleUri = false], [Microsoft_WindowsAzure_RetryPolicy $retryPolicy = null])

Creates a new Microsoft_WindowsAzure_Storage_Queue instance



Tags:

access:  public


Overrides Microsoft_WindowsAzure_Storage::__construct() (Creates a new Microsoft_WindowsAzure_Storage instance)

Parameters:

string   $host   Storage host name
string   $accountName   Account name for Windows Azure
string   $accountKey   Account key for Windows Azure
boolean   $usePathStyleUri   Use path-style URI's
Microsoft_WindowsAzure_RetryPolicy   $retryPolicy   Retry policy to use when making requests

[ Top ]

method clearMessages [line 472]

void clearMessages( [string $queueName = ''])

Clear queue messages



Tags:

throws:  Microsoft_WindowsAzure_Exception
access:  public


Parameters:

string   $queueName   Queue name

[ Top ]

method createQueue [line 145]

object Queue createQueue( [string $queueName = ''], [array $metadata = array()])

Create queue



Tags:

return:  properties
throws:  Microsoft_WindowsAzure_Exception
access:  public


Parameters:

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

[ Top ]

method deleteMessage [line 494]

void deleteMessage( [string $queueName = ''], Microsoft_WindowsAzure_Storage_QueueMessage $message)

Delete queue message



Tags:

throws:  Microsoft_WindowsAzure_Exception
access:  public


Parameters:

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

[ Top ]

method deleteQueue [line 271]

void deleteQueue( [string $queueName = ''])

Delete queue



Tags:

throws:  Microsoft_WindowsAzure_Exception
access:  public


Parameters:

string   $queueName   Queue name

[ Top ]

method getErrorMessage [line 544]

string getErrorMessage( $response, [string $alternativeError = 'Unknown error.'])

Get error message from Microsoft_Http_Response



Tags:

access:  protected


Parameters:

Microsoft_Http_Response   $response   Repsonse
string   $alternativeError   Alternative error message

[ Top ]

method getMessages [line 392]

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

Get queue messages



Tags:

throws:  Microsoft_WindowsAzure_Exception
access:  public


Parameters:

string   $queueName   Queue name
string   $numOfMessages   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.
int   $visibilityTimeout   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.
string   $peek   Peek only?

[ Top ]

method getQueue [line 181]

Microsoft_WindowsAzure_Storage_QueueInstance getQueue( [string $queueName = ''])

Get queue



Tags:

throws:  Microsoft_WindowsAzure_Exception
access:  public


Parameters:

string   $queueName   Queue name

[ Top ]

method getQueueMetadata [line 223]

array getQueueMetadata( [string $queueName = ''])

Get queue metadata



Tags:

return:  Key/value pairs of meta data
throws:  Microsoft_WindowsAzure_Exception
access:  public


Parameters:

string   $queueName   Queue name

[ Top ]

method listQueues [line 294]

array listQueues( [string $prefix = null], [int $maxResults = null], [string $marker = null], [int $currentResultCount = 0])

List queues



Tags:

throws:  Microsoft_WindowsAzure_Exception
access:  public


Parameters:

string   $prefix   Optional. Filters the results to return only queues whose name begins with the specified prefix.
int   $maxResults   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)
string   $marker   Optional string value that identifies the portion of the list to be returned with the next list operation.
int   $currentResultCount   Current result count (internal use)

[ Top ]

method peekMessages [line 461]

array peekMessages( [string $queueName = ''], [string $numOfMessages = 1])

Peek queue messages



Tags:

throws:  Microsoft_WindowsAzure_Exception
access:  public


Parameters:

string   $queueName   Queue name
string   $numOfMessages   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.

[ Top ]

method putMessage [line 349]

void putMessage( [string $queueName = ''], [string $message = ''], [int $ttl = null])

Put message into queue



Tags:

throws:  Microsoft_WindowsAzure_Exception
access:  public


Parameters:

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

[ Top ]

method queueExists [line 119]

boolean queueExists( [string $queueName = ''])

Check if a queue exists



Tags:

access:  public


Parameters:

string   $queueName   Queue name

[ Top ]

method setQueueMetadata [line 242]

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




Tags:

throws:  Microsoft_WindowsAzure_Exception
access:  public


Parameters:

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

[ Top ]

Class Constants

MAX_MESSAGE_SIZE =  8388608

[line 89]

Maximal message size (in bytes)


[ Top ]

MAX_MESSAGE_TTL =  604800

[line 94]

Maximal message ttl (in seconds)


[ Top ]


Documentation generated on Thu, 26 Nov 2009 08:05:10 +0100 by phpDocumentor 1.4.3