Class SearchTimeoutMessage


public final class SearchTimeoutMessage extends AntMessageFromHost
Configures the search timeout of 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
      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
      Since:
      4.0
      See Also:
  • Constructor Details

    • SearchTimeoutMessage

      public SearchTimeoutMessage(HighPrioritySearchTimeout searchTimeout)
      Constructs the message from the given high priority search timeout value.
      Parameters:
      searchTimeout - The search timeout the channel will use.
      Since:
      4.0
    • SearchTimeoutMessage

      protected SearchTimeoutMessage(byte[] messageContent)
  • Method Details

    • getRawSearchTimeout

      public int getRawSearchTimeout()
      Returns the raw search timeout value.
      Returns:
      The raw value that corresponds to a value in HighPrioritySearchTimeout
      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