php-doc-en/reference/amqp/ini.xml

<?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><link linkend="ini.amqp.host">amqp.host</link></entry>
      <entry>localhost</entry>
      <entry>PHP_INI_ALL</entry>
      <entry><!-- leave empty, this will be filled by an automatic script --></entry>
     </row>
     <row>
      <entry><link linkend="ini.amqp.vhost">amqp.vhost</link></entry>
      <entry>/</entry>
      <entry>PHP_INI_ALL</entry>
      <entry><!-- leave empty, this will be filled by an automatic script --></entry>
     </row>
     <row>
      <entry><link linkend="ini.amqp.port">amqp.port</link></entry>
      <entry>5672</entry>
      <entry>PHP_INI_ALL</entry>
      <entry><!-- leave empty, this will be filled by an automatic script --></entry>
     </row>
     <row>
      <entry><link linkend="ini.amqp.login">amqp.login</link></entry>
      <entry>guest</entry>
      <entry>PHP_INI_ALL</entry>
      <entry><!-- leave empty, this will be filled by an automatic script --></entry>
     </row>
     <row>
      <entry><link linkend="ini.amqp.password">amqp.password</link></entry>
      <entry>guest</entry>
      <entry>PHP_INI_ALL</entry>
      <entry><!-- leave empty, this will be filled by an automatic script --></entry>
     </row>
     <row>
      <entry><link linkend="ini.amqp.auto-ack">amqp.auto_ack</link></entry>
      <entry>0</entry>
      <entry>PHP_INI_ALL</entry>
      <entry><!-- leave empty, this will be filled by an automatic script --></entry>
     </row>
     <row>
      <entry><link linkend="ini.amqp.min-messages">amqp.min_messages</link></entry>
      <entry>0</entry>
      <entry>PHP_INI_ALL</entry>
      <entry><!-- leave empty, this will be filled by an automatic script --></entry>
     </row>
     <row>
      <entry><link linkend="ini.amqp.max-messages">amqp.max_messages</link></entry>
      <entry>1</entry>
      <entry>PHP_INI_ALL</entry>
      <entry><!-- leave empty, this will be filled by an automatic script --></entry>
     </row>
     <row>
      <entry><link linkend="ini.amqp.prefetch-count">amqp.prefetch_count</link></entry>
      <entry>3</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 on the broker to which to connect.
      </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 to use while connecting to the broker.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="ini.amqp.password">
     <term>
      <parameter>amqp.password</parameter>
      <type>string</type>
     </term>
     <listitem>
      <para>
       The password to use while connecting to the broker.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="ini.amqp.auto-ack">
     <term>
      <parameter>amqp.auto_ack</parameter>
      <type>integer</type>
     </term>
     <listitem>
      <para>
       Whether calls to <methodname>AMQPQueue::get</methodname> and <methodname>AMQPQueue::consume</methodname> should require that the client explicitly acknowledge messages. Setting this value to 1 will pass in the <constant>AMQP_AUTOACK</constant> flag to the above method calls if the <literal>flags</literal> field is omitted. 
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="ini.amqp.min-messages">
     <term>
      <parameter>amqp.min_messages</parameter>
      <type>integer</type>
     </term>
     <listitem>
      <para>
       The minimum number of messages to require during a call to <methodname>AMQPQueue::consume</methodname>. 
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="ini.amqp.max-messages">
     <term>
      <parameter>amqp.max_messages</parameter>
      <type>integer</type>
     </term>
     <listitem>
      <para>
       The maximum number of messages to require during a call to <methodname>AMQPQueue::consume</methodname>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="ini.amqp.prefetch-count">
     <term>
      <parameter>amqp.prefetch_count</parameter>
      <type>integer</type>
     </term>
     <listitem>
      <para>
       The number of messages to prefect from the server during a call to <methodname>AMQPQueue::get</methodname> or <methodname>AMQPQueue::consume</methodname> during which the <constant>AMQP_AUTOACK</constant> flag is not set.
      </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
-->