Class LowPrioritySearchTimeoutMessage

java.lang.Object
com.dsi.ant.message.AntMessage
com.dsi.ant.message.fromhost.AntMessageFromHost
com.dsi.ant.message.fromhost.LowPrioritySearchTimeoutMessage

public final class LowPrioritySearchTimeoutMessage extends AntMessageFromHost
Configures the low priority search timeout for the channel when searching.
Since:
4.0
  • Field Details

    • OFFSET_SEARCH_TIMEOUT

      public static final int OFFSET_SEARCH_TIMEOUT
      The message content offset to the search timeout value
      Since:
      4.0
      See Also:
    • SIZE_SEARCH_TIMEOUT

      public static final int SIZE_SEARCH_TIMEOUT
      The number of bytes to be used for the search timeout value
      Since:
      4.0
      See Also:
  • Constructor Details

    • LowPrioritySearchTimeoutMessage

      public LowPrioritySearchTimeoutMessage(LowPrioritySearchTimeout searchTimeout)
      Constructs the message from the given low priority search timeout.
      Parameters:
      searchTimeout - The LowPrioritySearchTimeout.
      Since:
      4.0
    • LowPrioritySearchTimeoutMessage

      protected LowPrioritySearchTimeoutMessage(byte[] messageContent)
  • Method Details

    • getRawSearchTimeout

      public int getRawSearchTimeout()
      Gets the raw value of low priority search timeout enumeration value.
      Returns:
      The raw value of the LowPrioritySearchTimeout.
      Since:
      4.0
    • getMessageContent

      public byte[] getMessageContent(int channelNumber, int networkNumber)
      Description copied from class: AntMessageFromHost
      The content of the message with specified channel number and network number set if required.
      Specified by:
      getMessageContent in class AntMessageFromHost
      Parameters:
      channelNumber - Written to the channel number byte if required
      networkNumber - Written to the network number byte if required
      Returns:
      Message content raw byte array.
      Since:
      4.0
    • getMessageType

      public MessageFromHostType getMessageType()
      Description copied from class: AntMessageFromHost
      The unique type of this message based on its message id, contents, and intended channel type.

      It is recommended to use this rather than the raw message ID.

      Specified by:
      getMessageType in class AntMessageFromHost
      Returns:
      The type of message returned by the host.
      Since:
      4.0
    • toString

      public String toString()
      Overrides:
      toString in class AntMessageFromHost