Module org.refcodes.data

Package org.refcodes.data

Enum Class IoTimeout

java.lang.Object

java.lang.Enum<IoTimeout>

org.refcodes.data.IoTimeout

All Implemented Interfaces:

Serializable, Comparable<IoTimeout>, Constable, org.refcodes.mixin.TimeMillisAccessor

public enum IoTimeout
extends Enum<IoTimeout>
implements org.refcodes.mixin.TimeMillisAccessor

The IoTimeout defines values used inside a IO processing control flow.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

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

org.refcodes.mixin.TimeMillisAccessor.TimeMillisBuilder<B extends org.refcodes.mixin.TimeMillisAccessor.TimeMillisBuilder<B>>, org.refcodes.mixin.TimeMillisAccessor.TimeMillisMutator, org.refcodes.mixin.TimeMillisAccessor.TimeMillisProperty

Enum Constant Summary

Enum Constants

Enum Constant	Description
MAX
MIN
NORM

Field Summary

Fields

Modifier and Type	Field	Description
static final int	TIMEOUT_DIVIDER

Method Summary

Modifier and Type	Method	Description
int	getTimeMillis()
static long	toSenseTimeoutTimeframeInMs(long aIoTimeoutInMs)	Determines the timeout to securely sense for a given timeout.
static long	toTimeoutSleepLoopTimeInMs(long aIoTimeoutInMs)	Determines the sleep time within an I/O polling timeout loop.
static IoTimeout	valueOf(String name)	Returns the enum constant of this class with the specified name.
static IoTimeout[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

MIN

public static final IoTimeout MIN

NORM

public static final IoTimeout NORM

MAX

public static final IoTimeout MAX

Field Details

TIMEOUT_DIVIDER

public static final int TIMEOUT_DIVIDER

See Also:

• Constant Field Values

Method Details

values

public static IoTimeout[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static IoTimeout valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getTimeMillis

public int getTimeMillis()

Specified by:

getTimeMillis in interface org.refcodes.mixin.TimeMillisAccessor

toTimeoutSleepLoopTimeInMs

public static long toTimeoutSleepLoopTimeInMs(long aIoTimeoutInMs)

Determines the sleep time within an I/O polling timeout loop.

Parameters:

aIoTimeoutInMs - The overall I/O timeout.

Returns:

The "recommended" loop sleep time during polling.

toSenseTimeoutTimeframeInMs

public static long toSenseTimeoutTimeframeInMs(long aIoTimeoutInMs)

Determines the timeout to securely sense for a given timeout.

Parameters:

aIoTimeoutInMs - The overall I/O timeout within which to sense.

Returns:

The "recommended" timeout to securely sense within the given timeout.