Cloud/QueueService/Adapter/ZendQueue.php

Show:

inherited

Classes
- \Zend_Cloud_QueueService_Adapter_ZendQueue

Table of Contents

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 [email protected] so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Cloud
Subpackage: QueueService

\Zend_Cloud_QueueService_Adapter_ZendQueue
jump to top

Package: Zend\Cloud\QueueService

WindowsAzure adapter for simple queue service.

Provides functionality around setting message and message set classes.

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

Constants

 
                ADAPTER
                = 'adapter'

Options array keys for the Zend_Queue adapter.

 
                MESSAGE_CLASS
                = 'message_class'

inheritedInherited from: \Zend_Cloud_QueueService_Adapter_AbstractAdapter::MESSAGE_CLASS

Inherited_from: \Zend_Cloud_QueueService_Adapter_AbstractAdapter::MESSAGE_CLASS

 
                MESSAGESET_CLASS
                = 'messageset_class'

inheritedInherited from: \Zend_Cloud_QueueService_Adapter_AbstractAdapter::MESSAGESET_CLASS

Inherited_from: \Zend_Cloud_QueueService_Adapter_AbstractAdapter::MESSAGESET_CLASS

 
                HTTP_ADAPTER
                = 'http_adapter'

inherited

Ctor HTTP adapter option

Inherited from: \Zend_Cloud_QueueService_Adapter::HTTP_ADAPTER \Zend_Cloud_QueueService_Adapter_AbstractAdapter::HTTP_ADAPTER

Inherited_from: \Zend_Cloud_QueueService_Adapter::HTTP_ADAPTER
Inherited_from: \Zend_Cloud_QueueService_Adapter_AbstractAdapter::HTTP_ADAPTER

 
                VISIBILITY_TIMEOUT
                = 'visibility_timeout'

inherited

Message visibility timeout option

Inherited from: \Zend_Cloud_QueueService_Adapter::VISIBILITY_TIMEOUT \Zend_Cloud_QueueService_Adapter_AbstractAdapter::VISIBILITY_TIMEOUT

Inherited_from: \Zend_Cloud_QueueService_Adapter::VISIBILITY_TIMEOUT
Inherited_from: \Zend_Cloud_QueueService_Adapter_AbstractAdapter::VISIBILITY_TIMEOUT

 
                DEFAULT_TIMEOUT
                = 30

inherited

Default visibility timeout

Inherited from: \Zend_Cloud_QueueService_Adapter::DEFAULT_TIMEOUT \Zend_Cloud_QueueService_Adapter_AbstractAdapter::DEFAULT_TIMEOUT

Inherited_from: \Zend_Cloud_QueueService_Adapter::DEFAULT_TIMEOUT
Inherited_from: \Zend_Cloud_QueueService_Adapter_AbstractAdapter::DEFAULT_TIMEOUT

Properties

string $_messageClass = 'Zend_Cloud_QueueService_Message'

inherited

Class to use for queue messagesInherited from: \Zend_Cloud_QueueService_Adapter_AbstractAdapter::$$_messageClass

Default value'Zend_Cloud_QueueService_Message'Details

Type: string
Inherited_from: \Zend_Cloud_QueueService_Adapter_AbstractAdapter::$$_messageClass

string $_messageSetClass = 'Zend_Cloud_QueueService_MessageSet'

inherited

Class to use for collections of queue messagesInherited from: \Zend_Cloud_QueueService_Adapter_AbstractAdapter::$$_messageSetClass

Default value'Zend_Cloud_QueueService_MessageSet'Details

Type: string
Inherited_from: \Zend_Cloud_QueueService_Adapter_AbstractAdapter::$$_messageSetClass

\Zend_Queue $_queue = null

Storage client

Default valuenullDetails

Type: \Zend_Queue

array $_queues = array()

All queues

Default valuearray()Details

Type: array

Methods

__construct(array | \Zend_Config $options = array()) : void

Constructor

Parameters

Name	Type	Description
$options	array \| \Zend_Config

_makeMessages(array $messages) : \Zend_Cloud_QueueService_Message[]

Create Zend_Cloud_QueueService_Message array for Azure messages.

Parameters

Name	Type	Description
$messages	array

Returns

Type	Description
\Zend_Cloud_QueueService_Message[]

createQueue(string $name, array $options = null) : string

Create a queue.

Returns the ID of the created queue (typically the URL). It may take some time to create the queue. Check your vendor's documentation for details.

Parameters

Name	Type	Description
$name	string
$options	array

Returns

Type	Description
string	Queue ID (typically URL)

deleteMessage(string $queueId, \Zend_Cloud_QueueService_Message $message, array $options = null) : void

Delete the specified message from the specified queue.

Parameters

Name	Type	Description
$queueId	string
$message	\Zend_Cloud_QueueService_Message	Message ID or message
$options	array

deleteQueue(string $queueId, array $options = null) : boolean

Delete a queue.

All messages in the queue will also be deleted.

Parameters

Name	Type	Description
$queueId	string
$options	array

Returns

Type	Description
boolean	true if successful, false otherwise

fetchQueueMetadata(string $queueId, array $options = null) : array

Get a key/value array of metadata for the given queue.

Parameters

Name	Type	Description
$queueId	string
$options	array

Returns

Type	Description
array

getClient() : \Zend_Queue

Get Azure implementation

Returns

Type	Description
\Zend_Queue

getMessageClass() : string

inherited

Get class to use for message objects

Inherited from: \Zend_Cloud_QueueService_Adapter_AbstractAdapter::getMessageClass()

Returns

Type	Description
string

getMessageSetClass() : string

inherited

Get class to use for message collection objects

Inherited from: \Zend_Cloud_QueueService_Adapter_AbstractAdapter::getMessageSetClass()

Returns

Type	Description
string

listQueues(array $options = null) : array

List all queues.

Parameters

Name	Type	Description
$options	array

Returns

Type	Description
array	Queue IDs

peekMessages(string $queueId, int $num = 1, array $options = null) : \Zend_Cloud_QueueService_Message[]

Peek at the messages from the specified queue without removing them.

Parameters

Name	Type	Description
$queueId	string
$num	int	How many messages
$options	array

Returns

Type	Description
\Zend_Cloud_QueueService_Message[]

receiveMessages(string $queueId, int $max = 1, array $options = null) : array

Recieve at most $max messages from the specified queue and return the message IDs for messages recieved.

Parameters

Name	Type	Description
$queueId	string
$max	int
$options	array

Returns

Type	Description
array

sendMessage(string $queueId, string $message, array $options = null) : string

Send a message to the specified queue.

Parameters

Name	Type	Description
$queueId	string
$message	string
$options	array

Returns

Type	Description
string	Message ID

setMessageClass(string $class) : \Zend_Cloud_QueueService_Adapter_AbstractAdapter

inherited

Set class to use for message objects

Inherited from: \Zend_Cloud_QueueService_Adapter_AbstractAdapter::setMessageClass()

Parameters

Name	Type	Description
$class	string

Returns

Type	Description
\Zend_Cloud_QueueService_Adapter_AbstractAdapter

setMessageSetClass(string $class) : \Zend_Cloud_QueueService_Adapter_AbstractAdapter

inherited

Set class to use for message collection objects

Inherited from: \Zend_Cloud_QueueService_Adapter_AbstractAdapter::setMessageSetClass()

Parameters

Name	Type	Description
$class	string

Returns

Type	Description
\Zend_Cloud_QueueService_Adapter_AbstractAdapter

storeQueueMetadata(string $queueId, array $metadata, array $options = null) : void

Store a key/value array of metadata for the specified queue.

WARNING: This operation overwrites any metadata that is located at $destinationPath. Some adapters may not support this method.

Parameters

Name	Type	Description
$queueId	string
$metadata	array
$options	array

Cloud/QueueService/Adapter/ZendQueue.php

\Zend_Cloud_QueueService_Adapter_ZendQueuejump to top

Constants

Properties

Methods

\Zend_Cloud_QueueService_Adapter_ZendQueue
jump to top