1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 323281 $ -->
<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
-->
|
