php-doc-en/reference/amqp/amqpexchange/construct.xml
2011-02-03 13:10:21 +00:00

86 lines
2.4 KiB
XML

<?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>
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>
</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
-->