php-doc-en/reference/amqp/constants.xml
Pieter de Zwart 76909071ad Initial commit of AMQP documentation after preliminary approval from PHP Doc list.
Part 1 of 2 part commit. Associated commit is of doc-base.


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@300253 c90b9560-bf6c-de11-be94-00142212c4b1
2010-06-07 06:56:48 +00:00

217 lines
6.3 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<appendix xml:id="amqp.constants" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.constants;
&extension.constants;
<para>
<variablelist>
<varlistentry>
<term>
<constant>AMQP_DURABLE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Durable exchanges and queues will survive a broker restart, complete with all of their data.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>AMQP_PASSIVE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Passive exchanges are queues will not be redeclared, but the broker will throw an error if the exchange or queue does not exist.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>AMQP_EXCLUSIVE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Valid for queues only, this flag indicates that only one client can be listening to and consuming from this queue.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>AMQP_AUTODELETE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
For exchanges, the auto delete flag indicates that the exchange will be deleted as soon as no more queues are bound to it.
If no queues were ever bound the exchange, the exchange will never be deleted.
</simpara>
<simpara>
For queues, the auto delete flag indicates that the queue will be deleted as soon as there are no more listeners subscribed to it.
If no subscription has ever been active, the queue will never be deleted.
</simpara>
<simpara>
Note: Exclusive queues will always be automatically deleted with the client disconnects.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>AMQP_INTERNAL</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Clients are not allowed to make specific queue bindings to exchanges defined with this flag.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>AMQP_NOLOCAL</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
When passed to the consume method for a clustered environment, do not consume from the local node.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>AMQP_NOACK</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
When passed to the consumer method, the messages will not be marked as delivered.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>AMQP_IFEMPTY</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Passed on queue creation, this flag indicates that the queue should be deleted if it becomes empty.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>AMQP_IFUNUSED</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Passed on queue or exchange creation, this flag indicates that the queue or exchange should be deleted when no clients are connected
to the given queue or exchange.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>AMQP_MANDATORY</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
When publishing a message, the message must be routed to a valid queue. If it is not, an error will be returned.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>AMQP_IMMEDIATE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
When publishing a message, mark this message for immediate processing by the broker. (High priority message.)
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>AMQP_MULTIPLE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
?
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>AMQP_EX_TYPE_DIRECT</constant>
(<type>string</type>)
</term>
<listitem>
<simpara>
A direct exchange type.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>AMQP_EX_TYPE_FANOUT</constant>
(<type>string</type>)
</term>
<listitem>
<simpara>
A fanout exchange type.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>AMQP_EX_TYPE_TOPIC</constant>
(<type>string</type>)
</term>
<listitem>
<simpara>
A topic exchange type.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>AMQP_EX_TYPE_HEADER</constant>
(<type>string</type>)
</term>
<listitem>
<simpara>
A header exchange type.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
</appendix>
<!-- 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
-->