com.dsi.ant.message.fromhost

Class SetNetworkKeyMessage

java.lang.Object

com.dsi.ant.message.AntMessage

com.dsi.ant.message.fromhost.AntMessageFromHost

com.dsi.ant.message.fromhost.SetNetworkKeyMessage

Direct Known Subclasses:

SetLongNetworkKeyMessage, SetShortNetworkKeyMessage

public abstract class SetNetworkKeyMessage
extends AntMessageFromHost

Contains the common values and logic for constructing the different types of network key messages.

Since:

4.3

Field Summary

Fields

Modifier and Type	Field and Description
static int	OFFSET_NETWORK_KEY The message content offset to the network key
static int	OFFSET_NETWORK_NUMBER The message content offset to the network number.
static int	SIZE_NETWORK_NUMBER The size in bytes of the network number

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
SetNetworkKeyMessage(byte[] networkKey) Constructs the message with given network key byte array

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.
byte[]	getRawNetworkKey() Get the network key contained in this message.
java.lang.String	toString()

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

createAntMessage, getMessageContent, getMessageContent, getMessageId, getMessageType, 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_NETWORK_NUMBER

public static final int OFFSET_NETWORK_NUMBER

The message content offset to the network number.

Since:

4.3

See Also:

Constant Field Values

OFFSET_NETWORK_KEY

public static final int OFFSET_NETWORK_KEY

The message content offset to the network key

Since:

4.3

See Also:

Constant Field Values

SIZE_NETWORK_NUMBER

public static final int SIZE_NETWORK_NUMBER

The size in bytes of the network number

Since:

4.3

See Also:

Constant Field Values

Constructor Detail

SetNetworkKeyMessage

public SetNetworkKeyMessage(byte[] networkKey)

Constructs the message with given network key byte array

Parameters:

networkKey - The byte array containing the network key.

Throws:

java.lang.IllegalArgumentException - Occurs when received an invalid network key byte array (null or invalid length)

Since:

4.3

Method Detail

getRawNetworkKey

public byte[] getRawNetworkKey()

Get the network key contained in this message.

Since:

4.3

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.

toString

public java.lang.String toString()

Overrides:

toString in class AntMessageFromHost