Package com.dsi.ant.message.fromhost

Class CloseChannelMessage

java.lang.Object

com.dsi.ant.message.AntMessage

com.dsi.ant.message.fromhost.AntMessageFromHost

com.dsi.ant.message.fromhost.CloseChannelMessage

public final class CloseChannelMessage
extends AntMessageFromHost

Message sent to ANT to close the channel.

Since:

4.0

Field Summary

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

Modifier	Constructor	Description
	CloseChannelMessage()	Constructs the message.
protected	CloseChannelMessage(byte[] messageContent)	Create from raw message content for this message.

Method Summary

Modifier and Type	Method	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.
String	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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

CloseChannelMessage

public CloseChannelMessage()

Constructs the message.

Since:

4.0

CloseChannelMessage

protected CloseChannelMessage(byte[] messageContent)

Create from raw message content for this message.

Parameters:

messageContent - Not used, as this could only include channel number.

Method Details

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