io.lettuce.core

Enum XNackMode

java.lang.Object

java.lang.Enum<XNackMode>

io.lettuce.core.XNackMode

All Implemented Interfaces:

ProtocolKeyword, Serializable, Comparable<XNackMode>

public enum XNackMode
extends Enum<XNackMode>
implements ProtocolKeyword

Nacking mode for the XNACK command. Determines how the delivery counter of the negatively-acknowledged messages is adjusted in the consumer group's Pending Entries List.

Since:

7.6

Enum Constant Summary

Enum Constants

Enum Constant and Description
FAIL Used when the message causes problems for this consumer but may succeed for other consumers (e.g., requires more resources than available).
FATAL Used for invalid or suspected malicious messages.
SILENT Used when the consumer is NACKing due to internal errors or shutdown, not because the message is problematic.

Field Summary

Fields

Modifier and Type	Field and Description
byte[]	bytes

Method Summary

Modifier and Type	Method and Description
byte[]	getBytes()
static XNackMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static XNackMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.lettuce.core.protocol.ProtocolKeyword

name, toString

Enum Constant Detail

SILENT

public static final XNackMode SILENT

Used when the consumer is NACKing due to internal errors or shutdown, not because the message is problematic. The delivery counter of each specified message is decremented by 1.

FAIL

public static final XNackMode FAIL

Used when the message causes problems for this consumer but may succeed for other consumers (e.g., requires more resources than available). The delivery counter stays the same.

FATAL

public static final XNackMode FATAL

Used for invalid or suspected malicious messages. The delivery counter is set to LLONG_MAX.

Field Detail

bytes

public final byte[] bytes

Method Detail

values

public static XNackMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (XNackMode c : XNackMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static XNackMode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getBytes

public byte[] getBytes()

Specified by:

getBytes in interface ProtocolKeyword

Returns:

byte[] encoded representation.