<!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>Cancel a queue binding.</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="amqpqueue.bind.html">AMQPQueue::bind</a></div>
<div class="next" style="text-align: right; float: right;"><a href="amqpqueue.construct.html">AMQPQueue::__construct</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.cancel" class="refentry">
<div class="refnamediv">
<h1 class="refname">AMQPQueue::cancel</h1>
<p class="verinfo">(PECL amqp >= Unknown)</p><p class="refpurpose"><span class="refname">AMQPQueue::cancel</span> — <span class="dc-title">Cancel a queue binding.</span></p>
</div>
<div class="refsect1 description" id="refsect1-amqpqueue.cancel-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::cancel</strong></span>
([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$consumer_tag</code><span class="initializer"> = ""</span></span>
] )</div>
<p class="para rdfs-comment">
Cancel a queue that is already bound to an exchange and routing key.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-amqpqueue.cancel-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">consumer_tag</code></em></span>
<dd>
<p class="para">
The queue name to cancel, if the queue object is not already representative of a queue.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 errors" id="refsect1-amqpqueue.cancel-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.cancel-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="amqpqueue.bind.html">AMQPQueue::bind</a></div>
<div class="next" style="text-align: right; float: right;"><a href="amqpqueue.construct.html">AMQPQueue::__construct</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>
