setprefetchsize.xml

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