svn: /phpdoc/en/trunk/reference/amqp/amqpconnection/ setvhost.xml

bjori Wed, 02 Feb 2011 14:03:40 +0000 Revision: http://svn.php.net/viewvc?view=revision&revision=307956 Log: Missing method Changed paths: A phpdoc/en/trunk/reference/amqp/amqpconnection/setvhost.xml Added: phpdoc/en/trunk/reference/amqp/amqpconnection/setvhost.xml =================================================================== --- phpdoc/en/trunk/reference/amqp/amqpconnection/setvhost.xml (rev 0) +++ phpdoc/en/trunk/reference/amqp/amqpconnection/setvhost.xml 2011-02-02 14:03:40 UTC (rev 307956) @@ -0,0 +1,96 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 306340 $ --> + +<refentry xml:id="amqpconnection.setvhost" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <refnamediv> + <refname>AMQPConnection::setVhost</refname> + <refpurpose>Set the amqp virtual host</refpurpose> + </refnamediv> + + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <modifier>public</modifier> <type>void</type><methodname>AMQPConnection::setVhost</methodname> + <methodparam><type>string</type><parameter>vhost</parameter></methodparam> + </methodsynopsis> + <para> + Sets the virtual host to which to connect on the AMQP broker. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>host</parameter></term> + <listitem> + <para> + The virtual host to use on the AMQP broker. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="errors"> + &reftitle.errors; + <para> + Throws an <classname>AMQPConnectionException</classname> if + <parameter>host</parameter> is longer then 32characters. + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>AMQPConnection::setVhost</function> example</title> + <programlisting role="php"> +<![CDATA[ +<?php + +/* Create a new connection */ +$cnn = new AMQPConnection(); + +// set the hostname +$cnn->setVhost('myvhost'); + +?> +]]> + </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 +-->