Queue/Adapter/PlatformJobQueue.php
Show:
inherited
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-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Queue
- Subpackage
- Adapter
- Version
- $Id$
\Zend_Queue_Adapter_PlatformJobQueue
Package: Zend_Queue\Adapter
Returns
Throws
Zend Platform JobQueue adapter
- Parent(s)
- \Zend_Queue_Adapter_AdapterAbstract
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
Methods
__construct(array | \Zend_Config $options, \Zend_Queue | null $queue = null) : voidConstructor
Parameters
| Name | Type | Description |
|---|---|---|
| $options | array | \Zend_Config | |
| $queue | \Zend_Queue | null |
__sleep() : arraySerialize
Returns
| Type | Description |
|---|---|
| array |
__wakeup() : voidUnserialize
count(\Zend_Queue | null $queue = null) : integerReturn the approximate number of messages in the queue
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $queue | \Zend_Queue | null |
| Type | Description |
|---|---|
| integer |
create(string $name, integer $timeout = null) : voidCreate a new queue
Parameters
Throws
| Name | Type | Description |
|---|---|---|
| $name | string | queue name |
| $timeout | integer | default visibility timeout |
| Exception | Description |
|---|---|
| \Zend_Queue_Exception |
delete(string $name) : voidDelete a queue and all of its messages
Parameters
Throws
| Name | Type | Description |
|---|---|---|
| $name | string | queue name |
| 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.
Parameters| Name | Type | Description |
|---|---|---|
| $message | \Zend_Queue_Message |
| Type | Description |
|---|---|
| boolean |
| Exception | Description |
|---|---|
| \Zend_Queue_Exception |
getCapabilities() : arrayReturn a list of queue capabilities functions
$array['function name'] = true or false
true is supported, false is not supported.
Returns| Type | Description |
|---|---|
| array |
getQueues() : voidGet an array of all available queues
Throws
| Exception | Description |
|---|---|
| \Zend_Queue_Exception |
isExists(string $name) : booleanDoes a queue already exist?
Parameters
Returns
Throws
| Name | Type | Description |
|---|---|---|
| $name | string |
| Type | Description |
|---|---|
| boolean |
| Exception | Description |
|---|---|
| \Zend_Queue_Exception | (not supported) |
isJobIdExist( $id) : voidParameters
| Name | Type | Description |
|---|---|---|
| $id |
receive(integer $maxMessages = null, integer $timeout = null, \Zend_Queue $queue = null) : \ArrayIteratorGet messages in the queue
Parameters
Returns
Throws
| Name | Type | Description |
|---|---|---|
| $maxMessages | integer | Maximum number of messages to return |
| $timeout | integer | Ignored |
| $queue | \Zend_Queue | Not supported |
| Type | Description |
|---|---|
| \ArrayIterator |
| Exception | Description |
|---|---|
| \Zend_Queue_Exception |
send( $message, \Zend_Queue $queue = null) : \Zend_Queue_MessageSend a message to the queue
Parameters
Returns
Throws
| Name | Type | Description |
|---|---|---|
| $message | ||
| $queue | \Zend_Queue | Not supported |
| Type | Description |
|---|---|
| \Zend_Queue_Message |
| Exception | Description |
|---|---|
| \Zend_Queue_Exception |