io.aeron.exceptions

Class AeronException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

io.aeron.exceptions.AeronException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ActiveDriverException, AeronEvent, ArchiveException, AuthenticationException, ChannelEndpointException, ClusterException, ConcurrentConcludeException, ConfigurationException, ControlProtocolException, RegistrationException, StorageSpaceException, TimeoutException, UnknownSubscriptionException

public class AeronException
extends RuntimeException

Base Aeron exception for catching all Aeron specific errors.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AeronException.Category Category of Exception.

Constructor Summary

Constructors

Constructor and Description
AeronException() Default Aeron exception as AeronException.Category.ERROR.
AeronException(AeronException.Category category) Default Aeron exception with provided AeronException.Category.
AeronException(String message) Aeron exception with provided message and AeronException.Category.ERROR.
AeronException(String message, AeronException.Category category) Aeron exception with a detailed message and provided AeronException.Category.
AeronException(String message, Throwable cause) Aeron exception with a detailed message, cause, and AeronException.Category.ERROR.
AeronException(String message, Throwable cause, AeronException.Category category) Aeron exception with a detailed message, cause, and AeronException.Category.
AeronException(String message, Throwable cause, boolean enableSuppression, boolean writableStackTrace) Constructs a new Aeron exception with a detail message, cause, suppression enabled or disabled, and writable stack trace enabled or disabled, in the category AeronException.Category.ERROR.
AeronException(String message, Throwable cause, boolean enableSuppression, boolean writableStackTrace, AeronException.Category category) Constructs a new Aeron exception with a detail message, cause, suppression enabled or disabled, writable stack trace enabled or disabled, an AeronException.Category.
AeronException(Throwable cause) Aeron exception with provided cause and AeronException.Category.ERROR.
AeronException(Throwable cause, AeronException.Category category) Aeron exception with cause and provided AeronException.Category.

Method Summary

Modifier and Type	Method and Description
AeronException.Category	category() AeronException.Category of exception for determining what follow-up action can be taken.
static boolean	isFatal(Throwable t) Determines if a Throwable is a AeronException.Category.FATAL if an AeronException.

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

AeronException

public AeronException()

Default Aeron exception as AeronException.Category.ERROR.

AeronException

public AeronException(AeronException.Category category)

Default Aeron exception with provided AeronException.Category.

Parameters:

category - of this exception.

AeronException

public AeronException(String message)

Aeron exception with provided message and AeronException.Category.ERROR.

Parameters:

message - to detail the exception.

AeronException

public AeronException(Throwable cause)

Aeron exception with provided cause and AeronException.Category.ERROR.

Parameters:

cause - of the error.

AeronException

public AeronException(String message,
                      AeronException.Category category)

Aeron exception with a detailed message and provided AeronException.Category.

Parameters:

message - providing detail on the error.

category - of the exception.

AeronException

public AeronException(String message,
                      Throwable cause)

Aeron exception with a detailed message, cause, and AeronException.Category.ERROR.

Parameters:

message - providing detail on the error.

cause - of the error.

AeronException

public AeronException(Throwable cause,
                      AeronException.Category category)

Aeron exception with cause and provided AeronException.Category.

Parameters:

cause - of the error.

category - of the exception.

AeronException

public AeronException(String message,
                      Throwable cause,
                      AeronException.Category category)

Aeron exception with a detailed message, cause, and AeronException.Category.

Parameters:

message - providing detail on the error.

cause - of the error.

category - of the exception.

AeronException

public AeronException(String message,
                      Throwable cause,
                      boolean enableSuppression,
                      boolean writableStackTrace)

Constructs a new Aeron exception with a detail message, cause, suppression enabled or disabled, and writable stack trace enabled or disabled, in the category AeronException.Category.ERROR.

Parameters:

message - providing detail on the error.

cause - of the error.

enableSuppression - is suppression enabled or not.

writableStackTrace - is the stack trace writable or not.

AeronException

public AeronException(String message,
                      Throwable cause,
                      boolean enableSuppression,
                      boolean writableStackTrace,
                      AeronException.Category category)

Constructs a new Aeron exception with a detail message, cause, suppression enabled or disabled, writable stack trace enabled or disabled, an AeronException.Category.

Parameters:

message - providing detail on the error.

cause - of the error.

enableSuppression - is suppression enabled or not.

writableStackTrace - is the stack trace writable or not.

category - of the exception.

Method Detail

category

public AeronException.Category category()

AeronException.Category of exception for determining what follow-up action can be taken.

Returns:

AeronException.Category of exception for determining what follow-up action can be taken.

isFatal

public static boolean isFatal(Throwable t)

Determines if a Throwable is a AeronException.Category.FATAL if an AeronException.

Parameters:

t - throwable to check if fatal.

Returns:

true if this is an AeronException with a category set to AeronException.Category.FATAL, false otherwise.