mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 14:28:56 +00:00
5faa7a6747
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@324122 c90b9560-bf6c-de11-be94-00142212c4b1
127 lines
3.5 KiB
XML
127 lines
3.5 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<refentry xml:id="amqpqueue.consume" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>AMQPQueue::consume</refname>
|
|
<refpurpose>Consume messages from a queue</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<modifier>public</modifier> <type>void</type><methodname>AMQPQueue::consume</methodname>
|
|
<methodparam><type>callable</type><parameter>callback</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer><constant>AMQP_NOPARAM</constant></initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Blocking function that will retrieve the next message from the queue as it becomes available and will pass it off to the callback.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>callback</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
A callback function to which the consumed message will be passed. The function must accept at a minimum one parameter, an <classname>AMQPEnvelope</classname> object,
|
|
and an optional second parameter the <classname>AMQPQueue</classname> from which the message was consumed.
|
|
</para>
|
|
<para>
|
|
The <methodname>AMQPQueue::consume</methodname> will not return the processing thread back to the PHP script until the callback function returns &false;.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>flags</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
A bitmask of any of the flags: <constant>AMQP_NOACK</constant>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="errors">
|
|
&reftitle.errors;
|
|
<para>
|
|
Throws <classname>AMQPChannelException</classname> if the channel is not open.
|
|
</para>
|
|
<para>
|
|
Throws <classname>AMQPConnectionException</classname> if the connection to the broker was lost.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><methodname>AMQPQueue::consume</methodname> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
|
|
/* Create a connection using all default credentials: */
|
|
$connection = new AMQPConnection();
|
|
$connection->connect();
|
|
|
|
$channel = new AMQPChannel($connection);
|
|
|
|
/* create a queue object */
|
|
$queue = new AMQPQueue($channel);
|
|
|
|
//declare the queue
|
|
$queue->declare('myqueue');
|
|
|
|
$i = 0;
|
|
function processMessage($envelope, $queue) {
|
|
global $i;
|
|
echo "Message $i: " . $envelope->getBody() . "\n";
|
|
$i++;
|
|
if ($i > 10) {
|
|
// Bail after 10 messages
|
|
return false;
|
|
}
|
|
}
|
|
|
|
// Consume messages on queue
|
|
$queue->consume("processMessage");
|
|
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
</refentry>
|
|
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|