io.aeron.cluster.codecs

Enum CloseReason

java.lang.Object

java.lang.Enum<CloseReason>

io.aeron.cluster.codecs.CloseReason

All Implemented Interfaces:

Serializable, Comparable<CloseReason>

public enum CloseReason
extends Enum<CloseReason>

Reason why a session was closed.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLIENT_ACTION Client closed the session.
NULL_VAL To be used to represent not present or null.
SERVICE_ACTION Service closed the session.
TIMEOUT Session timed out due to inactivity.

Method Summary

Modifier and Type	Method and Description
static CloseReason	get(int value) Lookup the enum value representing the value.
int	value() The raw encoded value in the Java type representation.
static CloseReason	valueOf(String name) Returns the enum constant of this type with the specified name.
static CloseReason[]	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

Enum Constant Detail

CLIENT_ACTION

public static final CloseReason CLIENT_ACTION

Client closed the session.

SERVICE_ACTION

public static final CloseReason SERVICE_ACTION

Service closed the session.

TIMEOUT

public static final CloseReason TIMEOUT

Session timed out due to inactivity.

NULL_VAL

public static final CloseReason NULL_VAL

To be used to represent not present or null.

Method Detail

values

public static CloseReason[] 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 (CloseReason c : CloseReason.values())
    System.out.println(c);

Returns:

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

valueOf

public static CloseReason 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

value

public int value()

The raw encoded value in the Java type representation.

Returns:

the raw value encoded.

get

public static CloseReason get(int value)

Lookup the enum value representing the value.

Parameters:

value - encoded to be looked up.

Returns:

the enum value representing the value.