Module org.refcodes.serial

Package org.refcodes.serial

Class FlowControlTimeoutException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.io.IOException

org.refcodes.exception.AbstractIOException

org.refcodes.serial.SerialException

org.refcodes.serial.TransmissionException

org.refcodes.serial.FlowControlException

org.refcodes.serial.FlowControlTimeoutException

All Implemented Interfaces:

Serializable, org.refcodes.exception.ErrorCodeAccessor, org.refcodes.exception.Trap, org.refcodes.mixin.TimeoutInMsAccessor

Direct Known Subclasses:

FlowControlRetryException

public class FlowControlTimeoutException
extends FlowControlException
implements org.refcodes.mixin.TimeoutInMsAccessor

Thrown in case a flow control failed due t a timeout.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.exception.ErrorCodeAccessor

org.refcodes.exception.ErrorCodeAccessor.ErrorCodeBuilder<B extends org.refcodes.exception.ErrorCodeAccessor.ErrorCodeBuilder<B>>, org.refcodes.exception.ErrorCodeAccessor.ErrorCodeMutator, org.refcodes.exception.ErrorCodeAccessor.ErrorCodeProperty

Nested classes/interfaces inherited from interface org.refcodes.mixin.TimeoutInMsAccessor

org.refcodes.mixin.TimeoutInMsAccessor.TimeoutInMsBuilder<B extends org.refcodes.mixin.TimeoutInMsAccessor.TimeoutInMsBuilder<B>>, org.refcodes.mixin.TimeoutInMsAccessor.TimeoutInMsMutator, org.refcodes.mixin.TimeoutInMsAccessor.TimeoutInMsProperty

Constructor Summary

Constructors

Constructor	Description
FlowControlTimeoutException(long aTimeoutInMs, String aMessage)
FlowControlTimeoutException(long aTimeoutInMs, String aMessage, String aErrorCode)
FlowControlTimeoutException(long aTimeoutInMs, String aMessage, Throwable aCause)
FlowControlTimeoutException(long aTimeoutInMs, String aMessage, Throwable aCause, String aErrorCode)
FlowControlTimeoutException(long aTimeoutInMs, Throwable aCause)
FlowControlTimeoutException(long aTimeoutInMs, Throwable aCause, String aErrorCode)

Method Summary

Modifier and Type	Method	Description
long	getTimeoutInMs()	The timeout attribute in milliseconds.

Methods inherited from class org.refcodes.exception.AbstractIOException

getErrorCode

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 Details

FlowControlTimeoutException

public FlowControlTimeoutException(long aTimeoutInMs,
String aMessage,
String aErrorCode)

Parameters:

aTimeoutInMs - The timeout in milliseconds causing the exception.

FlowControlTimeoutException

public FlowControlTimeoutException(long aTimeoutInMs,
String aMessage,
Throwable aCause,
String aErrorCode)

Parameters:

aTimeoutInMs - The timeout in milliseconds causing the exception.

FlowControlTimeoutException

public FlowControlTimeoutException(long aTimeoutInMs,
String aMessage,
Throwable aCause)

Parameters:

aTimeoutInMs - The timeout in milliseconds causing the exception.

FlowControlTimeoutException

public FlowControlTimeoutException(long aTimeoutInMs,
String aMessage)

Parameters:

aTimeoutInMs - The timeout in milliseconds causing the exception.

FlowControlTimeoutException

public FlowControlTimeoutException(long aTimeoutInMs,
Throwable aCause,
String aErrorCode)

Parameters:

aTimeoutInMs - The timeout in milliseconds causing the exception.

FlowControlTimeoutException

public FlowControlTimeoutException(long aTimeoutInMs,
Throwable aCause)

Parameters:

aTimeoutInMs - The timeout in milliseconds causing the exception.

Method Details

getTimeoutInMs

public long getTimeoutInMs()

The timeout attribute in milliseconds.

Specified by:

getTimeoutInMs in interface org.refcodes.mixin.TimeoutInMsAccessor

Returns:

An integer with the timeout in milliseconds.