com.dsi.ant.message.fromhost

Class AcknowledgedDataMessageFromHost

java.lang.Object

com.dsi.ant.message.AntMessage

com.dsi.ant.message.fromhost.AntMessageFromHost

com.dsi.ant.message.fromhost.DataMessageFromHost

com.dsi.ant.message.fromhost.AcknowledgedDataMessageFromHost

public final class AcknowledgedDataMessageFromHost
extends DataMessageFromHost

Can be used as a replacement for BroadcastDataMessageFromHost and expects an acknowledgement message back from the slave being transmitted to.

Since:

4.0

Field Summary

Fields inherited from class com.dsi.ant.message.fromhost.DataMessageFromHost

LENGTH_STANDARD_PAYLOAD, OFFSET_PAYLOAD_START

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
AcknowledgedDataMessageFromHost(byte[] payload) Constructs the message from the message bytes.

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.
byte[]	getPayload() Gets the payload of the data message.

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

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

Constructor Detail

AcknowledgedDataMessageFromHost

public AcknowledgedDataMessageFromHost(byte[] payload)

Constructs the message from the message bytes.

Parameters:

payload - The received message bytes.

Since:

4.0

Method Detail

getPayload

public byte[] getPayload()

Description copied from class: DataMessageFromHost

Gets the payload of the data message.

Specified by:

getPayload in class DataMessageFromHost

Returns:

The payload of the data message.

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