svn: /phpdoc/en/trunk/reference/amqp/amqpexchange/ bind.xml construct.xml declare.xml delete.xml
| From: | Hannes Magnusson | Date: | Thu, 03 Feb 2011 13:10:21 +0000 |
| Subject: | svn: /phpdoc/en/trunk/reference/amqp/amqpexchange/ bind.xml construct.xml declare.xml delete.xml | ||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-7704@lists.php.net to get a copy of this message | ||
bjori Thu, 03 Feb 2011 13:10:21 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=307973
Log:
Added missing params, fix examples and added error refsect
Changed paths:
U phpdoc/en/trunk/reference/amqp/amqpexchange/bind.xml
U phpdoc/en/trunk/reference/amqp/amqpexchange/construct.xml
U phpdoc/en/trunk/reference/amqp/amqpexchange/declare.xml
U phpdoc/en/trunk/reference/amqp/amqpexchange/delete.xml
Modified: phpdoc/en/trunk/reference/amqp/amqpexchange/bind.xml
===================================================================
--- phpdoc/en/trunk/reference/amqp/amqpexchange/bind.xml 2011-02-03 13:09:37 UTC (rev 307972)
+++ phpdoc/en/trunk/reference/amqp/amqpexchange/bind.xml 2011-02-03 13:10:21 UTC (rev 307973)
@@ -46,7 +46,14 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
+ &return.success;
+ </para>
+ </refsect1>
+ <refsect1 role="errors">
+ &reftitle.errors;
+ <para>
+ Throws <classname>AMQPExchangeException</classname> on failure.
</para>
</refsect1>
Modified: phpdoc/en/trunk/reference/amqp/amqpexchange/construct.xml
===================================================================
--- phpdoc/en/trunk/reference/amqp/amqpexchange/construct.xml 2011-02-03 13:09:37 UTC (rev 307972)
+++ phpdoc/en/trunk/reference/amqp/amqpexchange/construct.xml 2011-02-03 13:10:21 UTC (rev 307973)
@@ -50,7 +50,15 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
+ An <classname>AMQPExchange</classname> object.
+ </para>
+ </refsect1>
+ <refsect1 role="errors">
+ &reftitle.errors;
+ <para>
+ Throws <classname>AMQPExchangeException</classname> when
+ <parameter>connection</parameter> is not connect to a broker.
</para>
</refsect1>
Modified: phpdoc/en/trunk/reference/amqp/amqpexchange/declare.xml
===================================================================
--- phpdoc/en/trunk/reference/amqp/amqpexchange/declare.xml 2011-02-03 13:09:37 UTC (rev 307972)
+++ phpdoc/en/trunk/reference/amqp/amqpexchange/declare.xml 2011-02-03 13:10:21 UTC (rev 307973)
@@ -13,7 +13,7 @@
<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>
+ <methodparam
choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</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
@@ -61,7 +61,14 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
+ &return.success;
+ </para>
+ </refsect1>
+ <refsect1 role="errors">
+ &reftitle.errors;
+ <para>
+ Throws <classname>AMQPExchangeException</classname> on failure.
</para>
</refsect1>
@@ -79,7 +86,7 @@
$cnn->connect();
$ex = new AMQPExchange($cnn);
-$ex->declare('new_topic_exchange', AMQP_DURABLE | AMQP_AUTODELETE);
+$ex->declare('new_topic_exchange', AMQP_EX_TYPE_DIRECT, AMQP_DURABLE |
AMQP_AUTODELETE);
?>
]]>
Modified: phpdoc/en/trunk/reference/amqp/amqpexchange/delete.xml
===================================================================
--- phpdoc/en/trunk/reference/amqp/amqpexchange/delete.xml 2011-02-03 13:09:37 UTC (rev 307972)
+++ phpdoc/en/trunk/reference/amqp/amqpexchange/delete.xml 2011-02-03 13:10:21 UTC (rev 307973)
@@ -12,6 +12,7 @@
<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>
+ <methodparam
choice="opt"><type>long</type><parameter>params</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
Delete and exchange from the broker.
@@ -35,6 +36,15 @@
</para>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><parameter>params</parameter></term>
+ <listitem>
+ <para>
+ Optionally <constant>AMQP_IFUNUSED</constant> can be specified to indicate the
exchange
+ should not be deleted until no clients are connected to it.
+ </para>
+ </listitem>
+ </varlistentry>
</variablelist>
</para>
</refsect1>
@@ -42,7 +52,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
-
+ &return.success;
</para>
</refsect1>
@@ -61,7 +71,7 @@
/* Create a new exchange */
$ex = new AMQPExchange($cnn);
-$ex->declare('new_topic_exchange', AMQP_DURABLE | AMQP_AUTODELETE);
+$ex->declare('new_topic_exchange', AMQP_EX_TYPE_DIRECT, AMQP_DURABLE |
AMQP_AUTODELETE);
/* Delete the previous exchange */
$ex2 = new AMQPExchange($cnn);
@@ -97,3 +107,4 @@
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
+