[ Index ]

PHP Cross Reference of moodle-2.8

title

Body

[close]

/lib/zend/Zend/Service/WindowsAzure/Storage/ -> Queue.php (summary)

Zend Framework LICENSE

Copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
License: http://todo name_todo
Version: $Id$
File Size: 547 lines (20 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Zend_Service_WindowsAzure_Storage_Queue:: (15 methods):
  __construct()
  queueExists()
  createQueue()
  getQueue()
  getQueueMetadata()
  setQueueMetadata()
  deleteQueue()
  listQueues()
  putMessage()
  getMessages()
  peekMessages()
  clearMessages()
  deleteMessage()
  isValidQueueName()
  _getErrorMessage()


Class: Zend_Service_WindowsAzure_Storage_Queue  - X-Ref


__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)   X-Ref
Creates a new Zend_Service_WindowsAzure_Storage_Queue instance

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

queueExists($queueName = '')   X-Ref
Check if a queue exists

param: string $queueName Queue name
return: boolean

createQueue($queueName = '', $metadata = array()   X-Ref
Create queue

param: string $queueName Queue name
param: array  $metadata  Key/value pairs of meta data
return: object Queue properties

getQueue($queueName = '')   X-Ref
Get queue

param: string $queueName  Queue name
return: Zend_Service_WindowsAzure_Storage_QueueInstance

getQueueMetadata($queueName = '')   X-Ref
Get queue metadata

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

setQueueMetadata($queueName = '', $metadata = array()   X-Ref
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.

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

deleteQueue($queueName = '')   X-Ref
Delete queue

param: string $queueName Queue name

listQueues($prefix = null, $maxResults = null, $marker = null, $currentResultCount = 0)   X-Ref
List queues

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

putMessage($queueName = '', $message = '', $ttl = null)   X-Ref
Put message into queue

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

getMessages($queueName = '', $numOfMessages = 1, $visibilityTimeout = null, $peek = false)   X-Ref
Get queue messages

param: string $queueName         Queue name
param: 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.
param: 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.
param: string $peek              Peek only?
return: array

peekMessages($queueName = '', $numOfMessages = 1)   X-Ref
Peek queue messages

param: string $queueName         Queue name
param: 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.
return: array

clearMessages($queueName = '')   X-Ref
Clear queue messages

param: string $queueName         Queue name

deleteMessage($queueName = '', Zend_Service_WindowsAzure_Storage_QueueMessage $message)   X-Ref
Delete queue message

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

isValidQueueName($queueName = '')   X-Ref
Is valid queue name?

param: string $queueName Queue name
return: boolean

_getErrorMessage(Zend_Http_Response $response, $alternativeError = 'Unknown error.')   X-Ref
Get error message from Zend_Http_Response

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



Generated: Fri Nov 28 20:29:05 2014 Cross-referenced by PHPXref 0.7.1