<!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>The AMQPQueue class</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="amqpexchange.settype.html">AMQPExchange::setType</a></div>
<div class="next" style="text-align: right; float: right;"><a href="amqpqueue.ack.html">AMQPQueue::ack</a></div>
<div class="up"><a href="book.amqp.html">AMQP</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="class.amqpqueue" class="reference">
<h1 class="title">The AMQPQueue class</h1>
<div class="partintro"><p class="verinfo">(PECL amqp >= Unknown)</p>
<div class="section" id="amqpqueue.intro">
<h2 class="title">Introduction</h2>
<p class="para">
Represents an AMQP queue.
</p>
</div>
<div class="section" id="amqpqueue.synopsis">
<h2 class="title">Class synopsis</h2>
<div class="classsynopsis">
<div class="ooclass"></div>
<div class="classsynopsisinfo">
<span class="ooclass">
<strong class="classname">AMQPQueue</strong>
</span>
{</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Methods */</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="amqpqueue.ack.html" class="methodname">ack</a></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>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="amqpqueue.bind.html" class="methodname">bind</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$exchange_name</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$routing_key</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="amqpqueue.cancel.html" class="methodname">cancel</a></span>
([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$consumer_tag</code><span class="initializer"> = ""</span></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="methodname"><a href="amqpqueue.construct.html" class="methodname">__construct</a></span>
( <span class="methodparam"><span class="type"><a href="class.amqpchannel.html" class="type AMQPChannel">AMQPChannel</a></span> <code class="parameter">$amqp_channel</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="amqpqueue.consume.html" class="methodname">consume</a></span>
( <span class="methodparam"><span class="type"><a href="language.types.callable.html" class="type callable">callable</a></span> <code class="parameter">$callback</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>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="amqpqueue.declare.html" class="methodname">declare</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span><span class="type">bool</span> <span class="methodname"><a href="amqpqueue.delete.html" class="methodname">delete</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="amqpqueue.get.html" class="methodname">get</a></span>
([ <span class="methodparam"><span class="type">int</span> <code class="parameter">$flags</code><span class="initializer"> = ini_get("amqp.auto_ack")</span></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="amqpqueue.getargument.html" class="methodname">getArgument</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$key</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">array</span> <span class="methodname"><a href="amqpqueue.getarguments.html" class="methodname">getArguments</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="amqpqueue.getflags.html" class="methodname">getFlags</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="amqpqueue.getname.html" class="methodname">getName</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="amqpqueue.nack.html" class="methodname">nack</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$delivery_tag</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$flags</code><span class="initializer"> = <strong><code>AMQP_NOPARAM</code></strong></span></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="amqpqueue.purge.html" class="methodname">purge</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="amqpqueue.setargument.html" class="methodname">setArgument</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$key</code></span>
, <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$value</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="amqpqueue.setarguments.html" class="methodname">setArguments</a></span>
( <span class="methodparam"><span class="type">array</span> <code class="parameter">$arguments</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="amqpqueue.setflags.html" class="methodname">setFlags</a></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$flags</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="amqpqueue.setname.html" class="methodname">setName</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$queue_name</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="amqpqueue.unbind.html" class="methodname">unbind</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$exchange_name</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$routing_key</code></span>
)</div>
}</div>
</div>
</div>
<h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="amqpqueue.ack.html">AMQPQueue::ack</a> — Acknowledge the receipt of a message</li><li><a href="amqpqueue.bind.html">AMQPQueue::bind</a> — Bind the given queue to a routing key on an exchange.</li><li><a href="amqpqueue.cancel.html">AMQPQueue::cancel</a> — Cancel a queue binding.</li><li><a href="amqpqueue.construct.html">AMQPQueue::__construct</a> — Create an instance of an AMQPQueue object</li><li><a href="amqpqueue.consume.html">AMQPQueue::consume</a> — Consume messages from a queue</li><li><a href="amqpqueue.declare.html">AMQPQueue::declare</a> — Declare a new queue</li><li><a href="amqpqueue.delete.html">AMQPQueue::delete</a> — Delete a queue and its contents.</li><li><a href="amqpqueue.get.html">AMQPQueue::get</a> — Retrieve the next message from the queue.</li><li><a href="amqpqueue.getargument.html">AMQPQueue::getArgument</a> — Get the argument associated with the given key</li><li><a href="amqpqueue.getarguments.html">AMQPQueue::getArguments</a> — Get all arguments set on the given queue</li><li><a href="amqpqueue.getflags.html">AMQPQueue::getFlags</a> — Get the flag bitmask</li><li><a href="amqpqueue.getname.html">AMQPQueue::getName</a> — Get the configured name</li><li><a href="amqpqueue.nack.html">AMQPQueue::nack</a> — Mark a message as explicitly not acknowledged.</li><li><a href="amqpqueue.purge.html">AMQPQueue::purge</a> — Purge the contents of a queue</li><li><a href="amqpqueue.setargument.html">AMQPQueue::setArgument</a> — Set the value for the given key</li><li><a href="amqpqueue.setarguments.html">AMQPQueue::setArguments</a> — Set all arguments on the queue</li><li><a href="amqpqueue.setflags.html">AMQPQueue::setFlags</a> — Set the queue flags</li><li><a href="amqpqueue.setname.html">AMQPQueue::setName</a> — Set the queue name</li><li><a href="amqpqueue.unbind.html">AMQPQueue::unbind</a> — Unbind the queue from a routing key.</li></ul>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="amqpexchange.settype.html">AMQPExchange::setType</a></div>
<div class="next" style="text-align: right; float: right;"><a href="amqpqueue.ack.html">AMQPQueue::ack</a></div>
<div class="up"><a href="book.amqp.html">AMQP</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
