<!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>Acknowledge the receipt of a message</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="class.amqpqueue.html">AMQPQueue</a></div>
<div class="next" style="text-align: right; float: right;"><a href="amqpqueue.bind.html">AMQPQueue::bind</a></div>
<div class="up"><a href="class.amqpqueue.html">AMQPQueue</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="amqpqueue.ack" class="refentry">
<div class="refnamediv">
<h1 class="refname">AMQPQueue::ack</h1>
<p class="verinfo">(PECL amqp >= Unknown)</p><p class="refpurpose"><span class="refname">AMQPQueue::ack</span> — <span class="dc-title">Acknowledge the receipt of a message</span></p>
</div>
<div class="refsect1 description" id="refsect1-amqpqueue.ack-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><strong>AMQPQueue::ack</strong></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$delivery_tag</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$flags</code><span class="initializer"> = <strong><code>AMQP_NOPARAM</code></strong></span></span>
] )</div>
<p class="para rdfs-comment">
This method allows the acknowledgement of a message that is retrieved without the <strong><code>AMQP_AUTOACK</code></strong> flag through
<span class="methodname"><a href="amqpqueue.get.html" class="methodname">AMQPQueue::get()</a></span> or <span class="methodname"><a href="amqpqueue.consume.html" class="methodname">AMQPQueue::consume()</a></span>
</p>
</div>
<div class="refsect1 parameters" id="refsect1-amqpqueue.ack-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">delivery_tag</code></em></span>
<dd>
<p class="para">
The message delivery tag of which to acknowledge receipt.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">flags</code></em></span>
<dd>
<p class="para">
The only valid flag that can be passed is <strong><code>AMQP_MULTIPLE</code></strong>.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 errors" id="refsect1-amqpqueue.ack-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
Throws <strong class="classname">AMQPChannelException</strong> if the channel is not open.
</p>
<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-amqpqueue.ack-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 class="refsect1 examples" id="refsect1-amqpqueue.ack-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4199">
<p><strong>Example #1 <span class="methodname"><strong>AMQPQueue::ack()</strong></span> example with <span class="methodname"><a href="amqpqueue.get.html" class="methodname">AMQPQueue::get()</a></span></strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br /></span><span style="color: #FF8000">/* Create a connection using all default credentials: */<br /></span><span style="color: #0000BB">$connection </span><span style="color: #007700">= new </span><span style="color: #0000BB">AMQPConnection</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$connection</span><span style="color: #007700">-></span><span style="color: #0000BB">connect</span><span style="color: #007700">();<br /><br /></span><span style="color: #0000BB">$channel </span><span style="color: #007700">= new </span><span style="color: #0000BB">AMQPChannel</span><span style="color: #007700">(</span><span style="color: #0000BB">$connection</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* create a queue object */<br /></span><span style="color: #0000BB">$queue </span><span style="color: #007700">= new </span><span style="color: #0000BB">AMQPQueue</span><span style="color: #007700">(</span><span style="color: #0000BB">$channel</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">//declare the queue<br /></span><span style="color: #0000BB">$queue</span><span style="color: #007700">-></span><span style="color: #0000BB">declare</span><span style="color: #007700">(</span><span style="color: #DD0000">'myqueue'</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">//get the next message, but don't mark it as delivered<br /></span><span style="color: #0000BB">$message </span><span style="color: #007700">= </span><span style="color: #0000BB">$queue</span><span style="color: #007700">-></span><span style="color: #0000BB">get</span><span style="color: #007700">(</span><span style="color: #0000BB">AMQP_NOPARAM</span><span style="color: #007700">);<br /><br />echo </span><span style="color: #0000BB">$message</span><span style="color: #007700">[</span><span style="color: #DD0000">'msg'</span><span style="color: #007700">];<br /><br /></span><span style="color: #FF8000">//acknowledge the message as received<br /></span><span style="color: #0000BB">$queue</span><span style="color: #007700">-></span><span style="color: #0000BB">ack</span><span style="color: #007700">(</span><span style="color: #0000BB">$message</span><span style="color: #007700">[</span><span style="color: #DD0000">'delivery_tag'</span><span style="color: #007700">]);<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
<div class="example" id="example-4200">
<p><strong>Example #2 <span class="methodname"><strong>AMQPQueue::ack()</strong></span> example with <span class="methodname"><a href="amqpqueue.consume.html" class="methodname">AMQPQueue::consume()</a></span></strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br /></span><span style="color: #FF8000">/* Create a connection using all default credentials: */<br /></span><span style="color: #0000BB">$connection </span><span style="color: #007700">= new </span><span style="color: #0000BB">AMQPConnection</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$connection</span><span style="color: #007700">-></span><span style="color: #0000BB">connect</span><span style="color: #007700">();<br /><br /></span><span style="color: #FF8000">/* create a queue object */<br /></span><span style="color: #0000BB">$queue </span><span style="color: #007700">= new </span><span style="color: #0000BB">AMQPQueue</span><span style="color: #007700">(</span><span style="color: #0000BB">$connection</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">//declare the queue<br /></span><span style="color: #0000BB">$queue</span><span style="color: #007700">-></span><span style="color: #0000BB">declare</span><span style="color: #007700">(</span><span style="color: #DD0000">'myqueue'</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$options </span><span style="color: #007700">= array(<br /> </span><span style="color: #DD0000">'min' </span><span style="color: #007700">=> </span><span style="color: #0000BB">1</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'max' </span><span style="color: #007700">=> </span><span style="color: #0000BB">10</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'ack' </span><span style="color: #007700">=> </span><span style="color: #0000BB">false<br /></span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">//get the messages, but don't mark them as delivered<br /></span><span style="color: #0000BB">$messages </span><span style="color: #007700">= </span><span style="color: #0000BB">$queue</span><span style="color: #007700">-></span><span style="color: #0000BB">consume</span><span style="color: #007700">(</span><span style="color: #0000BB">$options</span><span style="color: #007700">);<br /><br />foreach (</span><span style="color: #0000BB">$messages </span><span style="color: #007700">as </span><span style="color: #0000BB">$message</span><span style="color: #007700">) {<br /> echo </span><span style="color: #0000BB">$message</span><span style="color: #007700">[</span><span style="color: #DD0000">'message_body'</span><span style="color: #007700">];<br /> </span><span style="color: #FF8000">//acknowledge the message as received<br /> </span><span style="color: #0000BB">$queue</span><span style="color: #007700">-></span><span style="color: #0000BB">ack</span><span style="color: #007700">(</span><span style="color: #0000BB">$message</span><span style="color: #007700">[</span><span style="color: #DD0000">'delivery_tag'</span><span style="color: #007700">]);<br />}<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="class.amqpqueue.html">AMQPQueue</a></div>
<div class="next" style="text-align: right; float: right;"><a href="amqpqueue.bind.html">AMQPQueue::bind</a></div>
<div class="up"><a href="class.amqpqueue.html">AMQPQueue</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
