Queue/Adapter/Memcacheq.php
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 license@zend.com 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
Package: Zend\Queue\AdapterClass 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'
Properties
Methods



__construct(array | \Zend_Config $options, null | \Zend_Queue $queue = null) : void
$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
ParametersThrows


_sendCommand(string $command, array $terminator, boolean $include_term = false) : array
sends 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.
ParametersName | Type | Description |
---|
$command | string |
- command to send to memcacheQ
|
---|
$terminator | array |
- strings to indicate end of memcacheQ response
|
---|
$include_term | boolean |
- include terminator in response
|
---|
ReturnsThrows


create(string $name, integer $timeout = null) : boolean
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.
ParametersName | Type | Description |
---|
$name | string | queue name |
---|
$timeout | integer | default visibility timeout |
---|
ReturnsThrows


delete(string $name) : boolean
Delete a queue and all of it's messages
Returns false if the queue is not found, true if the queue exists
ParametersName | Type | Description |
---|
$name | string | queue name |
---|
ReturnsThrows


deleteMessage(\Zend_Queue_Message $message) : boolean
Delete a message from the queue
Returns true if the message is deleted, false if the deletion is
unsuccessful.
ParametersReturnsThrows


getCapabilities() : array
Return a list of queue capabilities functions
$array['function name'] = true or false
true is supported, false is not supported.
Returns


getQueues() : array
Get an array of all available queues
Not all adapters support getQueues(), use isSupported('getQueues')
to determine if the adapter supports this feature.
ReturnsThrows


isExists(string $name) : boolean
Does 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.
ParametersName | Type | Description |
---|
$name | string | |
---|
ReturnsThrows


receive(integer $maxMessages = null, integer $timeout = null, \Zend_Queue $queue = null) : \Zend_Queue_Message_Iterator
Get messages in the queue
ParametersName | Type | Description |
---|
$maxMessages | integer | Maximum number of messages to return |
---|
$timeout | integer | Visibility timeout for these messages |
---|
$queue | \Zend_Queue | |
---|
ReturnsThrows 


send(string $message, \Zend_Queue $queue = null) : \Zend_Queue_Message
Send a message to the queue
ParametersName | Type | Description |
---|
$message | string | Message to send to the active queue |
---|
$queue | \Zend_Queue | |
---|
ReturnsThrows