Inheritance diagram for Zend_Service_WindowsAzure_Storage_Queue:

Collaboration diagram for Zend_Service_WindowsAzure_Storage_Queue:

Public Member Functions
	__construct ($host=Zend_Service_WindowsAzure_Storage::URL_DEV_QUEUE, $accountName=Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::DEVSTORE_ACCOUNT, $accountKey=Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::DEVSTORE_KEY, $usePathStyleUri=false, Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract $retryPolicy=null)
	queueExists ($queueName= '')
	createQueue ($queueName= '', $metadata=array())
	getQueue ($queueName= '')
	getQueueMetadata ($queueName= '')
	setQueueMetadata ($queueName= '', $metadata=array())
	deleteQueue ($queueName= '')
	listQueues ($prefix=null, $maxResults=null, $marker=null, $currentResultCount=0)
	putMessage ($queueName= '', $message= '', $ttl=null)
	getMessages ($queueName= '', $numOfMessages=1, $visibilityTimeout=null, $peek=false)
	peekMessages ($queueName= '', $numOfMessages=1)
	clearMessages ($queueName= '')
	deleteMessage ($queueName= '', Zend_Service_WindowsAzure_Storage_QueueMessage $message)
Static Public Member Functions
static	isValidQueueName ($queueName= '')
Data Fields
const	MAX_MESSAGE_SIZE = 8388608
const	MAX_MESSAGE_TTL = 604800
Protected Member Functions
	_getErrorMessage (Zend_Http_Response $response, $alternativeError= 'Unknown error.')

Detailed Description

Definition at line 71 of file Queue.php.

Constructor & Destructor Documentation

__construct	(	$	host = `Zend_Service_WindowsAzure_Storage::URL_DEV_QUEUE`,
		$	accountName = `Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::DEVSTORE_ACCOUNT`,
		$	accountKey = `Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::DEVSTORE_KEY`,
		$	usePathStyleUri = `false`,
		Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract $	retryPolicy = `null`
	)

Creates a new Zend_Service_WindowsAzure_Storage_Queue 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
Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract	$retryPolicy	Retry policy to use when making requests

Reimplemented from Zend_Service_WindowsAzure_Storage.

Definition at line 92 of file Queue.php.

Member Function Documentation

_getErrorMessage	(	Zend_Http_Response $	response,
		$	alternativeError = `'Unknown error.'`
	)		`[protected]`

Get error message from Zend_Http_Response

Parameters:

Zend_Http_Response	$response	Repsonse
string	$alternativeError	Alternative error message

Returns:: string

Definition at line 538 of file Queue.php.

Here is the call graph for this function:

Here is the caller graph for this function:

clearMessages ( $ queueName = '' )

Clear queue messages

Parameters:

string $queueName Queue name

Exceptions:

Zend_Service_WindowsAzure_Exception

Definition at line 458 of file Queue.php.

Here is the call graph for this function:

createQueue	(	$	queueName = `''`,
		$	metadata = `array()`
	)

Create queue

Parameters:

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

Returns:: object Queue properties

Exceptions:

Zend_Service_WindowsAzure_Exception

Definition at line 134 of file Queue.php.

Here is the call graph for this function:

deleteMessage	(	$	queueName = `''`,
		Zend_Service_WindowsAzure_Storage_QueueMessage $	message
	)

Delete queue message

Parameters:

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

Exceptions:

Zend_Service_WindowsAzure_Exception

Definition at line 481 of file Queue.php.

Here is the call graph for this function:

deleteQueue ( $ queueName = '' )

Delete queue

Parameters:

string $queueName Queue name

Exceptions:

Zend_Service_WindowsAzure_Exception

Definition at line 251 of file Queue.php.

Here is the call graph for this function:

getMessages	(	$	queueName = `''`,
		$	numOfMessages = `1`,
		$	visibilityTimeout = `null`,
		$	peek = `false`
	)

Get queue messages

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?

Returns:: array

Exceptions:

Zend_Service_WindowsAzure_Exception

Definition at line 377 of file Queue.php.

Here is the call graph for this function:

Here is the caller graph for this function:

getQueue ( $ queueName = '' )

Get queue

Parameters:

string $queueName Queue name

Returns:: Zend_Service_WindowsAzure_Storage_QueueInstance

Exceptions:

Zend_Service_WindowsAzure_Exception

Definition at line 166 of file Queue.php.

Here is the call graph for this function:

Here is the caller graph for this function:

getQueueMetadata ( $ queueName = '' )

Get queue metadata

Parameters:

string $queueName Queue name

Returns:: array Key/value pairs of meta data

Exceptions:

Zend_Service_WindowsAzure_Exception

Definition at line 200 of file Queue.php.

Here is the call graph for this function:

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

Is valid queue name?

Parameters:

string $queueName Queue name

Returns:: boolean

Definition at line 506 of file Queue.php.

listQueues	(	$	prefix = `null`,
		$	maxResults = `null`,
		$	marker = `null`,
		$	currentResultCount = `0`
	)

List queues

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)

Returns:: array

Exceptions:

Zend_Service_WindowsAzure_Exception

Definition at line 277 of file Queue.php.

Here is the call graph for this function:

Here is the caller graph for this function:

peekMessages	(	$	queueName = `''`,
		$	numOfMessages = `1`
	)

Peek queue messages

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.

Returns:: array

Exceptions:

Zend_Service_WindowsAzure_Exception

Definition at line 447 of file Queue.php.

Here is the call graph for this function:

putMessage	(	$	queueName = `''`,
		$	message = `''`,
		$	ttl = `null`
	)

Put message into queue

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.

Exceptions:

Zend_Service_WindowsAzure_Exception

Definition at line 329 of file Queue.php.

Here is the call graph for this function:

queueExists ( $ queueName = '' )

Check if a queue exists

Parameters:

string $queueName Queue name

Returns:: boolean

Definition at line 106 of file Queue.php.

Here is the call graph for this function:

setQueueMetadata	(	$	queueName = `''`,
		$	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.

Parameters: