Package com.dsi.ant.message.fromhost
Class SearchTimeoutMessage
java.lang.Object
com.dsi.ant.message.AntMessage
com.dsi.ant.message.fromhost.AntMessageFromHost
com.dsi.ant.message.fromhost.SearchTimeoutMessage
Configures the search timeout of the channel when searching.
- Since:
- 4.0
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
The message content offset to the search timeoutstatic final int
The number of bytes to be used for the search timeoutFields inherited from class com.dsi.ant.message.AntMessage
BITMASK_CHANNEL_NUMBER, FILLER_BYTE, OFFSET_CHANNEL_NUMBER, RAW_OFFSET_MESSAGE_CONTENT_START, RAW_OFFSET_MESSAGE_ID, RAW_OFFSET_MESSAGE_SIZE, SIZE_CHANNEL_NUMBER, SIZE_FILLER_BYTE
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
SearchTimeoutMessage
(byte[] messageContent) SearchTimeoutMessage
(HighPrioritySearchTimeout searchTimeout) Constructs the message from the given high priority search timeout value. -
Method Summary
Modifier and TypeMethodDescriptionbyte[]
getMessageContent
(int channelNumber, int networkNumber) The content of the message with specified channel number and network number set if required.The unique type of this message based on its message id, contents, and intended channel type.int
Returns the raw search timeout value.toString()
Methods inherited from class com.dsi.ant.message.fromhost.AntMessageFromHost
createAntMessage, createAntMessage, getMessageContent, getMessageContent, getMessageId, getRawMessage, toStringHeader
Methods inherited from class com.dsi.ant.message.AntMessage
equals, getMessageContentString, getMessageIdString, hashCode, maskChannelNumber
-
Field Details
-
OFFSET_SEARCH_TIMEOUT
public static final int OFFSET_SEARCH_TIMEOUTThe message content offset to the search timeout- Since:
- 4.0
- See Also:
-
SIZE_SEARCH_TIMEOUT
public static final int SIZE_SEARCH_TIMEOUTThe number of bytes to be used for the search timeout- Since:
- 4.0
- See Also:
-
-
Constructor Details
-
SearchTimeoutMessage
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 classAntMessageFromHost
- Parameters:
channelNumber
- Written to the channel number byte if requirednetworkNumber
- Written to the network number byte if required- Returns:
- Message content raw byte array.
- Since:
- 4.0
-
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 classAntMessageFromHost
- Returns:
- The type of message returned by the host.
- Since:
- 4.0
-
toString
- Overrides:
toString
in classAntMessageFromHost
-