Queue/Adapter/Memcacheq.php
inherited
Classes
Zend Framework
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_Queue
- Subpackage
- Adapter
- Version
- $Id: Memcacheq.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Queue_Adapter_Memcacheq
Class for using connecting to a Zend_Cache-based queuing system
- Parent(s)
- \Zend_Queue_Adapter_AdapterAbstract
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Constants
DEFAULT_HOST
= '127.0.0.1'
DEFAULT_PORT
= 22201
EOL
= "\r\n"
CREATE_TIMEOUT_DEFAULT
= 30Default timeout for createQueue() function
Inherited from: \Zend_Queue_Adapter_AdapterAbstract::CREATE_TIMEOUT_DEFAULT- Inherited_from
- \Zend_Queue_Adapter_AdapterAbstract::CREATE_TIMEOUT_DEFAULT
RECEIVE_TIMEOUT_DEFAULT
= 30Default timeout for recieve() function
Inherited from: \Zend_Queue_Adapter_AdapterAbstract::RECEIVE_TIMEOUT_DEFAULT- Inherited_from
- \Zend_Queue_Adapter_AdapterAbstract::RECEIVE_TIMEOUT_DEFAULT
Properties
\Memcache $_cache = nullnullDetails- Type
- \Memcache
string $_host = nullnullDetails- Type
- string
array $_options = array()
array()Details- Type
- array
- Inherited_from
- \Zend_Queue_Adapter_AdapterAbstract::$$_options
integer $_port = nullnullDetails- Type
- integer
\Zend_Queue_Adapter_Abstract $_queue = nullContains the Zend_Queue that this object
Inherited from: \Zend_Queue_Adapter_AdapterAbstract::$$_queuenullDetails- Type
- \Zend_Queue_Adapter_Abstract
- Inherited_from
- \Zend_Queue_Adapter_AdapterAbstract::$$_queue
array $_queues = array()Internal array of queues to save on lookups
Inherited from: \Zend_Queue_Adapter_AdapterAbstract::$$_queuesarray()Details- Type
- array
- Inherited_from
- \Zend_Queue_Adapter_AdapterAbstract::$$_queues
resource $_socket = nullnullDetails- Type
- resource
Methods
__construct(array | \Zend_Config $options, null | \Zend_Queue $queue = null) : voidConstructor
$options is an array of key/value pairs or an instance of Zend_Config containing configuration options. These options are common to most adapters:
See the Zend_Queue Adapter Notes documentation for example configurations.
Some options are used on a case-by-case basis by adapters:
access_key => (string) Amazon AWS Access Key secret_key => (string) Amazon AWS Secret Key dbname => (string) The name of the database to user username => (string) Connect to the database as this username. password => (string) Password associated with the username. host => (string) What host to connect to, defaults to localhost port => (string) The port of the database
| Name | Type | Description |
|---|---|---|
| $options | array | \Zend_Config | |
| $queue | null | \Zend_Queue |
| Exception | Description |
|---|---|
| \Zend_Queue_Exception |
__destruct() : voidDestructor
_sendCommand(string $command, array $terminator, boolean $include_term = false) : arraysends a command to MemcacheQ
The memcache functions by php cannot handle all types of requests supported by MemcacheQ Non-standard requests are handled by this function.
| Name | Type | Description |
|---|---|---|
| $command | string |
|
| $terminator | array |
|
| $include_term | boolean |
|
| Type | Description |
|---|---|
| array |
| Exception | Description |
|---|---|
| \Zend_Queue_Exception | if connection cannot be opened |
count(\Zend_Queue $queue = null) : integerReturn the approximate number of messages in the queue
| Name | Type | Description |
|---|---|---|
| $queue | \Zend_Queue |
| Type | Description |
|---|---|
| integer |
| Exception | Description |
|---|---|
| \Zend_Queue_Exception | (not supported) |
create(string $name, integer $timeout = null) : booleanCreate a new queue
Visibility timeout is how long a message is left in the queue "invisible" to other readers. If the message is acknowleged (deleted) before the timeout, then the message is deleted. However, if the timeout expires then the message will be made available to other queue readers.
| Name | Type | Description |
|---|---|---|
| $name | string | queue name |
| $timeout | integer | default visibility timeout |
| Type | Description |
|---|---|
| boolean |
| Exception | Description |
|---|---|
| \Zend_Queue_Exception |
delete(string $name) : booleanDelete a queue and all of it's messages
Returns false if the queue is not found, true if the queue exists
| Name | Type | Description |
|---|---|---|
| $name | string | queue name |
| Type | Description |
|---|---|
| boolean |
| Exception | Description |
|---|---|
| \Zend_Queue_Exception |
deleteMessage(\Zend_Queue_Message $message) : booleanDelete a message from the queue
Returns true if the message is deleted, false if the deletion is unsuccessful.
| Name | Type | Description |
|---|---|---|
| $message | \Zend_Queue_Message |
| Type | Description |
|---|---|
| boolean |
| Exception | Description |
|---|---|
| \Zend_Queue_Exception | (unsupported) |
getCapabilities() : arrayReturn a list of queue capabilities functions
$array['function name'] = true or false true is supported, false is not supported.
| Type | Description |
|---|---|
| array |
getOptions() : arrayReturns the configuration options in this adapter.
Inherited from: \Zend_Queue_Adapter_AdapterAbstract::getOptions()| Type | Description |
|---|---|
| array |
getQueue() : \Zend_Queue | nullget the Zend_Queue class that is attached to this object
Inherited from: \Zend_Queue_Adapter_AdapterAbstract::getQueue()| Type | Description |
|---|---|
| \Zend_Queue | null |
getQueues() : arrayGet an array of all available queues
Not all adapters support getQueues(), use isSupported('getQueues') to determine if the adapter supports this feature.
| Type | Description |
|---|---|
| array |
| Exception | Description |
|---|---|
| \Zend_Queue_Exception |
isExists(string $name) : booleanDoes a queue already exist?
Throws an exception if the adapter cannot determine if a queue exists. use isSupported('isExists') to determine if an adapter can test for queue existance.
| Name | Type | Description |
|---|---|---|
| $name | string |
| Type | Description |
|---|---|
| boolean |
| Exception | Description |
|---|---|
| \Zend_Queue_Exception |
isSupported(string $name) : booleanIndicates if a function is supported or not.
Inherited from: \Zend_Queue_Adapter_AdapterAbstract::isSupported()| Name | Type | Description |
|---|---|---|
| $name | string |
| Type | Description |
|---|---|
| boolean |
receive(integer $maxMessages = null, integer $timeout = null, \Zend_Queue $queue = null) : \Zend_Queue_Message_IteratorGet messages in the queue
| Name | Type | Description |
|---|---|---|
| $maxMessages | integer | Maximum number of messages to return |
| $timeout | integer | Visibility timeout for these messages |
| $queue | \Zend_Queue |
| Type | Description |
|---|---|
| \Zend_Queue_Message_Iterator |
| Exception | Description |
|---|---|
| \Zend_Queue_Exception |
send(string $message, \Zend_Queue $queue = null) : \Zend_Queue_MessageSend a message to the queue
| Name | Type | Description |
|---|---|---|
| $message | string | Message to send to the active queue |
| $queue | \Zend_Queue |
| Type | Description |
|---|---|
| \Zend_Queue_Message |
| Exception | Description |
|---|---|
| \Zend_Queue_Exception |
setQueue(\Zend_Queue $queue) : \Zend_Queue_Adapter_AdapterInterfaceset the Zend_Queue class for this object
Inherited from: \Zend_Queue_Adapter_AdapterAbstract::setQueue()| Name | Type | Description |
|---|---|---|
| $queue | \Zend_Queue |
| Type | Description |
|---|---|
| \Zend_Queue_Adapter_AdapterInterface |