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.TimeoutMillisAccessor

Direct Known Subclasses:

FlowControlRetryException

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

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.TimeoutMillisAccessor

org.refcodes.mixin.TimeoutMillisAccessor.TimeoutMillisBuilder<B extends org.refcodes.mixin.TimeoutMillisAccessor.TimeoutMillisBuilder<B>>, org.refcodes.mixin.TimeoutMillisAccessor.TimeoutMillisMutator, org.refcodes.mixin.TimeoutMillisAccessor.TimeoutMillisProperty

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
long	getTimeoutMillis()	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

Methods inherited from interface org.refcodes.exception.Trap

getPatternArguments, toLocalizedMessage, toMessage, toMessage, toMessage, toShortLocalizedMessage, toShortMessage

Constructor Details

FlowControlTimeoutException

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

Parameters:

aTimeoutMillis - The timeout in milliseconds causing the exception.

FlowControlTimeoutException

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

Parameters:

aTimeoutMillis - The timeout in milliseconds causing the exception.

FlowControlTimeoutException

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

Parameters:

aTimeoutMillis - The timeout in milliseconds causing the exception.

FlowControlTimeoutException

public FlowControlTimeoutException(long aTimeoutMillis,
 String aMessage)

Parameters:

aTimeoutMillis - The timeout in milliseconds causing the exception.

FlowControlTimeoutException

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

Parameters:

aTimeoutMillis - The timeout in milliseconds causing the exception.

FlowControlTimeoutException

public FlowControlTimeoutException(long aTimeoutMillis,
 Throwable aCause)

Parameters:

aTimeoutMillis - The timeout in milliseconds causing the exception.

Method Details

getTimeoutMillis

public long getTimeoutMillis()

The timeout attribute in milliseconds.

Specified by:

getTimeoutMillis in interface org.refcodes.mixin.TimeoutMillisAccessor

Returns:

An long integer with the timeout in milliseconds.