svn: /phpdoc/en/trunk/reference/amqp/amqpqueue/ consume.xml get.xml
| From: | Pieter de Zwart | Date: | Fri, 20 May 2011 18:07:34 +0000 |
| Subject: | svn: /phpdoc/en/trunk/reference/amqp/amqpqueue/ consume.xml get.xml | ||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-8163@lists.php.net to get a copy of this message | ||
pdezwart Fri, 20 May 2011 18:07:34 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=311298
Log:
Updating AMQP docs - Better function descriptions for:
AMQP_Queue - consume
AMQP_Queue - get
Changed paths:
U phpdoc/en/trunk/reference/amqp/amqpqueue/consume.xml
U phpdoc/en/trunk/reference/amqp/amqpqueue/get.xml
Modified: phpdoc/en/trunk/reference/amqp/amqpqueue/consume.xml
===================================================================
--- phpdoc/en/trunk/reference/amqp/amqpqueue/consume.xml 2011-05-20 14:11:27 UTC (rev 311297)
+++ phpdoc/en/trunk/reference/amqp/amqpqueue/consume.xml 2011-05-20 18:07:34 UTC (rev 311298)
@@ -14,11 +14,9 @@
<methodparam
choice="opt"><type>array</type><parameter>options</parameter><initializer>array()</initializer></methodparam>
</methodsynopsis>
<para>
-
+ This is a blocking function, in that the function will not return until the minimum number of
of messages as specified by the <parameter>min</parameter> are read off of the queue.
+ To use a non-blocking function, see
</para>
-
- &warn.undocumented.func;
-
</refsect1>
<refsect1 role="parameters">
Modified: phpdoc/en/trunk/reference/amqp/amqpqueue/get.xml
===================================================================
--- phpdoc/en/trunk/reference/amqp/amqpqueue/get.xml 2011-05-20 14:11:27 UTC (rev 311297)
+++ phpdoc/en/trunk/reference/amqp/amqpqueue/get.xml 2011-05-20 18:07:34 UTC (rev 311298)
@@ -14,7 +14,7 @@
<methodparam
choice="opt"><type>int</type><parameter>flags</parameter><initializer><constant>AMQP_NOACK</constant></initializer></methodparam>
</methodsynopsis>
<para>
- Retrieve the next message from the queue.
+ Retrieve the next message from the queue. This is a non-blocking operation, which means that if
there is no message on the queue, the function will return immediately with no message.
</para>
</refsect1>