You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/modules/Queue.md
+21-27Lines changed: 21 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -101,13 +101,6 @@ service.
101
101
102
102
103
103
104
-
105
-
106
-
107
-
108
-
109
-
110
-
111
104
112
105
113
106
@@ -123,13 +116,13 @@ Add a message to a queue/tube
123
116
{% highlight php %}
124
117
125
118
<?php
126
-
$I->addMessageToQueue('this is a messages', 'default');
119
+
$I->addMessageToQueue('this is a messages', 'default');
127
120
?>
128
121
129
122
{% endhighlight %}
130
123
131
124
*`param string` $message Message Body
132
-
*`param string` $queue Queue Name
125
+
*`param string` $queue Queue Name
133
126
134
127
135
128
@@ -159,7 +152,7 @@ Clear all messages of the queue/tube
159
152
{% highlight php %}
160
153
161
154
<?php
162
-
$I->clearQueue('default');
155
+
$I->clearQueue('default');
163
156
?>
164
157
165
158
{% endhighlight %}
@@ -169,14 +162,15 @@ Clear all messages of the queue/tube
169
162
170
163
171
164
165
+
172
166
#### dontSeeEmptyQueue
173
167
174
168
Check if a queue/tube is NOT empty of all messages
175
169
176
170
{% highlight php %}
177
171
178
172
<?php
179
-
$I->dontSeeEmptyQueue('default');
173
+
$I->dontSeeEmptyQueue('default');
180
174
?>
181
175
182
176
{% endhighlight %}
@@ -191,7 +185,7 @@ Check if a queue/tube does NOT exist on the queueing server.
191
185
{% highlight php %}
192
186
193
187
<?php
194
-
$I->dontSeeQueueExists('default');
188
+
$I->dontSeeQueueExists('default');
195
189
?>
196
190
197
191
{% endhighlight %}
@@ -206,13 +200,13 @@ Check if a queue/tube does NOT have a given current number of messages
206
200
{% highlight php %}
207
201
208
202
<?php
209
-
$I->dontSeeQueueHasCurrentCount('default', 10);
203
+
$I->dontSeeQueueHasCurrentCount('default', 10);
210
204
?>
211
205
212
206
{% endhighlight %}
213
207
214
-
*`param string` $queue Queue Name
215
-
*`param int`$expected Number of messages expected
208
+
*`param string` $queue Queue Name
209
+
*`param int` $expected Number of messages expected
216
210
217
211
218
212
#### dontSeeQueueHasTotalCount
@@ -222,13 +216,13 @@ Check if a queue/tube does NOT have a given total number of messages
222
216
{% highlight php %}
223
217
224
218
<?php
225
-
$I->dontSeeQueueHasTotalCount('default', 10);
219
+
$I->dontSeeQueueHasTotalCount('default', 10);
226
220
?>
227
221
228
222
{% endhighlight %}
229
223
230
-
*`param string` $queue Queue Name
231
-
*`param int`$expected Number of messages expected
224
+
*`param string` $queue Queue Name
225
+
*`param int` $expected Number of messages expected
232
226
233
227
234
228
@@ -274,7 +268,7 @@ Grabber method to get the list of queues/tubes on the server
274
268
{% highlight php %}
275
269
276
270
<?php
277
-
$I->grabQueues();
271
+
$queues = $I->grabQueues();
278
272
?>
279
273
280
274
{% endhighlight %}
@@ -292,7 +286,7 @@ Check if a queue/tube is empty of all messages
292
286
{% highlight php %}
293
287
294
288
<?php
295
-
$I->seeEmptyQueue('default');
289
+
$I->seeEmptyQueue('default');
296
290
?>
297
291
298
292
{% endhighlight %}
@@ -307,7 +301,7 @@ Check if a queue/tube exists on the queueing server.
307
301
{% highlight php %}
308
302
309
303
<?php
310
-
$I->seeQueueExists('default');
304
+
$I->seeQueueExists('default');
311
305
?>
312
306
313
307
{% endhighlight %}
@@ -322,13 +316,13 @@ Check if a queue/tube has a given current number of messages
322
316
{% highlight php %}
323
317
324
318
<?php
325
-
$I->seeQueueHasCurrentCount('default', 10);
319
+
$I->seeQueueHasCurrentCount('default', 10);
326
320
?>
327
321
328
322
{% endhighlight %}
329
323
330
-
*`param string` $queue Queue Name
331
-
*`param int`$expected Number of messages expected
324
+
*`param string` $queue Queue Name
325
+
*`param int` $expected Number of messages expected
332
326
333
327
334
328
#### seeQueueHasTotalCount
@@ -338,12 +332,12 @@ Check if a queue/tube has a given total number of messages
338
332
{% highlight php %}
339
333
340
334
<?php
341
-
$I->seeQueueHasTotalCount('default', 10);
335
+
$I->seeQueueHasTotalCount('default', 10);
342
336
?>
343
337
344
338
{% endhighlight %}
345
339
346
-
*`param string` $queue Queue Name
347
-
*`param int`$expected Number of messages expected
340
+
*`param string` $queue Queue Name
341
+
*`param int` $expected Number of messages expected
348
342
349
343
<p> </p><divclass="alert alert-warning">Module reference is taken from the source code. <ahref="https://github.com/Codeception/Codeception/tree/2.0/src/Codeception/Module/Queue.php">Help us to improve documentation. Edit module reference</a></div>
0 commit comments