Interface RawMessage

All Superinterfaces:

Message

All Known Implementing Classes:

BTHandshake, BTKeepAlive, BTRawMessage, RawMessageAdapter, RawMessageImpl

public interface RawMessage
extends Message

A raw data message designed for advanced queueing.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	PRIORITY_HIGH
static final int	PRIORITY_LOW
static final int	PRIORITY_NORMAL

Fields inherited from interface Message

TYPE_DATA_PAYLOAD, TYPE_PROTOCOL_PAYLOAD

Method Summary

Modifier and Type	Method	Description
Message	getBaseMessage()	Get the message this raw message is based upon.
int	getPriority()	Get the message's queue priority.
DirectByteBuffer[]	getRawData()	Get the message's raw data payload.
boolean	isNoDelay()	Is this a no-delay message.
Message[]	messagesToRemove()	Get the yet-unsent message types that should be removed before queueing this message for sending.
void	setNoDelay()	Set no-delay for this message

Methods inherited from interface Message

deserialize, destroy, getData, getDescription, getFeatureID, getFeatureSubID, getID, getIDBytes, getType, getVersion

Field Details

PRIORITY_LOW

static final int PRIORITY_LOW

See Also:

• Constant Field Values

PRIORITY_NORMAL

static final int PRIORITY_NORMAL

See Also:

• Constant Field Values

PRIORITY_HIGH

static final int PRIORITY_HIGH

See Also:

• Constant Field Values

Method Details

getRawData

DirectByteBuffer[] getRawData()

Get the message's raw data payload.

Returns:

data payload buffers

getPriority

int getPriority()

Get the message's queue priority.

Returns:

priority

isNoDelay

boolean isNoDelay()

Is this a no-delay message. No-delay messages are transmitted immediately, i.e. force-flushed out the transport.

Returns:

true if a no-delay message

setNoDelay

void setNoDelay()

Set no-delay for this message

Parameters:

no_delay -

messagesToRemove

Message[] messagesToRemove()

Get the yet-unsent message types that should be removed before queueing this message for sending.

Returns:

message types; null if no types

getBaseMessage

Message getBaseMessage()

Get the message this raw message is based upon.

Returns:

original message