1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
|
<?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
* @package Zend_Queue
* @subpackage Adapter
* @copyright Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
* @version $Id: AdapterInterface.php 20096 2010-01-06 02:05:09Z bkarwin $
*/
/**
* Interface for common queue operations
*
* @category Zend
* @package Zend_Queue
* @subpackage Adapter
* @copyright Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
interface Zend_Queue_Adapter_AdapterInterface
{
/**
* Constructor
*
* @param array|Zend_Config $options
* @param Zend_Queue $queue
* @return void
*/
public function __construct($options, Zend_Queue $queue = null);
/**
* Retrieve queue instance
*
* @return Zend_Queue
*/
public function getQueue();
/**
* Set queue instnace
*
* @param Zend_Queue $queue
* @return Zend_Queue_Adapter_AdapterInterface
*/
public function setQueue(Zend_Queue $queue);
/**
* Does a queue already exist?
*
* Use isSupported('isExists') to determine if an adapter can test for
* queue existance.
*
* @param string $name Queue name
* @return boolean
*/
public function isExists($name);
/**
* Create 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.
*
* @param string $name Queue name
* @param integer $timeout Default visibility timeout
* @return boolean
*/
public function create($name, $timeout=null);
/**
* Delete a queue and all of its messages
*
* Return false if the queue is not found, true if the queue exists.
*
* @param string $name Queue name
* @return boolean
*/
public function delete($name);
/**
* Get an array of all available queues
*
* Not all adapters support getQueues(); use isSupported('getQueues')
* to determine if the adapter supports this feature.
*
* @return array
*/
public function getQueues();
/**
* Return the approximate number of messages in the queue
*
* @param Zend_Queue|null $queue
* @return integer
*/
public function count(Zend_Queue $queue = null);
/********************************************************************
* Messsage management functions
*********************************************************************/
/**
* Send a message to the queue
*
* @param mixed $message Message to send to the active queue
* @param Zend_Queue|null $queue
* @return Zend_Queue_Message
*/
public function send($message, Zend_Queue $queue = null);
/**
* Get messages in the queue
*
* @param integer|null $maxMessages Maximum number of messages to return
* @param integer|null $timeout Visibility timeout for these messages
* @param Zend_Queue|null $queue
* @return Zend_Queue_Message_Iterator
*/
public function receive($maxMessages = null, $timeout = null, Zend_Queue $queue = null);
/**
* Delete a message from the queue
*
* Return true if the message is deleted, false if the deletion is
* unsuccessful.
*
* @param Zend_Queue_Message $message
* @return boolean
*/
public function deleteMessage(Zend_Queue_Message $message);
/********************************************************************
* Supporting functions
*********************************************************************/
/**
* Returns the configuration options in this adapter.
*
* @return array
*/
public function getOptions();
/**
* Return a list of queue capabilities functions
*
* $array['function name'] = true or false
* true is supported, false is not supported.
*
* @return array
*/
public function getCapabilities();
/**
* Indicates if a function is supported or not.
*
* @param string $name Function name
* @return boolean
*/
public function isSupported($name);
}
|
