Package com.dsi.ant.message
Enum Class LowPrioritySearchTimeout
- All Implemented Interfaces:
Serializable
,Comparable<LowPrioritySearchTimeout>
,Constable
The duration the slave channel will search for a master channel, in low priority mode. This
will impact other channels open on the same Adapter.
- Since:
- 4.0
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionDisabling the search time out effectively sets it to 0 seconds, and it will immediately time out. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final LowPrioritySearchTimeout
The timeout value set after a channel is assignedstatic final LowPrioritySearchTimeout
The highest possible timeout value -
Method Summary
Modifier and TypeMethodDescriptionint
Get the time value of this search timeout.static LowPrioritySearchTimeout
create
(int milliseconds) Will round millisecond value up to nearest timeout value in 2.5 second increments.int
Gets the raw value of this LowPrioritySearchTimeout.static LowPrioritySearchTimeout
Returns the enum constant of this class with the specified name.static LowPrioritySearchTimeout[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
DISABLED
Disabling the search time out effectively sets it to 0 seconds, and it will immediately time out. -
TWO_AND_A_HALF_SECONDS
-
FIVE_SECONDS
-
SEVEN_AND_A_HALF_SECONDS
-
TEN_SECONDS
-
TWELVE_AND_A_HALF_SECONDS
-
FIFTEEN_SECONDS
-
SEVENTEEN_AND_A_HALF_SECONDS
-
TWENTY_SECONDS
-
TWENTY_TWO_AND_A_HALF_SECONDS
-
TWENTY_FIVE_SECONDS
-
-
Field Details
-
DEFAULT
The timeout value set after a channel is assigned- Since:
- 4.0
-
MAX
The highest possible timeout value- Since:
- 4.0
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-
getRawValue
public int getRawValue()Gets the raw value of this LowPrioritySearchTimeout. Applications should use the enumeration values directly.- Since:
- 4.0
-
create
Will round millisecond value up to nearest timeout value in 2.5 second increments.- Parameters:
milliseconds
- How long a search is required to run for, in millisecond units.- Returns:
- A search timeout value closest to, but at least the amount of, time requested not exceeding the maximum.
- Since:
- 4.0
-
convertToMilliseconds
public int convertToMilliseconds()Get the time value of this search timeout.- Returns:
- timeout in milliseconds
- Since:
- 4.0
-