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
87
88
89
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 327195 $ -->
<refentry xml:id="amqpqueue.nack" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPQueue::nack</refname>
<refpurpose>Mark a message as explicitly not acknowledged.</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>AMQPQueue::nack</methodname>
<methodparam><type>string</type><parameter>delivery_tag</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>flags</parameter><initializer><constant>AMQP_NOPARAM</constant></initializer></methodparam>
</methodsynopsis>
<para>
Mark the message identified by <parameter>delivery_tag</parameter> as explicitly not acknowledged. This method can only be called on messages that have not yet been acknowledged, meaning that messages retrieved with by <methodname>AMQPQueue::consume</methodname> and <methodname>AMQPQueue::get</methodname> and using the <constant>AMQP_AUTOACK</constant> flag are not eligible.
</para>
<para>
When called, the broker will immediately put the message back onto the queue, instead of waiting until the connection is closed.
</para>
<para>
This method is only supported by the RabbitMQ broker. The behavior of calling this method while connected to any other broker is undefined.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>delivery_tag</parameter></term>
<listitem>
<para>
The delivery tag by which to identify the message.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
A bitmask of flags.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Throws <classname>AMQPChannelException</classname> if the channel is not open.
</para>
<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
-->
|
