sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-15 16:38:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updating AMQP Documentation for version 1.0.0

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@323238 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Pieter de Zwart 2012-02-15 21:06:00 +00:00
parent 4a420d557a
commit dc1dcfb27b
79 changed files with 3837 additions and 320 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

67
reference/amqp/amqpchannel.xml Normal file
View file

@ -0,0 +1,67 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<phpdoc:classref xml:id="class.amqpchannel" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The AMQPChannel class</title>
<titleabbrev>AMQPChannel</titleabbrev>
<partintro>
<!-- {{{ AMQPChannel intro -->
<section xml:id="amqpchannel.intro">
&reftitle.intro;
<para>
Represents a channel on an connection. Each connection can have multiple channels.
</para>
</section>
<!-- }}} -->
<section xml:id="amqpchannel.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>AMQPChannel</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>AMQPChannel</classname>
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.amqpchannel')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
</classsynopsis>
<!-- }}} -->
</section>
</partintro>
&reference.amqp.entities.amqpchannel;
</phpdoc:classref>
<!-- 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
-->

65
reference/amqp/amqpchannel/committransaction.xml Normal file
View file

@ -0,0 +1,65 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpchannel.committransaction" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPChannel::commitTransaction</refname>
<refpurpose>Commit a pending transaction</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>AMQPChannel::commitTransaction</methodname>
<void />
</methodsynopsis>
<para>
Commit an existing transaction. <methodname>AMQPChannel::startTransaction</methodname> must be called prior to this.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Throws <classname>AMQPChannelException</classname> exception if no transaction was started prior to calling this method.
</para>
<para>
Throws <classname>AMQPConnectionException</classname> if the connection to the broker was lost.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</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
-->

71
reference/amqp/amqpchannel/construct.xml Normal file
View file

@ -0,0 +1,71 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpchannel.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPChannel::__construct</refname>
<refpurpose>Create an instance of an AMQPQueue object</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<methodname>AMQPChannel::__construct</methodname>
<methodparam><type>AMQPConnection</type><parameter>amqp_connection</parameter></methodparam>
</methodsynopsis>
<para>
Creates an <classname>AMQPChannel</classname> instance representing a channel on the given connection.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>amqp_connection</parameter></term>
<listitem>
<para>
A instance of <classname>AMQPConnection</classname> with an active connection to a broker.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Throws <classname>AMQPConnectionException</classname> if the connection to the broker was lost.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
An instance of <classname>AMQPChannel</classname>.
</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
-->

56
reference/amqp/amqpchannel/isconnected.xml Normal file
View file

@ -0,0 +1,56 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpchannel.isconnected" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPChannel::isConnected</refname>
<refpurpose>Check the channel connection</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>AMQPChannel::isConnected</methodname>
<void />
</methodsynopsis>
<para>
Indicates whether the channel is connected.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</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
-->

86
reference/amqp/amqpchannel/qos.xml Normal file
View file

@ -0,0 +1,86 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpchannel.qos" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPChannel::qos</refname>
<refpurpose>Set the Quality Of Service settings for the given channel</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>AMQPChannel::qos</methodname>
<methodparam><type>int</type><parameter>size</parameter></methodparam>
<methodparam><type>int</type><parameter>count</parameter></methodparam>
</methodsynopsis>
<para>
Specify the amount of data to prefetch in terms of window size (octets) or number of messages from a queue during a <methodname>AMQPQueue::consume</methodname> or <methodname>AMQPQueue::get</methodname> method call. The client will prefetch data up to <parameter>size</parameter> octets or <parameter>count</parameter> messages from the server, whichever limit is hit first.
</para>
<para>
Setting either value to 0 will instruct the client to ignore that particular setting.
</para>
<para>
A call to <methodname>AMQPChannel::qos</methodname> will overwrite any values set by calling <methodname>AMQPChannel::setPrefetchSize</methodname> and <methodname>AMQPChannel::setPrefetchCount</methodname>.
</para>
<para>If the call to either <methodname>AMQPQueue::consume</methodname> or <methodname>AMQPQueue::get</methodname> is done with the <constant>AMQP_AUTOACK</constant> flag set, the client will not do any prefetching of data, regardless of the QOS settings.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>size</parameter></term>
<listitem>
<para>
The window size, in octets, to prefetch.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>count</parameter></term>
<listitem>
<para>
The number of messages to prefetch.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Throws <classname>AMQPConnectionException</classname> if the connection to the broker was lost.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</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
-->

65
reference/amqp/amqpchannel/rollbacktransaction.xml Normal file
View file

@ -0,0 +1,65 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpchannel.rollbacktransaction" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPChannel::rollbackTransaction</refname>
<refpurpose>Rollback a transaction</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>AMQPChannel::rollbackTransaction</methodname>
<void />
</methodsynopsis>
<para>
Rollback an existing transaction. <methodname>AMQPChannel::startTransaction</methodname> must be called prior to this.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Throws <classname>AMQPChannelException</classname> exception if no transaction was started prior to calling this method.
</para>
<para>
Throws <classname>AMQPConnectionException</classname> if the connection to the broker was lost.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</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
-->

75
reference/amqp/amqpchannel/setprefetchcount.xml Normal file
View file

@ -0,0 +1,75 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpchannel.setprefetchcount" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPChannel::setPrefetchCount</refname>
<refpurpose>Set the number of messages to prefetch from the broker</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>AMQPChannel::setPrefetchCount</methodname>
<methodparam><type>int</type><parameter>count</parameter></methodparam>
</methodsynopsis>
<para>
Set the number of messages to prefetch from the broker during a call to <methodname>AMQPQueue::consume</methodname> or <methodname>AMQPQueue::get</methodname>. Any call to this method will automatically set the prefetch window size to 0, meaning that the prefetch window size setting will be ignored.
</para>
<para>
If the call to either <methodname>AMQPQueue::consume</methodname> or <methodname>AMQPQueue::get</methodname> is done with the <constant>AMQP_AUTOACK</constant> flag set, this setting will be ignored.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>count</parameter></term>
<listitem>
<para>
The number of messages to prefetch.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Throws <classname>AMQPConnectionException</classname> if the connection to the broker was lost.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</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
-->

75
reference/amqp/amqpchannel/setprefetchsize.xml Normal file
View file

@ -0,0 +1,75 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpchannel.setprefetchsize" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPChannel::setPrefetchSize</refname>
<refpurpose>Set the window size to prefetch from the broker</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>AMQPChannel::setPrefetchSize</methodname>
<methodparam><type>int</type><parameter>size</parameter></methodparam>
</methodsynopsis>
<para>
Set the prefetch window size, in octets, during a call to <methodname>AMQPQueue::consume</methodname> or <methodname>AMQPQueue::get</methodname>. Any call to this method will automatically set the prefetch message count to 0, meaning that the prefetch message count setting will be ignored.
</para>
<para>
If the call to either <methodname>AMQPQueue::consume</methodname> or <methodname>AMQPQueue::get</methodname> is done with the <constant>AMQP_AUTOACK</constant> flag set, this setting will be ignored.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>size</parameter></term>
<listitem>
<para>
The window size, in octets, to prefetch.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Throws <classname>AMQPConnectionException</classname> if the connection to the broker was lost.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</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
-->

62
reference/amqp/amqpchannel/starttransaction.xml Normal file
View file

@ -0,0 +1,62 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpchannel.starttransaction" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPChannel::startTransaction</refname>
<refpurpose>Start a transaction</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>AMQPChannel::startTransaction</methodname>
<void />
</methodsynopsis>
<para>
Commit an existing transaction. This method must be called on the given channel prior to calling <methodname>AMQPChannel::commitTransaction</methodname> or <methodname>AMQPChannel::rollbackTransaction</methodname>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Throws <classname>AMQPConnectionException</classname> if the connection to the broker was lost.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</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
-->

112
reference/amqp/amqpchannelexception.xml Normal file
View file

@ -0,0 +1,112 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<phpdoc:classref xml:id="class.amqpchannelexception" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The AMQPChannelException class</title>
<titleabbrev>AMQPChannelException</titleabbrev>
<partintro>
<!-- {{{ AMQPChannelException intro -->
<section xml:id="amqpchannelexception.intro">
&reftitle.intro;
<para>
</para>
</section>
<!-- }}} -->
<section xml:id="amqpchannelexception.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>AMQPChannelException</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>AMQPChannelException</classname>
</ooclass>
<ooclass>
<modifier>extends</modifier>
<classname>AMQPException</classname>
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.amqpchannelexception')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
<classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.amqpexception')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
</classsynopsis>
<!-- }}} -->
</section>
<!-- {{{ AMQPChannelException properties -->
<section xml:id="amqpchannelexception.props">
&reftitle.properties;
<variablelist>
<varlistentry xml:id="amqpchannelexception.props.message">
<term><varname>message</varname></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry xml:id="amqpchannelexception.props.code">
<term><varname>code</varname></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry xml:id="amqpchannelexception.props.file">
<term><varname>file</varname></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry xml:id="amqpchannelexception.props.line">
<term><varname>line</varname></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
</partintro>
&reference.amqp.entities.amqpchannelexception;
</phpdoc:classref>
<!-- 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
-->

12
reference/amqp/amqpconnection/construct.xml
View file

@ -41,9 +41,8 @@
</thead>
<tbody>
<row>
<!-- FIXME: WTF? Seriously? 32char max? -->
<entry><emphasis>host</emphasis></entry>
<entry>The host to connect too <note><simpara>Max 32 characters</simpara></note></entry>
<entry>The host to connect too <note><simpara>Max 1024 characters</simpara></note></entry>
<entry><link linkend="ini.amqp.host">amqp.host</link></entry>
</row>
<row>
@ -53,17 +52,17 @@
</row>
<row>
<entry><emphasis>vhost</emphasis></entry>
<entry>The virtual host on the host <note><simpara>Max 32 characters</simpara></note></entry>
<entry>The virtual host on the host <note><simpara>Max 128 characters</simpara></note></entry>
<entry><link linkend="ini.amqp.vhost">amqp.vhost</link></entry>
</row>
<row>
<entry><emphasis>login</emphasis></entry>
<entry>The login name to use. <note><simpara>Max 32 characters</simpara></note></entry>
<entry>The login name to use. <note><simpara>Max 128 characters</simpara></note></entry>
<entry><link linkend="ini.amqp.login">amqp.login</link></entry>
</row>
<row>
<entry><emphasis>password</emphasis></entry>
<entry>Password <note><simpara>Max 32 characters</simpara></note></entry>
<entry>Password <note><simpara>Max 128 characters</simpara></note></entry>
<entry><link linkend="ini.amqp.password">amqp.password</link></entry>
</row>
</tbody>
@ -123,8 +122,7 @@ $connection2 = new AMQPConnection(array(
&reftitle.notes;
<note>
<para>
A connection will not be established untill
<methodname>AMQPConnection::connect</methodname> is called.
A connection will not be established until <methodname>AMQPConnection::connect</methodname> is called.
</para>
</note>
</refsect1>

55
reference/amqp/amqpconnection/gethost.xml Normal file
View file

@ -0,0 +1,55 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpconnection.gethost" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPConnection::getHost</refname>
<refpurpose>Get the configured host</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>AMQPConnection::getHost</methodname>
<void />
</methodsynopsis>
<para>
Get the value of the configured host.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The configured host as a string.
</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
-->

56
reference/amqp/amqpconnection/getlogin.xml Normal file
View file

@ -0,0 +1,56 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpconnection.getlogin" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPConnection::getLogin</refname>
<refpurpose>Get the configured login</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>AMQPConnection::getLogin</methodname>
<void />
</methodsynopsis>
<para>
Get the configured login.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The configured login as a string.
</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
-->

55
reference/amqp/amqpconnection/getpassword.xml Normal file
View file

@ -0,0 +1,55 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpconnection.getpassword" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPConnection::getPassword</refname>
<refpurpose>Get the configured password</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>AMQPConnection::getPassword</methodname>
<void />
</methodsynopsis>
<para>
Get the configured password.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The configured password as a string.
</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
-->

58
reference/amqp/amqpconnection/getport.xml Normal file
View file

@ -0,0 +1,58 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpconnection.getport" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPConnection::getPort</refname>
<refpurpose>Get the configured port</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>int</type><methodname>AMQPConnection::getPort</methodname>
<void />
</methodsynopsis>
<para>
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The configured port as an integer.
</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
-->

55
reference/amqp/amqpconnection/getvhost.xml Normal file
View file

@ -0,0 +1,55 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpconnection.getvhost" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPConnection::getVhost</refname>
<refpurpose>Get the configured vhost</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>AMQPConnection::getVhost</methodname>
<void />
</methodsynopsis>
<para>
Get the configured vhost.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The configured virtual host as a string.
</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
-->

67
reference/amqp/amqpenvelope.xml Normal file
View file

@ -0,0 +1,67 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<phpdoc:classref xml:id="class.amqpenvelope" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The AMQPEnvelope class</title>
<titleabbrev>AMQPEnvelope</titleabbrev>
<partintro>
<!-- {{{ AMQPEnvelope intro -->
<section xml:id="amqpenvelope.intro">
&reftitle.intro;
<para>
Contains a message and all of its attributes.
</para>
</section>
<!-- }}} -->
<section xml:id="amqpenvelope.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>AMQPEnvelope</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>AMQPEnvelope</classname>
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.amqpenvelope')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
</classsynopsis>
<!-- }}} -->
</section>
</partintro>
&reference.amqp.entities.amqpenvelope;
</phpdoc:classref>
<!-- 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
-->

54
reference/amqp/amqpenvelope/getappid.xml Normal file
View file

@ -0,0 +1,54 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpenvelope.getappid" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPEnvelope::getAppId</refname>
<refpurpose>Get the message appid</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>AMQPEnvelope::getAppId</methodname>
<void />
</methodsynopsis>
<para>
Get the application id of the message.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The application id of the message.
</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
-->

54
reference/amqp/amqpenvelope/getbody.xml Normal file
View file

@ -0,0 +1,54 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpenvelope.getbody" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPEnvelope::getBody</refname>
<refpurpose>Get the message body</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>AMQPEnvelope::getBody</methodname>
<void />
</methodsynopsis>
<para>
Get the body of the message.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The contents of the message body.
</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
-->

54
reference/amqp/amqpenvelope/getcontentencoding.xml Normal file
View file

@ -0,0 +1,54 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpenvelope.getcontentencoding" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPEnvelope::getContentEncoding</refname>
<refpurpose>Get the message contentencoding</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>AMQPEnvelope::getContentEncoding</methodname>
<void />
</methodsynopsis>
<para>
Get the content encoding of the message.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The content encoding of the message.
</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
-->

54
reference/amqp/amqpenvelope/getcontenttype.xml Normal file
View file

@ -0,0 +1,54 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpenvelope.getcontenttype" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPEnvelope::getContentType</refname>
<refpurpose>Get the message contenttype</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>AMQPEnvelope::getContentType</methodname>
<void />
</methodsynopsis>
<para>
Get the content type of the message.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The content type of the message.
</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
-->

54
reference/amqp/amqpenvelope/getcorrelationid.xml Normal file
View file

@ -0,0 +1,54 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpenvelope.getcorrelationid" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPEnvelope::getCorrelationId</refname>
<refpurpose>Get the message correlation id</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>AMQPEnvelope::getCorrelationId</methodname>
<void />
</methodsynopsis>
<para>
Get the correlation id of the message.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The correlation id of the message.
</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
-->

54
reference/amqp/amqpenvelope/getdeliverytag.xml Normal file
View file

@ -0,0 +1,54 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpenvelope.getdeliverytag" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPEnvelope::getDeliveryTag</refname>
<refpurpose>Get the message delivery tag</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>AMQPEnvelope::getDeliveryTag</methodname>
<void />
</methodsynopsis>
<para>
Get the delivery tag of the message.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The delivery tag of the message.
</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
-->

54
reference/amqp/amqpenvelope/getexchange.xml Normal file
View file

@ -0,0 +1,54 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpenvelope.getexchange" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPEnvelope::getExchange</refname>
<refpurpose>Get the message exchange</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>AMQPEnvelope::getExchange</methodname>
<void />
</methodsynopsis>
<para>
Get the exchange name on which the message was published.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The exchange name on which the message was published.
</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
-->

54
reference/amqp/amqpenvelope/getexpiration.xml Normal file
View file

@ -0,0 +1,54 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpenvelope.getexpiration" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPEnvelope::getExpiration</refname>
<refpurpose>Get the message expiration</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>AMQPEnvelope::getExpiration</methodname>
<void />
</methodsynopsis>
<para>
Get the expiration of the message.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The message expiration.
</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
-->

54
reference/amqp/amqpenvelope/getheader.xml Normal file
View file

@ -0,0 +1,54 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpenvelope.getheader" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPEnvelope::getHeader</refname>
<refpurpose>Get a specific message header</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>AMQPEnvelope::getHeader</methodname>
<methodparam><type>string</type><parameter>header_key</parameter></methodparam>
</methodsynopsis>
<para>
Get the the header value for a specific header key.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The contents of the specified header or &false; if not set.
</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
-->

54
reference/amqp/amqpenvelope/getheaders.xml Normal file
View file

@ -0,0 +1,54 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpenvelope.getheaders" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPEnvelope::getHeaders</refname>
<refpurpose>Get the message headers</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>array</type><methodname>AMQPEnvelope::getHeaders</methodname>
<void />
</methodsynopsis>
<para>
Get the headers of the message.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
An array of key value pairs associated with the message.
</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
-->

54
reference/amqp/amqpenvelope/getmessageid.xml Normal file
View file

@ -0,0 +1,54 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpenvelope.getmessageid" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPEnvelope::getMessageId</refname>
<refpurpose>Get the message id</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>AMQPEnvelope::getMessageId</methodname>
<void />
</methodsynopsis>
<para>
Get the message id of the message.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The message id.
</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
-->

54
reference/amqp/amqpenvelope/getpriority.xml Normal file
View file

@ -0,0 +1,54 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpenvelope.getpriority" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPEnvelope::getPriority</refname>
<refpurpose>Get the message priority</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>AMQPEnvelope::getPriority</methodname>
<void />
</methodsynopsis>
<para>
Get the priority of the message.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The message priority.
</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
-->

54
reference/amqp/amqpenvelope/getreplyto.xml Normal file
View file

@ -0,0 +1,54 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpenvelope.getreplyto" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPEnvelope::getReplyTo</refname>
<refpurpose>Get the message replyto</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>AMQPEnvelope::getReplyTo</methodname>
<void />
</methodsynopsis>
<para>
Get the reply to of the message.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The contents of the reply to field.
</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
-->

54
reference/amqp/amqpenvelope/getroutingkey.xml Normal file
View file

@ -0,0 +1,54 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpenvelope.getroutingkey" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPEnvelope::getRoutingKey</refname>
<refpurpose>Get the message routing key</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>AMQPEnvelope::getRoutingKey</methodname>
<void />
</methodsynopsis>
<para>
Get the routing key of the message.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The message routing key.
</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
-->

54
reference/amqp/amqpenvelope/gettimestamp.xml Normal file
View file

@ -0,0 +1,54 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpenvelope.gettimestamp" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPEnvelope::getTimeStamp</refname>
<refpurpose>Get the message timestamp</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>AMQPEnvelope::getTimeStamp</methodname>
<void />
</methodsynopsis>
<para>
Get the timestamp of the message.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The message timestamp.
</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
-->

54
reference/amqp/amqpenvelope/gettype.xml Normal file
View file

@ -0,0 +1,54 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpenvelope.gettype" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPEnvelope::getType</refname>
<refpurpose>Get the message type</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>AMQPEnvelope::getType</methodname>
<void />
</methodsynopsis>
<para>
Get the type of the message.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The message type.
</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
-->

54
reference/amqp/amqpenvelope/getuserid.xml Normal file
View file

@ -0,0 +1,54 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpenvelope.getuserid" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPEnvelope::getUserId</refname>
<refpurpose>Get the message user id</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>AMQPEnvelope::getUserId</methodname>
<void />
</methodsynopsis>
<para>
Get the user id of the message.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The message user id.
</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
-->

54
reference/amqp/amqpenvelope/isredelivery.xml Normal file
View file

@ -0,0 +1,54 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpenvelope.isredelivery" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPEnvelope::isRedelivery</refname>
<refpurpose>Whether this is a redelivery of the message</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>AMQPEnvelope::isRedelivery</methodname>
<void />
</methodsynopsis>
<para>
Whether this is a redelivery of a message. If this message has been delivered and <methodname>AMQPEnvelope::nack</methodname> was called, the message will be put back on the queue to be redelivered, at which point the message will always return &true; when this method is called.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&true; if this is a redelivery, &false; otherwise.
</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
-->

6
reference/amqp/amqpexception.xml
View file

@ -36,13 +36,13 @@
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">Properties</classsynopsisinfo>
<classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
<classsynopsisinfo role="comment">Methods</classsynopsisinfo>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.amqpexception')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
<classsynopsisinfo role="comment">Inherited methods</classsynopsisinfo>
<classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.exception')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
</classsynopsis>

25
reference/amqp/amqpexchange/bind.xml
View file

@ -4,18 +4,19 @@
<refentry xml:id="amqpexchange.bind" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPExchange::bind</refname>
<refpurpose>The bind purpose</refpurpose>
<refpurpose>Bind to another exchange</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>AMQPExchange::bind</methodname>
<methodparam><type>string</type><parameter>queue_name</parameter></methodparam>
<methodparam><type>string</type><parameter>destination_exchange_name</parameter></methodparam>
<methodparam><type>string</type><parameter>source_exchange_name</parameter></methodparam>
<methodparam><type>string</type><parameter>routing_key</parameter></methodparam>
</methodsynopsis>
<para>
Bind an exchange to a queue using the specified routing key.
Bind an exchange to another exchange using the specified routing key.
</para>
</refsect1>
@ -24,10 +25,18 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>queue_name</parameter></term>
<term><parameter>destination_exchange_name</parameter></term>
<listitem>
<para>
The name of the queue to which to bind.
The name of the destination exchange in the binding.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>source_exchange_name</parameter></term>
<listitem>
<para>
The name of the source exchange in the binding.
</para>
</listitem>
</varlistentry>
@ -55,6 +64,12 @@
<para>
Throws <classname>AMQPExchangeException</classname> on failure.
</para>
<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>
</refentry>

26
reference/amqp/amqpexchange/construct.xml
View file

@ -11,14 +11,10 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <methodname>AMQPExchange::__construct</methodname>
<methodparam><type>AMQPConnection</type><parameter>connection</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>exchange_name</parameter><initializer>""</initializer></methodparam>
<methodparam><type>AMQPChannel</type><parameter>amqp_channel</parameter></methodparam>
</methodsynopsis>
<para>
Returns a new instance of an AMQPExchange object, associated with the given AMQPConnection object. If the
<parameter>exchange_name</parameter> parameter is specified and the an exchange by that name exists on the
broker, an instance of that specific exchange will be returned. Otherwise, the <parameter>exchange_name</parameter>
is ignored.
Returns a new instance of an AMQPExchange object, associated with the given AMQPChannel object.
</para>
</refsect1>
@ -28,18 +24,10 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>AMQPConnection</parameter></term>
<term><parameter>AMQPChannel</parameter></term>
<listitem>
<para>
A valid <classname>AMQPConnection</classname> object, connected to a broker.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>exchange_name</parameter></term>
<listitem>
<para>
The name of an existing exchange to represent.
A valid <classname>AMQPChannel</classname> object, connected to a broker.
</para>
</listitem>
</varlistentry>
@ -57,8 +45,10 @@
<refsect1 role="errors">
&reftitle.errors;
<para>
Throws <classname>AMQPExchangeException</classname> when
<parameter>connection</parameter> is not connect to a broker.
Throws <classname>AMQPExchangeException</classname> when <parameter>amqp_channel</parameter> is not connected to a broker.
</para>
<para>
Throws <classname>AMQPConnectionException</classname> if the connection to the broker was lost.
</para>
</refsect1>

55
reference/amqp/amqpexchange/declare.xml
View file

@ -10,51 +10,17 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>AMQPExchange::declare</methodname>
<methodparam choice="opt"><type>string</type><parameter>exchange_name</parameter><initializer>""</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>exchange_type</parameter><initializer><constant>AMQP_EX_TYPE_DIRECT</constant></initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
<modifier>public</modifier> <type>int</type><methodname>AMQPExchange::declare</methodname>
<void />
</methodsynopsis>
<para>
Declare a new exchange on the broker with the given information. If an exchange by that name already exists and the
<parameter>exchange_type</parameter> and/or <parameter>flags</parameter> are specified, the exchange settings will
be updated.
Declare a new exchange on the broker.
</para>
<para>
If no <parameter>exchange_type</parameter> is specified and the exchange does not exist, the exchange type will default to "direct".
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>exchange_name</parameter></term>
<listitem>
<para>
The name of the exchange.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>exchange_type</parameter></term>
<listitem>
<para>
The type of the exchange. Can be any of <constant>AMQP_EX_TYPE_DIRECT</constant>, <constant>AMQP_EX_TYPE_FANOUT</constant>, <constant>AMQP_EX_TYPE_TOPIC</constant> or <constant>AMQP_EX_TYPE_HEADER</constant>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
A bitmask of any of the flags: <constant>AMQP_PASSIVE</constant>, <constant>AMQP_DURABLE</constant>, <constant>AMQP_AUTODELETE</constant>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
@ -70,6 +36,12 @@
<para>
Throws <classname>AMQPExchangeException</classname> on failure.
</para>
<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="examples">
@ -85,8 +57,13 @@
$cnn = new AMQPConnection();
$cnn->connect();
$ex = new AMQPExchange($cnn);
$ex->declare('new_topic_exchange', AMQP_EX_TYPE_DIRECT, AMQP_DURABLE | AMQP_AUTODELETE);
$ch = new AMQPChannel($cnn);
$ex = new AMQPExchange($ch);
$ex->setName('new_topic_exchange');
$ex->setType(AMQP_EX_TYPE_DIRECT);
$ex->setFlags(AMQP_DURABLE | AMQP_AUTODELETE);
$ex->declare();
?>
]]>

31
reference/amqp/amqpexchange/delete.xml
View file

@ -11,15 +11,11 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>AMQPExchange::delete</methodname>
<methodparam choice="opt"><type>string</type><parameter>exchange_name</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>params</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer><constant>AMQP_NOPARAM</constant></initializer></methodparam>
</methodsynopsis>
<para>
Delete and exchange from the broker.
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">
@ -27,17 +23,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>exchange_name</parameter></term>
<listitem>
<para>
The name of the exchange to delete. If the <classname>AMQPExchange</classname> object is already bound to an existing exchange and then
<parameter>exchange_name</parameter> is not specified, the exchange bound to the <classname>AMQPExchange</classname> object will be
deleted.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>params</parameter></term>
<term><parameter>flags</parameter></term>
<listitem>
<para>
Optionally <constant>AMQP_IFUNUSED</constant> can be specified to indicate the exchange
@ -49,6 +35,19 @@
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Throws <classname>AMQPExchangeException</classname> on failure.
</para>
<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;
<para>

63
reference/amqp/amqpexchange/getargument.xml Normal file
View file

@ -0,0 +1,63 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpexchange.getargument" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPExchange::getArgument</refname>
<refpurpose>Get the argument associated with the given key</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>mixed</type><methodname>AMQPExchange::getArgument</methodname>
<methodparam><type>string</type><parameter>key</parameter></methodparam>
</methodsynopsis>
<para>
Get the argument associated with the given key.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
<para>
The key to look up.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The <type>string</type> or <type>integer</type> value associated with the given key, or &false; if the key is not set.
</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
-->

53
reference/amqp/amqpexchange/getarguments.xml Normal file
View file

@ -0,0 +1,53 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpexchange.getarguments" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPExchange::getArguments</refname>
<refpurpose>Get all arguments set on the given exchange</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>array</type><methodname>AMQPExchange::getArguments</methodname>
<void />
</methodsynopsis>
<para>
Get all arguments as an array of key/value pairs that are currently set on the given exchange.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
An <type>array</type> containing all of the set key/value pairs.
</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
-->

53
reference/amqp/amqpexchange/getflags.xml Normal file
View file

@ -0,0 +1,53 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpexchange.getflags" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPExchange::getFlags</refname>
<refpurpose>Get the flag bitmask</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>int</type><methodname>AMQPExchange::getFlags</methodname>
<void />
</methodsynopsis>
<para>
Get all the flags currently set on the given exchange.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
An <type>integer</type> bitmask of all the flags currently set on this exchange object.
</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
-->

55
reference/amqp/amqpexchange/getname.xml Normal file
View file

@ -0,0 +1,55 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpexchange.getname" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPExchange::getName</refname>
<refpurpose>Get the configured name</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>AMQPExchange::getName</methodname>
<void />
</methodsynopsis>
<para>
Get the configured name.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The configured name as a <type>string</type>.
</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
-->

55
reference/amqp/amqpexchange/gettype.xml Normal file
View file

@ -0,0 +1,55 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpexchange.gettype" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPExchange::getType</refname>
<refpurpose>Get the configured type</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>AMQPExchange::getType</methodname>
<void />
</methodsynopsis>
<para>
Get the configured type.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The configured type as a <type>string</type>.
</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
-->

13
reference/amqp/amqpexchange/publish.xml
View file

@ -13,13 +13,12 @@
<modifier>public</modifier> <type>bool</type><methodname>AMQPExchange::publish</methodname>
<methodparam><type>string</type><parameter>message</parameter></methodparam>
<methodparam><type>string</type><parameter>routing_key</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>params</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type>array</type><parameter>attributes</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer><constant>AMQP_NOPARAM</constant></initializer></methodparam>
<methodparam choice="opt"><type>array</type><parameter>attributes</parameter><initializer>array()</initializer></methodparam>
</methodsynopsis>
<para>
Publish a message to the exchange represented by the <classname>AMQPExchange</classname> object.
</para>
</refsect1>
<refsect1 role="parameters">
@ -43,7 +42,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>params</parameter></term>
<term><parameter>flags</parameter></term>
<listitem>
<para>
One or more of <constant>AMQP_MANDATORY</constant> and
@ -143,6 +142,12 @@
<para>
Throws an <classname>AMQPExchangeException</classname> on failure.
</para>
<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>
</refentry>

73
reference/amqp/amqpexchange/setargument.xml Normal file
View file

@ -0,0 +1,73 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpexchange.setargument" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPExchange::setArgument</refname>
<refpurpose>Set the value for the given key</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>AMQPExchange::setArgument</methodname>
<methodparam><type>string</type><parameter>key</parameter></methodparam>
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>
Set the key to the given value.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
<para>
The key to set.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
<para>
The value to set.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</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
-->

64
reference/amqp/amqpexchange/setarguments.xml Normal file
View file

@ -0,0 +1,64 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpexchange.setarguments" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPExchange::setArguments</refname>
<refpurpose>Set all arguments on the exchange</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>AMQPExchange::setArguments</methodname>
<methodparam><type>array</type><parameter>arguments</parameter></methodparam>
</methodsynopsis>
<para>
Set all arguments on the given exchange. All other argument settings will be wiped.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>arguments</parameter></term>
<listitem>
<para>
An array of key/value pairs of arguments.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</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
-->

64
reference/amqp/amqpexchange/setflags.xml Normal file
View file

@ -0,0 +1,64 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpexchange.setflags" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPExchange::setFlags</refname>
<refpurpose>Set the flags on an exchange</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>AMQPExchange::setFlags</methodname>
<methodparam><type>int</type><parameter>flags</parameter></methodparam>
</methodsynopsis>
<para>
Set the flags on an exchange.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
A bitmask of flags. This call currently only considers the following flags: <constant>AMQP_PASSIVE</constant>, <constant>AMQP_PASSIVE</constant>.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</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
-->

65
reference/amqp/amqpexchange/setname.xml Normal file
View file

@ -0,0 +1,65 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpexchange.setname" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPExchange::setName</refname>
<refpurpose>Set the name of the exchange</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>AMQPExchange::setName</methodname>
<methodparam><type>string</type><parameter>exchange_name</parameter></methodparam>
</methodsynopsis>
<para>
Set the name of the exchange.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>exchange_name</parameter></term>
<listitem>
<para>
The name of the exchange to set as <type>string</type>.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</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
-->

67
reference/amqp/amqpexchange/settype.xml Normal file
View file

@ -0,0 +1,67 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpexchange.settype" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPExchange::setType</refname>
<refpurpose>Set the type of the exchange</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>AMQPExchange::setType</methodname>
<methodparam><type>string</type><parameter>exchange_type</parameter></methodparam>
</methodsynopsis>
<para>
Set the type of the exchange. This can be any of <constant>AMQP_EX_TYPE_DIRECT</constant>, <constant>AMQP_EX_TYPE_FANOUT</constant>, <constant>AMQP_EX_TYPE_HEADER</constant> or <constant>AMQP_EX_TYPE_TOPIC</constant>.
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>exchange_type</parameter></term>
<listitem>
<para>
The type of exchange as a <type>string</type>.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</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
-->

2
reference/amqp/amqpqueue.xml
View file

@ -32,7 +32,7 @@
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">Methods</classsynopsisinfo>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.amqpqueue')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
</classsynopsis>
<!-- }}} -->

22
reference/amqp/amqpqueue/ack.xml
View file

@ -12,10 +12,10 @@
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>AMQPQueue::ack</methodname>
<methodparam><type>int</type><parameter>delivery_tag</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer><constant>AMQP_NOPARAM</constant></initializer></methodparam>
</methodsynopsis>
<para>
This method allows the acknowledgement of a message that is retrieved with the <constant>AMQP_NOACK</constant> flag through
This method allows the acknowledgement of a message that is retrieved without the <constant>AMQP_AUTOACK</constant> flag through
<methodname>AMQPQueue::get</methodname> or <methodname>AMQPQueue::consume</methodname>
</para>
</refsect1>
@ -43,7 +43,17 @@
</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;
<para>
@ -64,14 +74,16 @@
$connection = new AMQPConnection();
$connection->connect();
$channel = new AMQPChannel($connection);
/* create a queue object */
$queue = new AMQPQueue($connection);
$queue = new AMQPQueue($channel);
//declare the queue
$queue->declare('myqueue');
//get the next message, but don't mark it as delivered
$message = $queue->get(AMQP_NOACK);
$message = $queue->get(AMQP_NOPARAM);
echo $message['msg'];

10
reference/amqp/amqpqueue/bind.xml
View file

@ -46,6 +46,16 @@
</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;
<para>

13
reference/amqp/amqpqueue/cancel.xml
View file

@ -16,9 +16,6 @@
<para>
Cancel a queue that is already bound to an exchange and routing key.
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">
@ -37,6 +34,16 @@
</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;
<para>

33
reference/amqp/amqpqueue/construct.xml
View file

@ -4,7 +4,7 @@
<refentry xml:id="amqpqueue.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPQueue::__construct</refname>
<refpurpose>Create an instance of an AMQPQueue object.</refpurpose>
<refpurpose>Create an instance of an AMQPQueue object</refpurpose>
</refnamediv>
<refsect1 role="description">
@ -12,7 +12,6 @@
<methodsynopsis>
<modifier>public</modifier> <methodname>AMQPQueue::__construct</methodname>
<methodparam><type>AMQPConnection</type><parameter>amqp_connection</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>queue_name</parameter><initializer>""</initializer></methodparam>
</methodsynopsis>
<para>
Creates an <classname>AMQPQueue</classname> instance representing an AMQP queue on the broker.
@ -22,31 +21,23 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>amqp_connection</parameter></term>
<listitem>
<para>
A valid <classname>AMQPConnection</classname> object.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>queue_name</parameter></term>
<listitem>
<para>
The name of the queue to construct. If no queue name is specified, the broker will generate one.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Throws <classname>AMQPQueueException</classname> when <parameter>amqp_channel</parameter> is not connected to a broker.
</para>
<para>
Throws <classname>AMQPConnectionException</classname> if the connection to the broker was lost.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an instance of <classname>AMQPQueue</classname> on success.
</para>
</refsect1>

95
reference/amqp/amqpqueue/consume.xml
View file

@ -4,81 +4,100 @@
<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>The consume purpose</refpurpose>
<refpurpose>Consume messages from a queue</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>array</type><methodname>AMQPQueue::consume</methodname>
<methodparam choice="opt"><type>array</type><parameter>options</parameter><initializer>array()</initializer></methodparam>
<modifier>public</modifier> <type>void</type><methodname>AMQPQueue::consume</methodname>
<methodparam><type>callback</type><parameter>callback</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer><constant>AMQP_NOPARAM</constant></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 <methodname>AMQPQueue::get</methodname>.
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>options</parameter></term>
<term><parameter>flags</parameter></term>
<listitem>
<para>
<parameter>options</parameter> is a an array of consume options. The keys used in the <parameter>options</parameter> array are: min, max, and ack. All other keys will be ignored.
</para>
<para>
For each missing option, the extension will check the ini settings or use the default value.
A bitmask of any of the flags: <constant>AMQP_NOACK</constant>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<refsect1 role="errors">
&reftitle.errors;
<para>
An array containing the messages consumed. The number of returned messages will be at least the number given by <parameter>min</parameter> in the <parameter>options</parameter> array. But not more than the number given by <parameter>max</parameter>.
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
<![CDATA[
<?php
/* Create a connection using all default credentials: */
$connection = new AMQPConnection();
$connection->connect();
/* Create a connection using all default credentials: */
$connection = new AMQPConnection();
$connection->connect();
/* create a queue object */
$queue = new AMQPQueue($connection);
$channel = new AMQPChannel($connection);
//declare the queue
$queue->declare('myqueue');
/* create a queue object */
$queue = new AMQPQueue($channel);
$options = array(
'min' => 1,
'max' => 10,
'ack' => true
);
//declare the queue
$queue->declare('myqueue');
//get the messages
$messages = $queue->consume($options);
$i = 0;
function processMessage($envelope, $queue) {
global $i;
echo "Message $i: " . $envelope->getBody() . "\n";
$i++;
if ($i > 10) {
// Bail after 10 messages
return false;
}
}
foreach ($messages as $message) {
echo $message['message_body'];
}
// Consume messages on queue
$queue->consume("processMessage");
?>
]]>
?>
]]>
</programlisting>
</example>
</para>

31
reference/amqp/amqpqueue/declare.xml
View file

@ -11,8 +11,7 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>int</type><methodname>AMQPQueue::declare</methodname>
<methodparam choice="opt"><type>string</type><parameter>queue_name</parameter><initializer>""</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer><constant>AMQP_AUTODELETE</constant></initializer></methodparam>
<void />
</methodsynopsis>
<para>
Declare a new queue on the broker.
@ -22,24 +21,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>queue_name</parameter></term>
<listitem>
<para>
The name of the queue to declare.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
A bitmask of any of the flags: <constant>AMQP_AUTODELETE</constant>, <constant>AMQP_PASSIVE</constant>, <constant>AMQP_DURABLE</constant>, <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>

23
reference/amqp/amqpqueue/delete.xml
View file

@ -10,8 +10,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>AMQPQueue::delete</methodname>
<methodparam><type>string</type><parameter>queue_name</parameter></methodparam>
<modifier>public</modifier><type>bool</type><methodname>AMQPQueue::delete</methodname>
<void />
</methodsynopsis>
<para>
Delete a queue from the broker, including its entire contents of unread or unacknowledged messages.
@ -20,17 +20,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<variablelist>
<varlistentry>
<term><parameter>queue_name</parameter></term>
<listitem>
<para>
The name of the queue to delete.
</para>
</listitem>
</varlistentry>
</variablelist>
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>

158
reference/amqp/amqpqueue/get.xml
View file

@ -10,94 +10,92 @@
<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. 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>
<modifier>public</modifier> <type>mixed</type><methodname>AMQPQueue::get</methodname>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam>
</methodsynopsis>
<para>
Retrieve the next available message from the queue. If no messages are present in the queue, this function will return &false; immediately. This is a non blocking alternative to the <methodname>AMQPQueue::consume</methodname> method.
</para>
<para>
Currently, the only supported flag for the <parameter>flags</parameter> parameter is <constant>AMQP_AUTOACK</constant>. If this flag is passed in, then the message returned will automatically be marked as acknowledged by the broker as soon as the frames are sent to the client.
</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="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
A bitmask of supported flags for the method call. Currently, the only the supported flag is <constant>AMQP_AUTOACK</constant>. If this value is not provided, it will use the value of <literal>amqp.auto_ack</literal>.
</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>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
An instance of <classname>AMQPEnvelope</classname> representing the message pulled from the queue, or &false;.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><methodname>AMQPQueue::get</methodname> example</title>
<programlisting role="php">
<![CDATA[
<?php
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><methodname>AMQPQueue::get</methodname> example</title>
<programlisting role="php">
<![CDATA[
<?php
/* Create a connection using all default credentials: */
$connection = new AMQPConnection();
$connection->connect();
/* Create a connection using all default credentials: */
$connection = new AMQPConnection();
$connection->connect();
/* create a queue object */
$queue = new AMQPQueue($connection);
$channel = new AMQPChannel($connection);
//declare the queue
$queue->declare('myqueue');
/* create a queue object */
$queue = new AMQPQueue($channel);
//get the next message
$message = $queue->get();
//declare the queue
$queue->declare('myqueue');
echo $message['msg'];
//get the messages
$messages = $queue->get(AMQP_AUTOACK);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
echo $message->getBody();
</refentry>
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<!-- 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
-->
</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
-->

64
reference/amqp/amqpqueue/getargument.xml Normal file
View file

@ -0,0 +1,64 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpqueue.getargument" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPQueue::getArgument</refname>
<refpurpose>Get the argument associated with the given key</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>mixed</type><methodname>AMQPQueue::getArgument</methodname>
<methodparam><type>string</type><parameter>key</parameter></methodparam>
</methodsynopsis>
<para>
Get the argument associated with the given key.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
<para>
The key to look up.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The <type>string</type> or <type>integer</type> value associated with the given key, or &false; if the key is not set.
</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
-->

55
reference/amqp/amqpqueue/getarguments.xml Normal file
View file

@ -0,0 +1,55 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpqueue.getarguments" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPQueue::getArguments</refname>
<refpurpose>Get all arguments set on the given queue</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>array</type><methodname>AMQPQueue::getArguments</methodname>
<void />
</methodsynopsis>
<para>
Get all arguments as an array of key/value pairs that are currently set on the given queue.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
An <type>array</type> containing all of the set key/value pairs.
</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
-->

54
reference/amqp/amqpqueue/getflags.xml Normal file
View file

@ -0,0 +1,54 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpqueue.getflags" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPQueue::getFlags</refname>
<refpurpose>Get the flag bitmask</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>int</type><methodname>AMQPQueue::getFlags</methodname>
<void />
</methodsynopsis>
<para>
Get all the flags currently set on the given queue.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
An <type>integer</type> bitmask of all the flags currently set on this exchange object.
</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
-->

56
reference/amqp/amqpqueue/getname.xml Normal file
View file

@ -0,0 +1,56 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpqueue.getname" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPQueue::getName</refname>
<refpurpose>Get the configured name</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>AMQPQueue::getName</methodname>
<void />
</methodsynopsis>
<para>
Get the configured name.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The configured name as a <type>string</type>.
</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
-->

89
reference/amqp/amqpqueue/nack.xml Normal file
View file

@ -0,0 +1,89 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpqueue.nack" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPQueue::nack</refname>
<refpurpose>Mark a message as explicitly not acknowledged.</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>AMQPQueue::nack</methodname>
<methodparam><type>string</type><parameter>delivery_tag</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>flags</parameter><initializer><constant>AMQP_NOPARAM</constant></initializer></methodparam>
</methodsynopsis>
<para>
Mark the message identified by <parameter>delivery_tab</parameter> as explicitly not acknowledged. This method can only be called on messages that have not yet been acknowledged, meaning that messages retrieved with by <methodname>AMQPQueue::consume</methodname> and <methodname>AMQPQueue::get</methodname> and using the <constant>AMQP_AUTOACK</constant> flag are not eligible.
</para>
<para>
When called, the broker will immediately put the message back onto the queue, instead of waiting until the connection is closed.
</para>
<para>
This method is only supported by the RabbitMQ broker. The behavior of calling this method while connected to any other broker is undefined.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>delivery_tag</parameter></term>
<listitem>
<para>
The delivery tag by which to identify the message.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
A bitmask of flags.
</para>
</listitem>
</varlistentry>
</variablelist>
</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;
<para>
&return.success;
</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
-->

24
reference/amqp/amqpqueue/purge.xml
View file

@ -11,29 +11,25 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>AMQPQueue::purge</methodname>
<methodparam><type>string</type><parameter>queue_name</parameter></methodparam>
<void />
</methodsynopsis>
<para>
Purge the contents of a queue.
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<variablelist>
<varlistentry>
<term><parameter>queue_name</parameter></term>
<listitem>
<para>
The name of the queue to purge
</para>
</listitem>
</varlistentry>
</variablelist>
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>

73
reference/amqp/amqpqueue/setargument.xml Normal file
View file

@ -0,0 +1,73 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpqueue.setargument" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPQueue::setArgument</refname>
<refpurpose>Set the value for the given key</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>AMQPQueue::setArgument</methodname>
<methodparam><type>string</type><parameter>key</parameter></methodparam>
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>
Set the key to the given value.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
<para>
The key to set.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
<para>
The value to set.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</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
-->

64
reference/amqp/amqpqueue/setarguments.xml Normal file
View file

@ -0,0 +1,64 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpqueue.setarguments" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPQueue::setArguments</refname>
<refpurpose>Set all arguments on the queue</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>AMQPQueue::setArguments</methodname>
<methodparam><type>array</type><parameter>arguments</parameter></methodparam>
</methodsynopsis>
<para>
Set all arguments on the given queue. All other argument settings will be wiped.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>arguments</parameter></term>
<listitem>
<para>
An array of key/value pairs of arguments.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</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
-->

64
reference/amqp/amqpqueue/setflags.xml Normal file
View file

@ -0,0 +1,64 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpqueue.setflags" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPQueue::setFlags</refname>
<refpurpose>Set the queue flags</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>AMQPQueue::setFlags</methodname>
<methodparam><type>int</type><parameter>flags</parameter></methodparam>
</methodsynopsis>
<para>
Set the flags on the queue.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
A bitmask of flags. This call currently only supports a bitmask of the following flags: <constant>AMQP_DURABLE</constant>, <constant>AMQP_PASSIVE</constant>, <constant>AMQP_EXCLUSIVE</constant>, <constant>AMQP_AUTODELETE</constant>.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</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
-->

64
reference/amqp/amqpqueue/setname.xml Normal file
View file

@ -0,0 +1,64 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpqueue.setname" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPQueue::setName</refname>
<refpurpose>Set the queue name</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>AMQPQueue::setName</methodname>
<methodparam><type>string</type><parameter>queue_name</parameter></methodparam>
</methodsynopsis>
<para>
Set the name of the queue
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>queue_name</parameter></term>
<listitem>
<para>
The name of the queue as a <type>string</type>.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</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
-->

13
reference/amqp/amqpqueue/unbind.xml
View file

@ -17,9 +17,6 @@
<para>
Remove a routing key binding on an exchange from the given queue.
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">
@ -46,6 +43,16 @@
</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;
<para>

76
reference/amqp/book.developer.xml Normal file
View file

@ -0,0 +1,76 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V5.0//EN"
"{PATH_TO_DOCBASE}/docbook/docbook-xml/docbook.dtd" [
<!-- $Revision$ -->
<!-- We use xhtml entities all over the place -->
<!ENTITY % xhtml-lat1 SYSTEM "{PATH_TO_DOCBASE}/entities/ISO/xhtml1-lat1.ent">
<!ENTITY % xhtml-symbol SYSTEM "{PATH_TO_DOCBASE}/entities/ISO/xhtml1-symbol.ent">
<!ENTITY % xhtml-special SYSTEM "{PATH_TO_DOCBASE}/entities/ISO/xhtml1-special.ent">
<!ENTITY % isopub SYSTEM "{PATH_TO_DOCBASE}/entities/ISO/isopub.ent">
%xhtml-lat1;
%xhtml-symbol;
%xhtml-special;
%isopub;
<!-- Fallback to English definitions and snippets (in case of missing translation) -->
<!ENTITY % language-defs.default SYSTEM "{PATH_TO_DOC}/language-defs.ent">
<!ENTITY % language-snippets.default SYSTEM "{PATH_TO_DOC}/language-snippets.ent">
<!ENTITY % extensions.default SYSTEM "{PATH_TO_DOC}/extensions.ent">
%language-defs.default;
%extensions.default;
%language-snippets.default;
<!-- All global entities for the XML files -->
<!ENTITY % global.entities SYSTEM "{PATH_TO_DOCBASE}/entities/global.ent">
<!-- These are language independent -->
<!ENTITY % frontpage.entities SYSTEM "{PATH_TO_DOC}/contributors.ent">
<!ENTITY % file.entities SYSTEM "{PATH_TO_DOCBASE}/entities/file-entities.ent">
<!-- Include all external DTD parts defined previously -->
%global.entities;
%file.entities;
%frontpage.entities;
]>
<book xml:id="book.amqp" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:lang="en">
<title>AMQP</title>
<titleabbrev>AMQP</titleabbrev>
<preface xml:id="intro.amqp">
&reftitle.intro;
<para>
</para>
</preface>
&reference.amqp.setup;
&reference.amqp.constants;
&reference.amqp.examples;
&reference.amqp.reference;
</book>
<!-- 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
-->

10
reference/amqp/book.xml
View file

@ -10,23 +10,29 @@
<para>
<link xlink:href="&url.amqp;">AMQP</link> stands for <link
xlink:href="&url.amqp;">Advanced Message Queue Protocol</link>, which is an open standard middleware
layer for message routing and queuing. This extension is compatible with any Version 0-8 compatible AMQP
layer for message routing and queuing. This extension is compatible with any Version 0-9-1 compatible AMQP
broker, such as <link xlink:href="&url.amqp.rabbitmq;">RabbitMQ</link> and <link
xlink:href="&url.amqp.openamq;">OpenAMQ</link>.
</para>
<para>
This extension relies on the <link xlink:href="&url.amqp.librabbitmq;">librabbitmq</link> RPC library for
communicating with the AMQP broker. Though named "rabbit", this library is compatible with all Version 0-8
communicating with the AMQP broker. Though named "rabbit", this library is compatible with all Version 0-9-1
compatible AMQP brokers.
</para>
<para>
We *HIGHLY* recommend you review the <link xlink:href="&url.amqp.amqp_0_9_1_reference;">AMQP specification reference, version 0-9-1</link>. This document will help explain a lot of the calls made available by this extension.
</para>
</preface>
&reference.amqp.setup;
&reference.amqp.constants;
&reference.amqp.examples;
&reference.amqp.amqpconnection;
&reference.amqp.amqpchannel;
&reference.amqp.amqpexchange;
&reference.amqp.amqpqueue;
&reference.amqp.amqpenvelope;
</book>

12
reference/amqp/configure.xml
View file

@ -6,16 +6,18 @@
<para>
To install the AMQP PHP extension, you must first install the <link xlink:href="&url.amqp.librabbitmq;">librabbitmq</link>
library. Use the following steps to download and install the library:
library. You will need the 0-9-1 version of the rabbitmq-c client library, linked to the rabbitmq-codegen version that corresponds
to the version of the broker you are using. Use the following steps to download and install the library:
</para>
<programlisting role="shell">
<![CDATA[
# Download the rabbitmq-c library
hg clone http://hg.rabbitmq.com/rabbitmq-c/rev/3c549bb09c16 rabbitmq-c
# Download the rabbitmq-c library @ version 0-9-1
hg clone http://hg.rabbitmq.com/rabbitmq-c/rev/b01825ecc112 rabbitmq-c
cd rabbitmq-c
# Add the codegen requirement
hg clone http://hg.rabbitmq.com/rabbitmq-codegen/rev/f8b34141e6cb codegen
# Add the codegen requirement. To find the full list, go here: http://hg.rabbitmq.com/rabbitmq-codegen/tags
# and copy the URL for the appropriate broker version.
hg clone http://hg.rabbitmq.com/rabbitmq-codegen/rev/16bbcb711380 codegen
# Configure, compile and install
autoreconf -i && ./configure && make && sudo make install
]]>

27
reference/amqp/constants.xml
View file

@ -6,6 +6,17 @@
&extension.constants;
<para>
<variablelist>
<varlistentry>
<term>
<constant>AMQP_NOPARAM</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Passing in this constant as a flag will forcefully disable all other flags. Use this if you want to temporarily disable the <literal>amqp.auto_ack</literal> ini setting.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>AMQP_DURABLE</constant>
@ -82,12 +93,12 @@
</varlistentry>
<varlistentry>
<term>
<constant>AMQP_NOACK</constant>
<constant>AMQP_AUTOACK</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
When passed to the consumer method, the messages will not be marked as delivered.
When passed to the <methodname>AMQPQueue::get</methodname> and <methodname>AMQPQueue::get</methodname> methods as a flag, the messages will be immediately marked as acknowledged by the server upon delivery.
</simpara>
</listitem>
</varlistentry>
@ -143,11 +154,21 @@
</term>
<listitem>
<simpara>
?
If set during a call to <methodname>AMQPQueue::ack</methodname>, the delivery tag is treated as "up to and including", so that multiple messages can be acknowledged with a single method. If set to zero, the delivery tag refers to a single message. If the <constant>AMQP_MULTIPLE</constant> flag is set, and the delivery tag is zero, this indicates acknowledgement of all outstanding messages.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>AMQP_NOWAIT</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
If set during a call to <methodname>AMQPExchange::bind</methodname>, the server will not respond to the method. The client should not wait for a reply method. If the server could not complete the method it will raise a channel or connection exception.
</simpara>
</listitem>
</varlistentry> <varlistentry>
<term>
<constant>AMQP_EX_TYPE_DIRECT</constant>
(<type>string</type>)

7
reference/amqp/examples.xml
View file

@ -13,12 +13,15 @@
$cnn = new AMQPConnection();
$cnn->connect();
// Create a channel
$ch = new AMQPChannel($cnn);
// Declare a new exchange
$ex = new AMQPExchange($cnn);
$ex = new AMQPExchange($ch);
$ex->declare('exchange1', AMQP_EX_TYPE_FANOUT);
// Create a new queue
$q = new AMQPQueue($cnn);
$q = new AMQPQueue($ch);
$q->declare('queue1');
// Bind it on the exchange to routing.key

78
reference/amqp/ini.xml
View file

@ -6,7 +6,7 @@
&extension.runtime;
<para>
<table>
<title>Amqp &ConfigureOptions;</title>
<title>AMQP &ConfigureOptions;</title>
<tgroup cols="4">
<thead>
<row>
@ -47,7 +47,31 @@
<entry>PHP_INI_ALL</entry>
<entry><!-- leave empty, this will be filled by an automatic script --></entry>
</row>
</tbody>
<row>
<entry>amqp.auto_ack</entry>
<entry>0</entry>
<entry>PHP_INI_ALL</entry>
<entry><!-- leave empty, this will be filled by an automatic script --></entry>
</row>
<row>
<entry>amqp.min_messages</entry>
<entry>0</entry>
<entry>PHP_INI_ALL</entry>
<entry><!-- leave empty, this will be filled by an automatic script --></entry>
</row>
<row>
<entry>amqp.max_messages</entry>
<entry>1</entry>
<entry>PHP_INI_ALL</entry>
<entry><!-- leave empty, this will be filled by an automatic script --></entry>
</row>
<row>
<entry>amqp.prefetch_count</entry>
<entry>3</entry>
<entry>PHP_INI_ALL</entry>
<entry><!-- leave empty, this will be filled by an automatic script --></entry>
</row>
</tbody>
</tgroup>
</table>
</para>
@ -74,7 +98,7 @@
</term>
<listitem>
<para>
The virtual host to which to connect on the host.
The virtual host on the broker to which to connect.
</para>
</listitem>
</varlistentry>
@ -96,7 +120,7 @@
</term>
<listitem>
<para>
The login (username) used for authenticating against the host.
The login to use while connecting to the broker.
</para>
</listitem>
</varlistentry>
@ -107,7 +131,51 @@
</term>
<listitem>
<para>
The password used for authenticating against the host.
The password to use while connecting to the broker.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.amqp.auto-ack">
<term>
<parameter>amqp.auto_ack</parameter>
<type>integer</type>
</term>
<listitem>
<para>
Whether calls to <methodname>AMQPQueue::get</methodname> and <methodname>AMQPQueue::consume</methodname> should require that the client explicitly acknowledge messages. Setting this value to 1 will pass in the <constant>AMQP_AUTOACK</constant> flag to the above method calls if the <literal>flags</literal> field is omitted.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.amqp.min-messages">
<term>
<parameter>amqp.min_messages</parameter>
<type>integer</type>
</term>
<listitem>
<para>
The minimum number of messages to require during a call to <methodname>AMQPQueue::consume</methodname>.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.amqp.max-messages">
<term>
<parameter>amqp.max_messages</parameter>
<type>integer</type>
</term>
<listitem>
<para>
The maximum number of messages to require during a call to <methodname>AMQPQueue::consume</methodname>.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.amqp.prefetch-count">
<term>
<parameter>amqp.prefetch_count</parameter>
<type>integer</type>
</term>
<listitem>
<para>
The number of messages to prefect from the server during a call to <methodname>AMQPQueue::get</methodname> or <methodname>AMQPQueue::consume</methodname> during which the <constant>AMQP_AUTOACK</constant> flag is not set.
</para>
</listitem>
</varlistentry>

32
reference/amqp/reference.xml Normal file
View file

@ -0,0 +1,32 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<reference xml:id="ref.amqp" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<title>AMQP &Functions;</title>
<partintro>
Hello
</partintro>
</reference>
<!-- 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
-->

76
reference/amqp/versions.xml
View file

@ -8,16 +8,54 @@
<!-- Methods -->
<function name='amqpconnection::__construct' from='PECL amqp &gt;= Unknown'/>
<function name='amqpconnection::isconnected' from='PECL amqp &gt;= Unknown'/>
<function name='amqpconnection::connect' from='PECL amqp &gt;= Unknown'/>
<function name='amqpconnection::disconnect' from='PECL amqp &gt;= Unknown'/>
<function name='amqpconnection::reconnect' from='PECL amqp &gt;= Unknown'/>
<function name='amqpconnection::getlogin' from='PECL amqp &gt;= Unknown'/>
<function name='amqpconnection::setlogin' from='PECL amqp &gt;= Unknown'/>
<function name='amqpconnection::getpassword' from='PECL amqp &gt;= Unknown'/>
<function name='amqpconnection::setpassword' from='PECL amqp &gt;= Unknown'/>
<function name='amqpconnection::gethost' from='PECL amqp &gt;= Unknown'/>
<function name='amqpconnection::sethost' from='PECL amqp &gt;= Unknown'/>
<function name='amqpconnection::getport' from='PECL amqp &gt;= Unknown'/>
<function name='amqpconnection::setport' from='PECL amqp &gt;= Unknown'/>
<function name='amqpconnection::getvhost' from='PECL amqp &gt;= Unknown'/>
<function name='amqpconnection::setvhost' from='PECL amqp &gt;= Unknown'/>
<function name='amqpchannel::__construct' from='PECL amqp &gt;= Unknown'/>
<function name='amqpchannel::isconnected' from='PECL amqp &gt;= Unknown'/>
<function name='amqpchannel::setprefetchsize' from='PECL amqp &gt;= Unknown'/>
<function name='amqpchannel::setprefetchcount' from='PECL amqp &gt;= Unknown'/>
<function name='amqpchannel::qos' from='PECL amqp &gt;= Unknown'/>
<function name='amqpqueue::__construct' from='PECL amqp &gt;= Unknown'/>
<function name='amqpqueue::getname' from='PECL amqp &gt;= Unknown'/>
<function name='amqpqueue::setname' from='PECL amqp &gt;= Unknown'/>
<function name='amqpqueue::getflags' from='PECL amqp &gt;= Unknown'/>
<function name='amqpqueue::setflags' from='PECL amqp &gt;= Unknown'/>
<function name='amqpqueue::getargument' from='PECL amqp &gt;= Unknown'/>
<function name='amqpqueue::getarguments' from='PECL amqp &gt;= Unknown'/>
<function name='amqpqueue::setargument' from='PECL amqp &gt;= Unknown'/>
<function name='amqpqueue::setarguments' from='PECL amqp &gt;= Unknown'/>
<function name='amqpqueue::declare' from='PECL amqp &gt;= Unknown'/>
<function name='amqpqueue::delete' from='PECL amqp &gt;= Unknown'/>
<function name='amqpqueue::purge' from='PECL amqp &gt;= Unknown'/>
<function name='amqpqueue::bind' from='PECL amqp &gt;= Unknown'/>
<function name='amqpqueue::unbind' from='PECL amqp &gt;= Unknown'/>
<function name='amqpqueue::consume' from='PECL amqp &gt;= Unknown'/>
<function name='amqpqueue::get' from='PECL amqp &gt;= Unknown'/>
<function name='amqpqueue::consume' from='PECL amqp &gt;= Unknown'/>
<function name='amqpqueue::ack' from='PECL amqp &gt;= Unknown'/>
<function name='amqpqueue::nack' from='PECL amqp &gt;= Unknown'/>
<function name='amqpqueue::purge' from='PECL amqp &gt;= Unknown'/>
<function name='amqpqueue::cancel' from='PECL amqp &gt;= Unknown'/>
<function name='amqpqueue::delete' from='PECL amqp &gt;= Unknown'/>
<function name='amqpqueue::unbind' from='PECL amqp &gt;= Unknown'/>
<function name='amqpexchange::__construct' from='PECL amqp &gt;= Unknown'/>
<function name='amqpexchange::getname' from='PECL amqp &gt;= Unknown'/>
<function name='amqpexchange::setname' from='PECL amqp &gt;= Unknown'/>
<function name='amqpexchange::getflags' from='PECL amqp &gt;= Unknown'/>
<function name='amqpexchange::setflags' from='PECL amqp &gt;= Unknown'/>
<function name='amqpexchange::gettype' from='PECL amqp &gt;= Unknown'/>
<function name='amqpexchange::settype' from='PECL amqp &gt;= Unknown'/>
<function name='amqpexchange::getargument' from='PECL amqp &gt;= Unknown'/>
<function name='amqpexchange::getarguments' from='PECL amqp &gt;= Unknown'/>
<function name='amqpexchange::setargument' from='PECL amqp &gt;= Unknown'/>
<function name='amqpexchange::setarguments' from='PECL amqp &gt;= Unknown'/>
<function name='amqpexchange::declare' from='PECL amqp &gt;= Unknown'/>
<function name='amqpexchange::bind' from='PECL amqp &gt;= Unknown'/>
<function name='amqpexchange::delete' from='PECL amqp &gt;= Unknown'/>
@ -42,16 +80,16 @@
<function name='amqpconnectionexception::getprevious' from='PECL amqp &gt;= Unknown'/>
<function name='amqpconnectionexception::gettraceasstring' from='PECL amqp &gt;= Unknown'/>
<function name='amqpconnectionexception::__tostring' from='PECL amqp &gt;= Unknown'/>
<function name='amqpexchangeexception::__clone' from='PECL amqp &gt;= Unknown'/>
<function name='amqpexchangeexception::__construct' from='PECL amqp &gt;= Unknown'/>
<function name='amqpexchangeexception::getmessage' from='PECL amqp &gt;= Unknown'/>
<function name='amqpexchangeexception::getcode' from='PECL amqp &gt;= Unknown'/>
<function name='amqpexchangeexception::getfile' from='PECL amqp &gt;= Unknown'/>
<function name='amqpexchangeexception::getline' from='PECL amqp &gt;= Unknown'/>
<function name='amqpexchangeexception::gettrace' from='PECL amqp &gt;= Unknown'/>
<function name='amqpexchangeexception::getprevious' from='PECL amqp &gt;= Unknown'/>
<function name='amqpexchangeexception::gettraceasstring' from='PECL amqp &gt;= Unknown'/>
<function name='amqpexchangeexception::__tostring' from='PECL amqp &gt;= Unknown'/>
<function name='amqpchannelexception::__clone' from='PECL amqp &gt;= Unknown'/>
<function name='amqpchannelexception::__construct' from='PECL amqp &gt;= Unknown'/>
<function name='amqpchannelexception::getmessage' from='PECL amqp &gt;= Unknown'/>
<function name='amqpchannelexception::getcode' from='PECL amqp &gt;= Unknown'/>
<function name='amqpchannelexception::getfile' from='PECL amqp &gt;= Unknown'/>
<function name='amqpchannelexception::getline' from='PECL amqp &gt;= Unknown'/>
<function name='amqpchannelexception::gettrace' from='PECL amqp &gt;= Unknown'/>
<function name='amqpchannelexception::getprevious' from='PECL amqp &gt;= Unknown'/>
<function name='amqpchannelexception::gettraceasstring' from='PECL amqp &gt;= Unknown'/>
<function name='amqpchannelexception::__tostring' from='PECL amqp &gt;= Unknown'/>
<function name='amqpqueueexception::__clone' from='PECL amqp &gt;= Unknown'/>
<function name='amqpqueueexception::__construct' from='PECL amqp &gt;= Unknown'/>
<function name='amqpqueueexception::getmessage' from='PECL amqp &gt;= Unknown'/>
@ -62,6 +100,16 @@
<function name='amqpqueueexception::getprevious' from='PECL amqp &gt;= Unknown'/>
<function name='amqpqueueexception::gettraceasstring' from='PECL amqp &gt;= Unknown'/>
<function name='amqpqueueexception::__tostring' from='PECL amqp &gt;= Unknown'/>
<function name='amqpexchangeexception::__clone' from='PECL amqp &gt;= Unknown'/>
<function name='amqpexchangeexception::__construct' from='PECL amqp &gt;= Unknown'/>
<function name='amqpexchangeexception::getmessage' from='PECL amqp &gt;= Unknown'/>
<function name='amqpexchangeexception::getcode' from='PECL amqp &gt;= Unknown'/>
<function name='amqpexchangeexception::getfile' from='PECL amqp &gt;= Unknown'/>
<function name='amqpexchangeexception::getline' from='PECL amqp &gt;= Unknown'/>
<function name='amqpexchangeexception::gettrace' from='PECL amqp &gt;= Unknown'/>
<function name='amqpexchangeexception::getprevious' from='PECL amqp &gt;= Unknown'/>
<function name='amqpexchangeexception::gettraceasstring' from='PECL amqp &gt;= Unknown'/>
<function name='amqpexchangeexception::__tostring' from='PECL amqp &gt;= Unknown'/>
</versions>
<!-- Keep this comment at the end of the file