Permalink
Browse files

Updating AMQP Documentation for version 1.0.0

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk/reference/amqp@323238 c90b9560-bf6c-de11-be94-00142212c4b1
  • Loading branch information...
1 parent 522982b commit 9bb81c22d368c96aea4ec2938ce95efbd703803e pdezwart committed Feb 15, 2012
Showing with 3,837 additions and 320 deletions.
  1. +67 −0 amqpchannel.xml
  2. +65 −0 amqpchannel/committransaction.xml
  3. +71 −0 amqpchannel/construct.xml
  4. +56 −0 amqpchannel/isconnected.xml
  5. +86 −0 amqpchannel/qos.xml
  6. +65 −0 amqpchannel/rollbacktransaction.xml
  7. +75 −0 amqpchannel/setprefetchcount.xml
  8. +75 −0 amqpchannel/setprefetchsize.xml
  9. +62 −0 amqpchannel/starttransaction.xml
  10. +112 −0 amqpchannelexception.xml
  11. +5 −7 amqpconnection/construct.xml
  12. +55 −0 amqpconnection/gethost.xml
  13. +56 −0 amqpconnection/getlogin.xml
  14. +55 −0 amqpconnection/getpassword.xml
  15. +58 −0 amqpconnection/getport.xml
  16. +55 −0 amqpconnection/getvhost.xml
  17. +67 −0 amqpenvelope.xml
  18. +54 −0 amqpenvelope/getappid.xml
  19. +54 −0 amqpenvelope/getbody.xml
  20. +54 −0 amqpenvelope/getcontentencoding.xml
  21. +54 −0 amqpenvelope/getcontenttype.xml
  22. +54 −0 amqpenvelope/getcorrelationid.xml
  23. +54 −0 amqpenvelope/getdeliverytag.xml
  24. +54 −0 amqpenvelope/getexchange.xml
  25. +54 −0 amqpenvelope/getexpiration.xml
  26. +54 −0 amqpenvelope/getheader.xml
  27. +54 −0 amqpenvelope/getheaders.xml
  28. +54 −0 amqpenvelope/getmessageid.xml
  29. +54 −0 amqpenvelope/getpriority.xml
  30. +54 −0 amqpenvelope/getreplyto.xml
  31. +54 −0 amqpenvelope/getroutingkey.xml
  32. +54 −0 amqpenvelope/gettimestamp.xml
  33. +54 −0 amqpenvelope/gettype.xml
  34. +54 −0 amqpenvelope/getuserid.xml
  35. +54 −0 amqpenvelope/isredelivery.xml
  36. +3 −3 amqpexception.xml
  37. +20 −5 amqpexchange/bind.xml
  38. +8 −18 amqpexchange/construct.xml
  39. +16 −39 amqpexchange/declare.xml
  40. +15 −16 amqpexchange/delete.xml
  41. +63 −0 amqpexchange/getargument.xml
  42. +53 −0 amqpexchange/getarguments.xml
  43. +53 −0 amqpexchange/getflags.xml
  44. +55 −0 amqpexchange/getname.xml
  45. +55 −0 amqpexchange/gettype.xml
  46. +9 −4 amqpexchange/publish.xml
  47. +73 −0 amqpexchange/setargument.xml
  48. +64 −0 amqpexchange/setarguments.xml
  49. +64 −0 amqpexchange/setflags.xml
  50. +65 −0 amqpexchange/setname.xml
  51. +67 −0 amqpexchange/settype.xml
  52. +1 −1 amqpqueue.xml
  53. +17 −5 amqpqueue/ack.xml
  54. +10 −0 amqpqueue/bind.xml
  55. +10 −3 amqpqueue/cancel.xml
  56. +12 −21 amqpqueue/construct.xml
  57. +57 −38 amqpqueue/consume.xml
  58. +11 −20 amqpqueue/declare.xml
  59. +11 −12 amqpqueue/delete.xml
  60. +78 −80 amqpqueue/get.xml
  61. +64 −0 amqpqueue/getargument.xml
  62. +55 −0 amqpqueue/getarguments.xml
  63. +54 −0 amqpqueue/getflags.xml
  64. +56 −0 amqpqueue/getname.xml
  65. +89 −0 amqpqueue/nack.xml
  66. +10 −14 amqpqueue/purge.xml
  67. +73 −0 amqpqueue/setargument.xml
  68. +64 −0 amqpqueue/setarguments.xml
  69. +64 −0 amqpqueue/setflags.xml
  70. +64 −0 amqpqueue/setname.xml
  71. +10 −3 amqpqueue/unbind.xml
  72. +76 −0 book.developer.xml
  73. +8 −2 book.xml
  74. +7 −5 configure.xml
  75. +24 −3 constants.xml
  76. +5 −2 examples.xml
  77. +73 −5 ini.xml
  78. +32 −0 reference.xml
  79. +62 −14 versions.xml
View
67 amqpchannel.xml
@@ -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
+-->
View
65 amqpchannel/committransaction.xml
@@ -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
+-->
View
71 amqpchannel/construct.xml
@@ -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
+-->
View
56 amqpchannel/isconnected.xml
@@ -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
+-->
View
86 amqpchannel/qos.xml
@@ -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
+-->
View
65 amqpchannel/rollbacktransaction.xml
@@ -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
+-->
View
75 amqpchannel/setprefetchcount.xml
@@ -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
+-->
View
75 amqpchannel/setprefetchsize.xml
@@ -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
+-->
View
62 amqpchannel/starttransaction.xml
@@ -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
+-->
View
112 amqpchannelexception.xml
@@ -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
+-->
View
12 amqpconnection/construct.xml
@@ -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>
View
55 amqpconnection/gethost.xml
@@ -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
+-->
View
56 amqpconnection/getlogin.xml
@@ -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
+-->
View
55 amqpconnection/getpassword.xml
@@ -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
+-->
View
58 amqpconnection/getport.xml
@@ -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
+-->
View
55 amqpconnection/getvhost.xml
@@ -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
+-->
View
67 amqpenvelope.xml
@@ -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
+-->
View
54 amqpenvelope/getappid.xml
@@ -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
+-->
View
54 amqpenvelope/getbody.xml
@@ -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
+-->
View
54 amqpenvelope/getcontentencoding.xml
@@ -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
+-->
View
54 amqpenvelope/getcontenttype.xml
@@ -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
+-->
View
54 amqpenvelope/getcorrelationid.xml
@@ -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
+-->
View
54 amqpenvelope/getdeliverytag.xml
@@ -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
+-->
View
54 amqpenvelope/getexchange.xml
@@ -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
+-->
View
54 amqpenvelope/getexpiration.xml
@@ -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
+-->
View
54 amqpenvelope/getheader.xml
@@ -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
+-->
View
54 amqpenvelope/getheaders.xml
@@ -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
+-->
View
54 amqpenvelope/getmessageid.xml
@@ -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
+-->
View
54 amqpenvelope/getpriority.xml
@@ -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
+-->
View
54 amqpenvelope/getreplyto.xml
@@ -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
+-->
View
54 amqpenvelope/getroutingkey.xml
@@ -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
+-->
View
54 amqpenvelope/gettimestamp.xml
@@ -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
+-->
View
54 amqpenvelope/gettype.xml
@@ -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
+-->
View
54 amqpenvelope/getuserid.xml
@@ -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
+-->
View
54 amqpenvelope/isredelivery.xml
@@ -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
+-->
View
6 amqpexception.xml
@@ -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>
View
25 amqpexchange/bind.xml
@@ -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.