io.aeron.exceptions

Class RegistrationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

io.aeron.exceptions.AeronException

io.aeron.exceptions.RegistrationException

All Implemented Interfaces:

Serializable

public class RegistrationException
extends AeronException

Caused when an error occurs during addition, modification, or release of client resources such as Publications, Subscriptions, or Counters.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class io.aeron.exceptions.AeronException

AeronException.Category

Constructor Summary

Constructors

Constructor and Description
RegistrationException(long correlationId, int errorCodeValue, ErrorCode errorCode, String msg) Construct an exception to represent an error which occurred during registration of a resource such as a Publication, Subscription, or Counter.
RegistrationException(RegistrationException cause) Construct a from another to be nested, useful when exceptions are reported asynchronously and need to be rethrown from other places in the code.

Method Summary

Modifier and Type	Method and Description
long	correlationId() Get the correlation id of the command to register the resource action.
ErrorCode	errorCode() Get the ErrorCode for the specific exception.
int	errorCodeValue() Value of the errorCode() encoded as an int.

Methods inherited from class io.aeron.exceptions.AeronException

category, isFatal

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RegistrationException

public RegistrationException(long correlationId,
                             int errorCodeValue,
                             ErrorCode errorCode,
                             String msg)

Construct an exception to represent an error which occurred during registration of a resource such as a Publication, Subscription, or Counter.

Parameters:

correlationId - of the command to register the resource.

errorCodeValue - in case the ErrorCode is unknown to the client version.

errorCode - indicating type of error experienced by the media driver.

msg - proving more detail.

RegistrationException

public RegistrationException(RegistrationException cause)

Construct a from another to be nested, useful when exceptions are reported asynchronously and need to be rethrown from other places in the code.

Parameters:

cause - original RegistrationException to be stored as the exception cause.

Method Detail

correlationId

public long correlationId()

Get the correlation id of the command to register the resource action.

Returns:

the correlation id of the command to register the resource action.

errorCode

public ErrorCode errorCode()

Get the ErrorCode for the specific exception.

Returns:

the ErrorCode for the specific exception.

errorCodeValue

public int errorCodeValue()

Value of the errorCode() encoded as an int. This can provide additional information when a ErrorCode.UNKNOWN_CODE_VALUE is returned.

Returns:

value of the errorCode encoded as an int.