<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Set the Quality Of Service settings for the given channel</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="amqpchannel.isconnected.html">AMQPChannel::isConnected</a></div>
<div class="next" style="text-align: right; float: right;"><a href="amqpchannel.rollbacktransaction.html">AMQPChannel::rollbackTransaction</a></div>
<div class="up"><a href="class.amqpchannel.html">AMQPChannel</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="amqpchannel.qos" class="refentry">
<div class="refnamediv">
<h1 class="refname">AMQPChannel::qos</h1>
<p class="verinfo">(PECL amqp >= Unknown)</p><p class="refpurpose"><span class="refname">AMQPChannel::qos</span> — <span class="dc-title">Set the Quality Of Service settings for the given channel</span></p>
</div>
<div class="refsect1 description" id="refsect1-amqpchannel.qos-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type"><span class="type void">void</span></span> <span class="methodname"><strong>AMQPChannel::qos</strong></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$size</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$count</code></span>
)</div>
<p class="para rdfs-comment">
Specify the amount of data to prefetch in terms of window size (octets) or number of messages from a queue during a <span class="methodname"><a href="amqpqueue.consume.html" class="methodname">AMQPQueue::consume()</a></span> or <span class="methodname"><a href="amqpqueue.get.html" class="methodname">AMQPQueue::get()</a></span> method call. The client will prefetch data up to <em><code class="parameter">size</code></em> octets or <em><code class="parameter">count</code></em> messages from the server, whichever limit is hit first.
</p>
<p class="para">
Setting either value to 0 will instruct the client to ignore that particular setting.
</p>
<p class="para">
A call to <span class="methodname"><strong>AMQPChannel::qos()</strong></span> will overwrite any values set by calling <span class="methodname"><a href="amqpchannel.setprefetchsize.html" class="methodname">AMQPChannel::setPrefetchSize()</a></span> and <span class="methodname"><a href="amqpchannel.setprefetchcount.html" class="methodname">AMQPChannel::setPrefetchCount()</a></span>.
</p>
<p class="para">If the call to either <span class="methodname"><a href="amqpqueue.consume.html" class="methodname">AMQPQueue::consume()</a></span> or <span class="methodname"><a href="amqpqueue.get.html" class="methodname">AMQPQueue::get()</a></span> is done with the <strong><code>AMQP_AUTOACK</code></strong> flag set, the client will not do any prefetching of data, regardless of the QOS settings.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-amqpchannel.qos-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<span class="term"><em><code class="parameter">size</code></em></span>
<dd>
<p class="para">
The window size, in octets, to prefetch.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">count</code></em></span>
<dd>
<p class="para">
The number of messages to prefetch.
</p>
</dd>
</dt>
</dl>
</div>
<div class="refsect1 errors" id="refsect1-amqpchannel.qos-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
Throws <strong class="classname">AMQPConnectionException</strong> if the connection to the broker was lost.
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-amqpchannel.qos-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="amqpchannel.isconnected.html">AMQPChannel::isConnected</a></div>
<div class="next" style="text-align: right; float: right;"><a href="amqpchannel.rollbacktransaction.html">AMQPChannel::rollbackTransaction</a></div>
<div class="up"><a href="class.amqpchannel.html">AMQPChannel</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
