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

public final class SearchTimeoutMessage
extends AntMessageFromHost

Configures the search timeout of the channel when searching.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field and Description
static int	OFFSET_SEARCH_TIMEOUT The message content offset to the search timeout
static int	SIZE_SEARCH_TIMEOUT The number of bytes to be used for the search timeout

Fields 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

Constructors

Constructor and Description
SearchTimeoutMessage(HighPrioritySearchTimeout searchTimeout) Constructs the message from the given high priority search timeout value.

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	getMessageContent(int channelNumber, int networkNumber) The content of the message with specified channel number and network number set if required.
MessageFromHostType	getMessageType() The unique type of this message based on its message id, contents, and intended channel type.
int	getRawSearchTimeout() Returns the raw search timeout value.
java.lang.String	toString()

Methods inherited from class com.dsi.ant.message.fromhost.AntMessageFromHost

createAntMessage, getMessageContent, getMessageContent, getMessageId, getRawMessage

Methods inherited from class com.dsi.ant.message.AntMessage

equals, getMessageContentString, getMessageIdString, hashCode, maskChannelNumber

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

OFFSET_SEARCH_TIMEOUT

public static final int OFFSET_SEARCH_TIMEOUT

The message content offset to the search timeout

Since:

4.0

See Also:

Constant Field Values

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:

Constant Field Values

Constructor Detail

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

Method Detail

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 java.lang.String toString()

Overrides:

toString in class AntMessageFromHost