io.aeron

Enum ErrorCode

java.lang.Object

java.lang.Enum<ErrorCode>

io.aeron.ErrorCode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ErrorCode>

public enum ErrorCode
extends java.lang.Enum<ErrorCode>

Error codes between media driver and client and the on-wire protocol.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CHANNEL_ENDPOINT_ERROR Channel Endpoint could not be successfully opened.
GENERIC_ERROR Aeron encountered an error condition.
INVALID_CHANNEL A failure occurred creating a new channel or parsing the channel string.
UNKNOWN_CODE_VALUE A code value returned was not known.
UNKNOWN_COUNTER Attempted to remove a counter, but it was not found.
UNKNOWN_PUBLICATION Attempted to remove a publication, but it was not found.
UNKNOWN_SUBSCRIPTION Attempted to remove a subscription, but it was not found

Method Summary

Modifier and Type	Method and Description
static ErrorCode	get(int value) Get the ErrorCode that corresponds to the given value.
int	value() Get the value of this ErrorCode.
static ErrorCode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ErrorCode[]	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

GENERIC_ERROR

public static final ErrorCode GENERIC_ERROR

Aeron encountered an error condition.

INVALID_CHANNEL

public static final ErrorCode INVALID_CHANNEL

A failure occurred creating a new channel or parsing the channel string.

UNKNOWN_SUBSCRIPTION

public static final ErrorCode UNKNOWN_SUBSCRIPTION

Attempted to remove a subscription, but it was not found

UNKNOWN_PUBLICATION

public static final ErrorCode UNKNOWN_PUBLICATION

Attempted to remove a publication, but it was not found.

CHANNEL_ENDPOINT_ERROR

public static final ErrorCode CHANNEL_ENDPOINT_ERROR

Channel Endpoint could not be successfully opened.

UNKNOWN_COUNTER

public static final ErrorCode UNKNOWN_COUNTER

Attempted to remove a counter, but it was not found.

UNKNOWN_CODE_VALUE

public static final ErrorCode UNKNOWN_CODE_VALUE

A code value returned was not known.

Method Detail

values

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

Returns:

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

valueOf

public static ErrorCode valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

value

public int value()

Get the value of this ErrorCode.

Returns:

The value.

get

public static ErrorCode get(int value)

Get the ErrorCode that corresponds to the given value.

Parameters:

value - of the ErrorCode

Returns:

ErrorCode