php-doc-en/reference/amqp/amqpqueue/get.xml
Jakub Vrana 5b4bd92b04 Fix protos
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@308218 c90b9560-bf6c-de11-be94-00142212c4b1
2011-02-10 19:39:11 +00:00

72 lines
2.1 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpqueue.get" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPQueue::get</refname>
<refpurpose>Retrieve the next message from the queue.</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>array</type><methodname>AMQPQueue::get</methodname>
<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.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<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="returnvalues">
&reftitle.returnvalues;
<para>
Returns array possibly containing keys <literal>routing_key</literal>,
<literal>exchange</literal>, <literal>delivery_tag</literal>,
<literal>Content-type</literal>, <literal>Content-encoding</literal>,
<literal>type</literal>, <literal>timestamp</literal>,
<literal>priority</literal>, <literal>expiration</literal>,
<literal>user_id</literal>, <literal>app_id</literal>,
<literal>message_id</literal>, <literal>Reply-to</literal>,
<literal>count</literal>, <literal>msg</literal>.
</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
-->