Queue/Adapter/Null.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 license@zend.com 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_Null
Package: Zend_Queue\Adapter
Class testing. No supported functions. Also used to disable a Zend_Queue.
- 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
Methods
__construct(array | \Zend_Config $options, null | \Zend_Queue $queue = null) : voidConstructor
Parameters
| Name | Type | Description |
|---|---|---|
| $options | array | \Zend_Config | |
| $queue | null | \Zend_Queue |
count( $queue = null) : voidReturn the approximate number of messages in the queue
Parameters
Throws
| Name | Type | Description |
|---|---|---|
| $queue |
| Exception | Description |
|---|---|
| \Zend_Queue_Exception | - not supported. |
create( $name, $timeout = null) : voidCreate a new queue
Parameters
Throws
| Name | Type | Description |
|---|---|---|
| $name | ||
| $timeout |
| Exception | Description |
|---|---|
| \Zend_Queue_Exception | - not supported. |
delete( $name) : voidDelete a queue and all of it's messages
Parameters
Throws
| Name | Type | Description |
|---|---|---|
| $name |
| Exception | Description |
|---|---|
| \Zend_Queue_Exception | - not supported. |
deleteMessage( $message) : voidDelete a message from the queue
Parameters
Throws
| Name | Type | Description |
|---|---|---|
| $message |
| Exception | Description |
|---|---|
| \Zend_Queue_Exception | - not supported. |
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 | - not supported. |
isExists( $name) : voidDoes a queue already exist?
Parameters
Throws
| Name | Type | Description |
|---|---|---|
| $name |
| Exception | Description |
|---|---|
| \Zend_Queue_Exception | - not supported. |
receive( $maxMessages = null, $timeout = null, $queue = null) : voidGet messages in the queue
Parameters
Throws
| Name | Type | Description |
|---|---|---|
| $maxMessages | ||
| $timeout | ||
| $queue |
| Exception | Description |
|---|---|
| \Zend_Queue_Exception | - not supported. |
send( $message, $queue = null) : voidSend a message to the queue
Parameters
Throws
| Name | Type | Description |
|---|---|---|
| $message | ||
| $queue |
| Exception | Description |
|---|---|
| \Zend_Queue_Exception | - not supported. |