io.aeron.exceptions

Class ControlProtocolException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

io.aeron.exceptions.AeronException

io.aeron.exceptions.ControlProtocolException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

InvalidChannelException

public class ControlProtocolException
extends AeronException

Indicates an invalid use of the control protocol when sending commands from the client to driver.

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
ControlProtocolException(ErrorCode code, Exception rootCause) Construct an exception to indicate an invalid command has been sent to the media driver.
ControlProtocolException(ErrorCode code, String msg) Construct an exception to indicate an invalid command has been sent to the media driver.

Method Summary

Modifier and Type	Method and Description
ErrorCode	errorCode() The ErrorCode indicating more specific issue experienced by the media driver.

Methods inherited from class io.aeron.exceptions.AeronException

category

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

ControlProtocolException

public ControlProtocolException(ErrorCode code,
                                String msg)

Construct an exception to indicate an invalid command has been sent to the media driver.

Parameters:

code - for the type of error.

msg - providing more detail.

ControlProtocolException

public ControlProtocolException(ErrorCode code,
                                Exception rootCause)

Construct an exception to indicate an invalid command has been sent to the media driver.

Parameters:

code - for the type of error.

rootCause - of the error.

Method Detail

errorCode

public ErrorCode errorCode()

The ErrorCode indicating more specific issue experienced by the media driver.

Returns:

ErrorCode indicating more specific issue experienced by the media driver.