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

Initial commit of AMQP documentation after preliminary approval from PHP Doc list.

Browse source 
Part 1 of 2 part commit. Associated commit is of doc-base.


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@300253 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Pieter de Zwart 2010-06-07 06:56:48 +00:00
parent 68fd4a4162
commit 76909071ad
31 changed files with 2634 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -0,0 +1,67 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<phpdoc:classref xml:id="class.amqpconnection" 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 AMQPConnection class</title>
<titleabbrev>AMQPConnection</titleabbrev>
<partintro>
<!-- {{{ AMQPConnection intro -->
<section xml:id="amqpconnection.intro">
&reftitle.intro;
<para>
Represents a connection to an AMQP broker.
</para>
</section>
<!-- }}} -->
<section xml:id="amqpconnection.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>AMQPConnection</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>AMQPConnection</classname>
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">Methods</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.amqpconnection')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
</classsynopsis>
<!-- }}} -->
</section>
</partintro>
&reference.amqp.entities.amqpconnection;
</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
-->

98
reference/amqp/amqpconnection/construct.xml Normal file
View file

@ -0,0 +1,98 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpconnection.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPConnection::__construct</refname>
<refpurpose>Create an instance of AMQPConnection</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<methodname>AMQPConnection::__construct</methodname>
<methodparam choice="opt"><type>array</type><parameter>credentials</parameter><initializer>array()</initializer></methodparam>
</methodsynopsis>
<para>
Creates an <classname>AMQPConnection</classname> instance representing a connection to an AMQP broker.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>credentials</parameter></term>
<listitem>
<para>
The <parameter>credentials</parameter> is an optional array of credential information for connecting to the AMQP
broker. The keys used in the <parameter>credentials</parameter> array are: host, port, vhost, login and password.
All other keys will be ignored.
</para>
<para>
For each missing credential, the extension will check the ini settings or use the default value.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
An AMQPConnection object.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>AMQPConnection::__construct</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
/* Create a connection using all default credentials: */
$connection1 = new AMQPConnection();
$connection2 = new AMQPConnection(array(
'host' => 'example.host',
'vhost' => '/',
'port' => 5763,
'login' => 'user',
'password' => 'password'
));
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

80
reference/amqp/amqpconnection/isconnected.xml Normal file
View file

@ -0,0 +1,80 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpconnection.isconnected" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPConnection::isConnected</refname>
<refpurpose>Determine if the AMQPConnection object is still connected to the broker.</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>AMQPConnection::isConnected</methodname>
<void />
</methodsynopsis>
<para>
This method will check whether the connection to the AMQP broker is still valid. It does so by checking
the return status of the last command.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>AMQPConnection::isConnected</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
/* Create a new connection */
$cnn = new AMQPConnection();
/* Check that connection is working */
if (!$cnn->isConnected()) {
die('The connection to the server was not established.');
}
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

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

@ -0,0 +1,112 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<phpdoc:classref xml:id="class.amqpconnectionexception" 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 AMQPConnectionException class</title>
<titleabbrev>AMQPConnectionException</titleabbrev>
<partintro>
<!-- {{{ AMQPConnectionException intro -->
<section xml:id="amqpconnectionexception.intro">
&reftitle.intro;
<para>
</para>
</section>
<!-- }}} -->
<section xml:id="amqpconnectionexception.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>AMQPConnectionException</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>AMQPConnectionException</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.amqpconnectionexception')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
<classsynopsisinfo role="comment">Inherited 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])" />
</classsynopsis>
<!-- }}} -->
</section>
<!-- {{{ AMQPConnectionException properties -->
<section xml:id="amqpconnectionexception.props">
&reftitle.properties;
<variablelist>
<varlistentry xml:id="amqpconnectionexception.props.message">
<term><varname>message</varname></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry xml:id="amqpconnectionexception.props.code">
<term><varname>code</varname></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry xml:id="amqpconnectionexception.props.file">
<term><varname>file</varname></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry xml:id="amqpconnectionexception.props.line">
<term><varname>line</varname></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
</partintro>
&reference.amqp.entities.amqpconnectionexception;
</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
-->

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

@ -0,0 +1,112 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<phpdoc:classref xml:id="class.amqpexception" 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 AMQPException class</title>
<titleabbrev>AMQPException</titleabbrev>
<partintro>
<!-- {{{ AMQPException intro -->
<section xml:id="amqpexception.intro">
&reftitle.intro;
<para>
</para>
</section>
<!-- }}} -->
<section xml:id="amqpexception.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>AMQPException</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>AMQPException</classname>
</ooclass>
<ooclass>
<modifier>extends</modifier>
<classname>Exception</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.amqpexception')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
<classsynopsisinfo role="comment">Inherited methods</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>
<!-- }}} -->
</section>
<!-- {{{ AMQPException properties -->
<section xml:id="amqpexception.props">
&reftitle.properties;
<variablelist>
<varlistentry xml:id="amqpexception.props.message">
<term><varname>message</varname></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry xml:id="amqpexception.props.code">
<term><varname>code</varname></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry xml:id="amqpexception.props.file">
<term><varname>file</varname></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry xml:id="amqpexception.props.line">
<term><varname>line</varname></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
</partintro>
&reference.amqp.entities.amqpexception;
</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
-->

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

@ -0,0 +1,67 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<phpdoc:classref xml:id="class.amqpexchange" 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 AMQPExchange class</title>
<titleabbrev>AMQPExchange</titleabbrev>
<partintro>
<!-- {{{ AMQPExchange intro -->
<section xml:id="amqpexchange.intro">
&reftitle.intro;
<para>
Represents an AMQP exchange.
</para>
</section>
<!-- }}} -->
<section xml:id="amqpexchange.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>AMQPExchange</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>AMQPExchange</classname>
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">Methods</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.amqpexchange')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
</classsynopsis>
<!-- }}} -->
</section>
</partintro>
&reference.amqp.entities.amqpexchange;
</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
-->

77
reference/amqp/amqpexchange/bind.xml Normal file
View file

@ -0,0 +1,77 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<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>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>AMQPExchange::bind</methodname>
<methodparam><type>string</type><parameter>queue_name</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>routing_key</parameter><initializer>""</initializer></methodparam>
</methodsynopsis>
<para>
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>queue_name</parameter></term>
<listitem>
<para>
The name of the queue to which to bind.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>routing_key</parameter></term>
<listitem>
<para>
The routing key to use as a binding.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</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
-->

78
reference/amqp/amqpexchange/construct.xml Normal file
View file

@ -0,0 +1,78 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpexchange.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPExchange::__construct</refname>
<refpurpose>Create an instance of AMQPExchange</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<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>
</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.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>AMQPConnection</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.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</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
-->

112
reference/amqp/amqpexchange/declare.xml Normal file
View file

@ -0,0 +1,112 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpexchange.declare" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPExchange::declare</refname>
<refpurpose>Declare a new exchange on the broker.</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</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>string</type><parameter>flags</parameter><initializer>NULL</initializer></methodparam>
</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.
</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>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>AMQPExchange::declare</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
/* Create a new connection */
$cnn = new AMQPConnection();
$ex = new AMQPExchange($cnn);
$ex->declare('new_topic_exchange', AMQP_DURABLE | AMQP_AUTODELETE);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

98
reference/amqp/amqpexchange/delete.xml Normal file
View file

@ -0,0 +1,98 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpexchange.delete" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPExchange::delete</refname>
<refpurpose>Delete the exchange from the broker.</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>AMQPExchange::delete</methodname>
<methodparam choice="opt"><type>string</type><parameter>exchange_name</parameter><initializer>NULL</initializer></methodparam>
</methodsynopsis>
<para>
Delete and exchange from the broker.
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<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>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>AMQPExchange::delete</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
/* Create a new connection */
$cnn = new AMQPConnection();
/* Create a new exchange */
$ex = new AMQPExchange($cnn);
$ex->declare('new_topic_exchange', AMQP_DURABLE | AMQP_AUTODELETE);
/* Delete the previous exchange */
$ex2 = new AMQPExchange($cnn);
$ex2->delete('new_topic_exchange');
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

77
reference/amqp/amqpexchange/publish.xml Normal file
View file

@ -0,0 +1,77 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpexchange.publish" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPExchange::publish</refname>
<refpurpose>Publish a message to an exchange.</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>AMQPExchange::publish</methodname>
<methodparam><type>string</type><parameter>message</parameter></methodparam>
<methodparam><type>string</type><parameter>routing_key</parameter></methodparam>
</methodsynopsis>
<para>
Publish a message to the exchange represented by the <classname>AMQPExchange</classname> object.
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>message</parameter></term>
<listitem>
<para>
The message to publish.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>routing_key</parameter></term>
<listitem>
<para>
The routing key to which to publish.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</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
-->

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

@ -0,0 +1,112 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<phpdoc:classref xml:id="class.amqpexchangeexception" 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 AMQPExchangeException class</title>
<titleabbrev>AMQPExchangeException</titleabbrev>
<partintro>
<!-- {{{ AMQPExchangeException intro -->
<section xml:id="amqpexchangeexception.intro">
&reftitle.intro;
<para>
</para>
</section>
<!-- }}} -->
<section xml:id="amqpexchangeexception.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>AMQPExchangeException</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>AMQPExchangeException</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.amqpexchangeexception')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
<classsynopsisinfo role="comment">Inherited 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])" />
</classsynopsis>
<!-- }}} -->
</section>
<!-- {{{ AMQPExchangeException properties -->
<section xml:id="amqpexchangeexception.props">
&reftitle.properties;
<variablelist>
<varlistentry xml:id="amqpexchangeexception.props.message">
<term><varname>message</varname></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry xml:id="amqpexchangeexception.props.code">
<term><varname>code</varname></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry xml:id="amqpexchangeexception.props.file">
<term><varname>file</varname></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry xml:id="amqpexchangeexception.props.line">
<term><varname>line</varname></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
</partintro>
&reference.amqp.entities.amqpexchangeexception;
</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
-->

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

@ -0,0 +1,67 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<phpdoc:classref xml:id="class.amqpqueue" 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 AMQPQueue class</title>
<titleabbrev>AMQPQueue</titleabbrev>
<partintro>
<!-- {{{ AMQPQueue intro -->
<section xml:id="amqpqueue.intro">
&reftitle.intro;
<para>
Represents an AMQP queue.
</para>
</section>
<!-- }}} -->
<section xml:id="amqpqueue.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>AMQPQueue</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>AMQPQueue</classname>
</ooclass>
</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>
<!-- }}} -->
</section>
</partintro>
&reference.amqp.entities.amqpqueue;
</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
-->

69
reference/amqp/amqpqueue/ack.xml Normal file
View file

@ -0,0 +1,69 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpqueue.ack" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPQueue::ack</refname>
<refpurpose>Acknowledge the receipt of a message</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>AMQPQueue::ack</methodname>
<methodparam><type>string</type><parameter>exchange_name</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>routing_key</parameter><initializer>""</initializer></methodparam>
</methodsynopsis>
<para>
This method allows the acknowledgement of a message that is retrieved with the <constant>AMQP_NOACK</constant> flag through
<methodname>AMQPQueue::get</methodname> or <methodname>AMQPQueue::consume</methodname>
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>delivery_tag</parameter></term>
<listitem>
<para>
The message delivery tag of which to acknowledge receipt.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</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
-->

77
reference/amqp/amqpqueue/bind.xml Normal file
View file

@ -0,0 +1,77 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpqueue.bind" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPQueue::bind</refname>
<refpurpose>Bind the given queue to a routing key on an exchange.</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>AMQPQueue::bind</methodname>
<methodparam><type>string</type><parameter>exchange_name</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>routing_key</parameter><initializer>""</initializer></methodparam>
</methodsynopsis>
<para>
The bind method will bind the given queue to the specified routing key on the given exchange.
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>exchange_name</parameter></term>
<listitem>
<para>
The exchange name on which to bind.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>routing_key</parameter></term>
<listitem>
<para>
The routing key to which to bind.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</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
-->

67
reference/amqp/amqpqueue/cancel.xml Normal file
View file

@ -0,0 +1,67 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpqueue.cancel" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPQueue::cancel</refname>
<refpurpose>Cancel a queue binding.</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>AMQPQueue::cancel</methodname>
<methodparam><type>string</type><parameter>consumer_tag</parameter></methodparam>
</methodsynopsis>
<para>
Cancel a queue that is already bound to an exchange and routing key.
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>consumer_tag</parameter></term>
<listitem>
<para>
The queue name to cancel, if the queue object is not already representative of a queue.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</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
-->

77
reference/amqp/amqpqueue/construct.xml Normal file
View file

@ -0,0 +1,77 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<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>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<methodname>AMQPQueue::__construct</methodname>
<methodparam><type>string</type><parameter>amqp_connection</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>queue_name</parameter><initializer>""</initializer></methodparam>
</methodsynopsis>
<para>
</para>
&warn.undocumented.func;
</refsect1>
<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.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</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
-->

77
reference/amqp/amqpqueue/consume.xml Normal file
View file

@ -0,0 +1,77 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpqueue.consume" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPQueue::consume</refname>
<refpurpose>The consume purpose</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>AMQPQueue::consume</methodname>
<methodparam><type>string</type><parameter>num_messages</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>flags</parameter><initializer>NULL</initializer></methodparam>
</methodsynopsis>
<para>
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>num_messages</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</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
-->

74
reference/amqp/amqpqueue/declare.xml Normal file
View file

@ -0,0 +1,74 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpqueue.declare" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPQueue::declare</refname>
<refpurpose>Declare a new queue</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>AMQPQueue::declare</methodname>
<methodparam><type>string</type><parameter>queue_name</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>flags</parameter><initializer>NULL</initializer></methodparam>
</methodsynopsis>
<para>
Declare a new queue.
</para>
</refsect1>
<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_NOACK</constant>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</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
-->

65
reference/amqp/amqpqueue/delete.xml Normal file
View file

@ -0,0 +1,65 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpqueue.delete" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPQueue::delete</refname>
<refpurpose>Delete a queue and its contents.</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>AMQPQueue::delete</methodname>
<methodparam><type>string</type><parameter>queue_name</parameter></methodparam>
</methodsynopsis>
<para>
Delete a queue from the broker, including its entire contents of unread or unacknowledged messages.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>queue_name</parameter></term>
<listitem>
<para>
The name of the queue to delete.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</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
-->

65
reference/amqp/amqpqueue/get.xml Normal file
View file

@ -0,0 +1,65 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpqueue.get" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPQueue::get</refname>
<refpurpose>Retrieve the next message from the queue.</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>AMQPQueue::get</methodname>
<methodparam><type>string</type><parameter>flags</parameter></methodparam>
</methodsynopsis>
<para>
Retrieve the next message from the queue.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
A bitmask of any of the flags: <constant>AMQP_NOACK</constant>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</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
-->

68
reference/amqp/amqpqueue/purge.xml Normal file
View file

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

77
reference/amqp/amqpqueue/unbind.xml Normal file
View file

@ -0,0 +1,77 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="amqpqueue.unbind" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPQueue::unbind</refname>
<refpurpose>Unbind the queue from a routing key.</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>AMQPQueue::unbind</methodname>
<methodparam><type>string</type><parameter>exchange_name</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>routing_key</parameter><initializer>""</initializer></methodparam>
</methodsynopsis>
<para>
Remove a routing key binding on an exchange from the given queue.
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>exchange_name</parameter></term>
<listitem>
<para>
The name of the exchange on which the queue is bound.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>routing_key</parameter></term>
<listitem>
<para>
The binding routing key used by the queue.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</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
-->

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

@ -0,0 +1,112 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<phpdoc:classref xml:id="class.amqpqueueexception" 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 AMQPQueueException class</title>
<titleabbrev>AMQPQueueException</titleabbrev>
<partintro>
<!-- {{{ AMQPQueueException intro -->
<section xml:id="amqpqueueexception.intro">
&reftitle.intro;
<para>
</para>
</section>
<!-- }}} -->
<section xml:id="amqpqueueexception.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>AMQPQueueException</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>AMQPQueueException</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.amqpqueueexception')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
<classsynopsisinfo role="comment">Inherited 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])" />
</classsynopsis>
<!-- }}} -->
</section>
<!-- {{{ AMQPQueueException properties -->
<section xml:id="amqpqueueexception.props">
&reftitle.properties;
<variablelist>
<varlistentry xml:id="amqpqueueexception.props.message">
<term><varname>message</varname></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry xml:id="amqpqueueexception.props.code">
<term><varname>code</varname></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry xml:id="amqpqueueexception.props.file">
<term><varname>file</varname></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry xml:id="amqpqueueexception.props.line">
<term><varname>line</varname></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
</partintro>
&reference.amqp.entities.amqpqueueexception;
</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
-->

52
reference/amqp/book.xml Normal file
View file

@ -0,0 +1,52 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<book xml:id="book.amqp" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<title>AMQP</title>
<titleabbrev>AMQP</titleabbrev>
<preface xml:id="intro.amqp">
&reftitle.intro;
<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
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
compatible AMQP brokers.
</para>
</preface>
&reference.amqp.setup;
&reference.amqp.constants;
&reference.amqp.examples;
&reference.amqp.amqpconnection;
&reference.amqp.amqpexchange;
&reference.amqp.amqpqueue;
</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
-->

55
reference/amqp/configure.xml Normal file
View file

@ -0,0 +1,55 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<section xml:id="amqp.installation" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.install;
<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:
</para>
<programlisting role="shell">
<![CDATA[
# Download the rabbitmq-c library
hg clone http://hg.rabbitmq.com/rabbitmq-c
cd rabbitmq-c
# Add the codegen requirement
hg clone http://hg.rabbitmq.com/rabbitmq-codegen codegen
# Configure, compile and install
autoreconf -i && ./configure && make && sudo make install
]]>
</programlisting>
<para>
download and compile the <filename>amqp.so</filename> file and add
an <filename>extension</filename> entry in your <filename>php.ini</filename> configuration file.
</para>
<para>
Note to Win32 users: This extension does not currently support win32 since the librabbitmq library does not yet support Win32.
</para>
</section>
<!-- 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
-->

217
reference/amqp/constants.xml Normal file
View file

@ -0,0 +1,217 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<appendix xml:id="amqp.constants" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.constants;
&extension.constants;
<para>
<variablelist>
<varlistentry>
<term>
<constant>AMQP_DURABLE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Durable exchanges and queues will survive a broker restart, complete with all of their data.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>AMQP_PASSIVE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Passive exchanges are queues will not be redeclared, but the broker will throw an error if the exchange or queue does not exist.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>AMQP_EXCLUSIVE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Valid for queues only, this flag indicates that only one client can be listening to and consuming from this queue.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>AMQP_AUTODELETE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
For exchanges, the auto delete flag indicates that the exchange will be deleted as soon as no more queues are bound to it.
If no queues were ever bound the exchange, the exchange will never be deleted.
</simpara>
<simpara>
For queues, the auto delete flag indicates that the queue will be deleted as soon as there are no more listeners subscribed to it.
If no subscription has ever been active, the queue will never be deleted.
</simpara>
<simpara>
Note: Exclusive queues will always be automatically deleted with the client disconnects.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>AMQP_INTERNAL</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Clients are not allowed to make specific queue bindings to exchanges defined with this flag.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>AMQP_NOLOCAL</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
When passed to the consume method for a clustered environment, do not consume from the local node.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>AMQP_NOACK</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
When passed to the consumer method, the messages will not be marked as delivered.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>AMQP_IFEMPTY</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Passed on queue creation, this flag indicates that the queue should be deleted if it becomes empty.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>AMQP_IFUNUSED</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Passed on queue or exchange creation, this flag indicates that the queue or exchange should be deleted when no clients are connected
to the given queue or exchange.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>AMQP_MANDATORY</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
When publishing a message, the message must be routed to a valid queue. If it is not, an error will be returned.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>AMQP_IMMEDIATE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
When publishing a message, mark this message for immediate processing by the broker. (High priority message.)
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>AMQP_MULTIPLE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
?
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>AMQP_EX_TYPE_DIRECT</constant>
(<type>string</type>)
</term>
<listitem>
<simpara>
A direct exchange type.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>AMQP_EX_TYPE_FANOUT</constant>
(<type>string</type>)
</term>
<listitem>
<simpara>
A fanout exchange type.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>AMQP_EX_TYPE_TOPIC</constant>
(<type>string</type>)
</term>
<listitem>
<simpara>
A topic exchange type.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>AMQP_EX_TYPE_HEADER</constant>
(<type>string</type>)
</term>
<listitem>
<simpara>
A header exchange type.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
</appendix>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

57
reference/amqp/examples.xml Normal file
View file

@ -0,0 +1,57 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<chapter xml:id="amqp.examples" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.examples;
<example>
<title>AMQP Example</title>
<programlisting role="php">
<![CDATA[
<?php
// Create a connection
$cnn = new AMQPConnection();
// Declare a new exchange
$ex = new AMQPExchange($cnn);
$ex->declare('exchange1', AMQP_EX_TYPE_FANOUT);
// Create a new queue
$q = new AMQPQueue($cnn, 'queue1');
$q->declare();
// Bind it on the exchange to routing.key
$ex->bind('queue1', 'routing.key');
// Publish a message to the exchange with a routing key
$ex->publish('message', 'routing.key');
// Read from the queue
$msg = $queue->consume(1);
?>
]]>
</programlisting>
</example>
</chapter>
<!-- 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
-->

138
reference/amqp/ini.xml Normal file
View file

@ -0,0 +1,138 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<section xml:id="amqp.configuration" xmlns="http://docbook.org/ns/docbook">
&reftitle.runtime;
&extension.runtime;
<para>
<table>
<title>Amqp &ConfigureOptions;</title>
<tgroup cols="4">
<thead>
<row>
<entry>&Name;</entry>
<entry>&Default;</entry>
<entry>&Changeable;</entry>
<entry>&Changelog;</entry>
</row>
</thead>
<tbody>
<row>
<entry>amqp.host</entry>
<entry>localhost</entry>
<entry>PHP_INI_ALL</entry>
<entry><!-- leave empty, this will be filled by an automatic script --></entry>
</row>
<row>
<entry>amqp.vhost</entry>
<entry>/</entry>
<entry>PHP_INI_ALL</entry>
<entry><!-- leave empty, this will be filled by an automatic script --></entry>
</row>
<row>
<entry>amqp.port</entry>
<entry>5672</entry>
<entry>PHP_INI_ALL</entry>
<entry><!-- leave empty, this will be filled by an automatic script --></entry>
</row>
<row>
<entry>amqp.login</entry>
<entry>guest</entry>
<entry>PHP_INI_ALL</entry>
<entry><!-- leave empty, this will be filled by an automatic script --></entry>
</row>
<row>
<entry>amqp.password</entry>
<entry>guest</entry>
<entry>PHP_INI_ALL</entry>
<entry><!-- leave empty, this will be filled by an automatic script --></entry>
</row>
</tbody>
</tgroup>
</table>
</para>
&ini.descriptions.title;
<para>
<variablelist>
<varlistentry xml:id="ini.amqp.host">
<term>
<parameter>amqp.host</parameter>
<type>string</type>
</term>
<listitem>
<para>
The host to which to connect.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.amqp.vhost">
<term>
<parameter>amqp.vhost</parameter>
<type>string</type>
</term>
<listitem>
<para>
The virtual host to which to connect on the host.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.amqp.port">
<term>
<parameter>amqp.port</parameter>
<type>integer</type>
</term>
<listitem>
<para>
The port on which to connect.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.amqp.login">
<term>
<parameter>amqp.login</parameter>
<type>string</type>
</term>
<listitem>
<para>
The login (username) used for authenticating against the host.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.amqp.password">
<term>
<parameter>amqp.password</parameter>
<type>string</type>
</term>
<listitem>
<para>
The password used for authenticating against the host.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</section>
<!-- 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
-->

44
reference/amqp/setup.xml Normal file
View file

@ -0,0 +1,44 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<chapter xml:id="amqp.setup" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.setup;
<section xml:id="amqp.requirements">
&reftitle.required;
<para>
This extension requires <link xlink:href="&url.amqp.librabbitmq;">librabbitmq</link> client library.
</para>
</section>
&reference.amqp.configure;
&reference.amqp.ini;
<section xml:id="amqp.resources">
&reftitle.resources;
&no.resource;
</section>
</chapter>
<!-- 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/versions.xml Normal file
View file

@ -0,0 +1,86 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!--
Do NOT translate this file
-->
<versions>
<!-- Methods -->
<function name='amqpconnection::__construct' from='PECL amqp &gt;= Unknown'/>
<function name='amqpconnection::isconnected' from='PECL amqp &gt;= Unknown'/>
<function name='amqpqueue::__construct' 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::cancel' from='PECL amqp &gt;= Unknown'/>
<function name='amqpexchange::__construct' 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'/>
<function name='amqpexchange::publish' from='PECL amqp &gt;= Unknown'/>
<function name='amqpexception::__clone' from='PECL amqp &gt;= Unknown'/>
<function name='amqpexception::__construct' from='PECL amqp &gt;= Unknown'/>
<function name='amqpexception::getmessage' from='PECL amqp &gt;= Unknown'/>
<function name='amqpexception::getcode' from='PECL amqp &gt;= Unknown'/>
<function name='amqpexception::getfile' from='PECL amqp &gt;= Unknown'/>
<function name='amqpexception::getline' from='PECL amqp &gt;= Unknown'/>
<function name='amqpexception::gettrace' from='PECL amqp &gt;= Unknown'/>
<function name='amqpexception::getprevious' from='PECL amqp &gt;= Unknown'/>
<function name='amqpexception::gettraceasstring' from='PECL amqp &gt;= Unknown'/>
<function name='amqpexception::__tostring' from='PECL amqp &gt;= Unknown'/>
<function name='amqpconnectionexception::__clone' from='PECL amqp &gt;= Unknown'/>
<function name='amqpconnectionexception::__construct' from='PECL amqp &gt;= Unknown'/>
<function name='amqpconnectionexception::getmessage' from='PECL amqp &gt;= Unknown'/>
<function name='amqpconnectionexception::getcode' from='PECL amqp &gt;= Unknown'/>
<function name='amqpconnectionexception::getfile' from='PECL amqp &gt;= Unknown'/>
<function name='amqpconnectionexception::getline' from='PECL amqp &gt;= Unknown'/>
<function name='amqpconnectionexception::gettrace' from='PECL amqp &gt;= Unknown'/>
<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='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'/>
<function name='amqpqueueexception::getcode' from='PECL amqp &gt;= Unknown'/>
<function name='amqpqueueexception::getfile' from='PECL amqp &gt;= Unknown'/>
<function name='amqpqueueexception::getline' from='PECL amqp &gt;= Unknown'/>
<function name='amqpqueueexception::gettrace' from='PECL amqp &gt;= Unknown'/>
<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'/>
</versions>
<!-- 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
-->