ErrorCode (Aeron Message Transport)

java.lang.Object
- java.lang.Enum<ErrorCode>
- - io.aeron.ErrorCode

All Implemented Interfaces:

Serializable, Comparable<ErrorCode>
```
public enum ErrorCode
extends 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.
`MALFORMED_COMMAND` Attempted to send a command that is malformed.
`NOT_SUPPORTED` Attempted to send a command known by the driver, but not currently supported.
`RESOURCE_TEMPORARILY_UNAVAILABLE` Attempted to send a command that referred to a resource that currently was unavailable.
`STORAGE_SPACE` Aeron encountered insufficient storage space while adding a resource.
`UNKNOWN_CODE_VALUE` A code value returned was not known.
`UNKNOWN_COMMAND_TYPE_ID` Attempted to send a command unknown by the driver.
`UNKNOWN_COUNTER` Attempted to reference a counter, but it was not found.
`UNKNOWN_HOST` Attempted to send a command that had a hostname that could not be resolved.
`UNKNOWN_PUBLICATION` Attempted to reference a publication, but it was not found.
`UNKNOWN_SUBSCRIPTION` Attempted to reference a subscription, but it was not found.
`UNUSED` Old generic value, no longer used (0 value clashes with success).

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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(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
  - UNUSED
```
public static final ErrorCode UNUSED
```
    Old generic value, no longer used (0 value clashes with success). Retained for version compatibility.
  - 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 reference a subscription, but it was not found.
  - UNKNOWN_PUBLICATION
```
public static final ErrorCode UNKNOWN_PUBLICATION
```
    Attempted to reference 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 reference a counter, but it was not found.
  - UNKNOWN_COMMAND_TYPE_ID
```
public static final ErrorCode UNKNOWN_COMMAND_TYPE_ID
```
    Attempted to send a command unknown by the driver.
  - MALFORMED_COMMAND
```
public static final ErrorCode MALFORMED_COMMAND
```
    Attempted to send a command that is malformed. Typically, too short.
  - NOT_SUPPORTED
```
public static final ErrorCode NOT_SUPPORTED
```
    Attempted to send a command known by the driver, but not currently supported.
  - UNKNOWN_HOST
```
public static final ErrorCode UNKNOWN_HOST
```
    Attempted to send a command that had a hostname that could not be resolved.
  - RESOURCE_TEMPORARILY_UNAVAILABLE
```
public static final ErrorCode RESOURCE_TEMPORARILY_UNAVAILABLE
```
    Attempted to send a command that referred to a resource that currently was unavailable.
  - GENERIC_ERROR
```
public static final ErrorCode GENERIC_ERROR
```
    Aeron encountered an error condition.
  - STORAGE_SPACE
```
public static final ErrorCode STORAGE_SPACE
```
    Aeron encountered insufficient storage space while adding a resource.
  - 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(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()
```
    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

Enum ErrorCode

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

UNUSED

INVALID_CHANNEL

UNKNOWN_SUBSCRIPTION

UNKNOWN_PUBLICATION

CHANNEL_ENDPOINT_ERROR

UNKNOWN_COUNTER

UNKNOWN_COMMAND_TYPE_ID

MALFORMED_COMMAND

NOT_SUPPORTED

UNKNOWN_HOST

RESOURCE_TEMPORARILY_UNAVAILABLE

GENERIC_ERROR

STORAGE_SPACE

UNKNOWN_CODE_VALUE

Method Detail

values

valueOf

value

get