Cloud/QueueService/Adapter/AbstractAdapter.php

Show:

inherited

Classes
- \Zend_Cloud_QueueService_Adapter_AbstractAdapter

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_AbstractAdapter
jump to top

Package: Zend\Cloud\QueueService

Abstract queue adapter

Provides functionality around setting message and message set classes.

Implements: \Zend_Cloud_QueueService_Adapter
Children: \Zend_Cloud_QueueService_Adapter_WindowsAzure; \Zend_Cloud_QueueService_Adapter_Sqs; \Zend_Cloud_QueueService_Adapter_ZendQueue
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Constants

 
                MESSAGE_CLASS
                = 'message_class'

 
                MESSAGESET_CLASS
                = 'messageset_class'

 
                HTTP_ADAPTER
                = 'http_adapter'

inherited

Ctor HTTP adapter option

Inherited from: \Zend_Cloud_QueueService_Adapter::HTTP_ADAPTER

Inherited_from: \Zend_Cloud_QueueService_Adapter::HTTP_ADAPTER

 
                VISIBILITY_TIMEOUT
                = 'visibility_timeout'

inherited

Message visibility timeout option

Inherited from: \Zend_Cloud_QueueService_Adapter::VISIBILITY_TIMEOUT

Inherited_from: \Zend_Cloud_QueueService_Adapter::VISIBILITY_TIMEOUT

 
                DEFAULT_TIMEOUT
                = 30

inherited

Default visibility timeout

Inherited from: \Zend_Cloud_QueueService_Adapter::DEFAULT_TIMEOUT

Inherited_from: \Zend_Cloud_QueueService_Adapter::DEFAULT_TIMEOUT

Properties

string $_messageClass = 'Zend_Cloud_QueueService_Message'

<p>Class to use for queue messages</p>

Default value'Zend_Cloud_QueueService_Message'Details

Type: string

string $_messageSetClass = 'Zend_Cloud_QueueService_MessageSet'

<p>Class to use for collections of queue messages</p>

Default value'Zend_Cloud_QueueService_MessageSet'Details

Type: string

Methods

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

inherited

Create a queue.

Inherited from: \Zend_Cloud_QueueService_Adapter::createQueue()

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.

Name constraints: Maximum 80 characters Only alphanumeric characters, hyphens (-), and underscores (_)

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

inherited

Delete the specified message from the specified queue.

Inherited from: \Zend_Cloud_QueueService_Adapter::deleteMessage()

Parameters

Name	Type	Description
$queueId	string
$message	\Zend_Cloud_QueueService_Message	Message to delete
$options	array

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

inherited

Delete a queue.

Inherited from: \Zend_Cloud_QueueService_Adapter::deleteQueue()

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

inherited

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

Inherited from: \Zend_Cloud_QueueService_Adapter::fetchQueueMetadata()

Parameters

Name	Type	Description
$queueId	string
$options	array

Returns

Type	Description
array

getClient() : void

inherited

Get the concrete adapter.

Inherited from: \Zend_Cloud_QueueService_Adapter::getClient()

getMessageClass() : string

Get class to use for message objects

Returns

Type	Description
string

getMessageSetClass() : string

Get class to use for message collection objects

Returns

Type	Description
string

listQueues(array $options = null) : array

inherited

List all queues.

Inherited from: \Zend_Cloud_QueueService_Adapter::listQueues()

Parameters

Name	Type	Description
$options	array

Returns

Type	Description
array	Queue IDs

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

inherited

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

Inherited from: \Zend_Cloud_QueueService_Adapter::peekMessages()

Parameters

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

Returns

Type	Description
\array[Zend_Cloud_QueueService_Message]

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

inherited

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

Inherited from: \Zend_Cloud_QueueService_Adapter::receiveMessages()

Parameters

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

Returns

Type	Description
\array[Zend_Cloud_QueueService_Message]	Array of messages

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

inherited

Send a message to the specified queue.

Inherited from: \Zend_Cloud_QueueService_Adapter::sendMessage()

Parameters

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

Returns

Type	Description
string	Message ID

setMessageClass(string $class) : \Zend_Cloud_QueueService_Adapter_AbstractAdapter

Set class to use for message objects

Parameters

Name	Type	Description
$class	string

Returns

Type	Description
\Zend_Cloud_QueueService_Adapter_AbstractAdapter

setMessageSetClass(string $class) : \Zend_Cloud_QueueService_Adapter_AbstractAdapter

Set class to use for message collection objects

Parameters

Name	Type	Description
$class	string

Returns

Type	Description
\Zend_Cloud_QueueService_Adapter_AbstractAdapter

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

inherited

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

Inherited from: \Zend_Cloud_QueueService_Adapter::storeQueueMetadata()

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/AbstractAdapter.php

\Zend_Cloud_QueueService_Adapter_AbstractAdapterjump to top

Constants

Properties

Methods

\Zend_Cloud_QueueService_Adapter_AbstractAdapter
jump to top