Queue.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-2011 Zend Technologies USA Inc. (http://www.zend.com)
- license
-
New BSD License
- package
- Zend_Queue
- version
- $Id: Queue.php 23953 2011-05-03 05:47:39Z ralph $
Class for connecting to queues performing common operations.
- Implements
- category
- Zend
- copyright
- Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
- license
-
New BSD License
- package
- Zend_Queue
Constants
Properties



string
$_messageSetClass= 'Zend_Queue_Message_Iterator'
Zend_Queue_Message_Iterator class
Default valueZend_Queue_Message_Iterator
Details
- Type
- string



array
$_options= 'array'
User-provided configuration
Default valuearray
Details
- Type
- array
Methods



_setName(
string $name
)
:
\Zend_Queue|false
Set the name of the queue
This is AN UNSUPPORTED FUNCTION
Parameters
Name |
Type |
Description |
$name |
string |
|
Returns
Type |
Description |
\Zend_Queuefalse |
Provides a fluent interface |



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.
Returns true if the adapter doesn't support message deletion.
Parameters
Returns
Throws



deleteQueue(
)
:
boolean
Delete the queue this object is working on.
This queue is disabled, regardless of the outcome of the deletion
of the queue, because the programmers intent is to disable this queue.
Returns



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



getName(
)
:
string
Get the name of the queue
Note: _setName() used to exist, but it caused confusion with createQueue
Will evaluate later to see if we should add it back in.
Returns



hasOption(
string $name
)
:
bool
Determine if a requested option has been defined
Parameters
Name |
Type |
Description |
$name |
string |
|
Returns



isSupported(
string $name
)
:
boolean
Indicates if a function is supported or not.
Parameters
Name |
Type |
Description |
$name |
string |
|
Returns



receive(
integer $maxMessages
=
null, integer $timeout
=
null
)
:
\Zend_Queue_Message_Iterator
Return the first element in the queue
Parameters
Name |
Type |
Description |
$maxMessages |
integer |
|
$timeout |
integer |
|
Returns



send(
mixed $message
)
:
\Zend_Queue_Message
Send a message to the queue
Parameters
Name |
Type |
Description |
$message |
mixed |
message |
Returns
Throws



setOption(
string $name, mixed $value
)
:
\Zend_Queue
Set an individual configuration option
Parameters
Name |
Type |
Description |
$name |
string |
|
$value |
mixed |
|
Returns