Enum Class LowPrioritySearchTimeout

java.lang.Object
java.lang.Enum<LowPrioritySearchTimeout>
com.dsi.ant.message.LowPrioritySearchTimeout
All Implemented Interfaces:
Serializable, Comparable<LowPrioritySearchTimeout>, Constable

public enum LowPrioritySearchTimeout extends Enum<LowPrioritySearchTimeout>
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
  • Enum Constant Details

  • Field Details

  • Method Details

    • values

      public static LowPrioritySearchTimeout[] 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 LowPrioritySearchTimeout 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
    • getRawValue

      public int getRawValue()
      Gets the raw value of this LowPrioritySearchTimeout. Applications should use the enumeration values directly.
      Since:
      4.0
    • create

      public static LowPrioritySearchTimeout create(int milliseconds)
      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