Class RawMessageImpl
- java.lang.Object
-
- com.biglybt.core.networkmanager.impl.RawMessageImpl
-
- All Implemented Interfaces:
RawMessage
,Message
public class RawMessageImpl extends java.lang.Object implements RawMessage
Basic raw message implementation used internally for Message-->RawMessage conversions.
-
-
Field Summary
Fields Modifier and Type Field Description private boolean
is_no_delay
private Message
message
private DirectByteBuffer[]
payload
private int
priority
private Message[]
to_remove
-
Fields inherited from interface com.biglybt.core.peermanager.messaging.Message
TYPE_DATA_PAYLOAD, TYPE_PROTOCOL_PAYLOAD
-
Fields inherited from interface com.biglybt.core.networkmanager.RawMessage
PRIORITY_HIGH, PRIORITY_LOW, PRIORITY_NORMAL
-
-
Constructor Summary
Constructors Constructor Description RawMessageImpl(Message source, DirectByteBuffer[] raw_payload, int _priority, boolean _is_no_delay, Message[] _to_remove)
Create a new raw message using the given parameters.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Message
deserialize(DirectByteBuffer data, byte version)
Create a new instance of this message by decoding the given byte serialization.void
destroy()
Destroy the message; i.e.Message
getBaseMessage()
Get the message this raw message is based upon.DirectByteBuffer[]
getData()
Get message payload data.java.lang.String
getDescription()
Get textual description of this particular message.java.lang.String
getFeatureID()
Get the main feature set name this message belongs to.int
getFeatureSubID()
Get the static message sub-id for the feature.java.lang.String
getID()
Get message id.byte[]
getIDBytes()
int
getPriority()
Get the message's queue priority.DirectByteBuffer[]
getRawData()
Get the message's raw data payload.int
getType()
Get message type.byte
getVersion()
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
-
-
-
Field Detail
-
message
private final Message message
-
payload
private final DirectByteBuffer[] payload
-
priority
private final int priority
-
is_no_delay
private boolean is_no_delay
-
to_remove
private final Message[] to_remove
-
-
Constructor Detail
-
RawMessageImpl
public RawMessageImpl(Message source, DirectByteBuffer[] raw_payload, int _priority, boolean _is_no_delay, Message[] _to_remove)
Create a new raw message using the given parameters.- Parameters:
source
- original messageraw_payload
- headers + original message datapriority
- in queueis_no_delay
- is an urgent messageto_remove
- message types to auto-remove upon queue
-
-
Method Detail
-
getID
public java.lang.String getID()
Description copied from interface:Message
Get message id.
-
getIDBytes
public byte[] getIDBytes()
- Specified by:
getIDBytes
in interfaceMessage
-
getFeatureID
public java.lang.String getFeatureID()
Description copied from interface:Message
Get the main feature set name this message belongs to.- Specified by:
getFeatureID
in interfaceMessage
- Returns:
- feature id
-
getFeatureSubID
public int getFeatureSubID()
Description copied from interface:Message
Get the static message sub-id for the feature.- Specified by:
getFeatureSubID
in interfaceMessage
- Returns:
- sub id
-
getType
public int getType()
Description copied from interface:Message
Get message type.
-
getVersion
public byte getVersion()
- Specified by:
getVersion
in interfaceMessage
-
getDescription
public java.lang.String getDescription()
Description copied from interface:Message
Get textual description of this particular message.- Specified by:
getDescription
in interfaceMessage
- Returns:
- description
-
getData
public DirectByteBuffer[] getData()
Description copied from interface:Message
Get message payload data.
-
deserialize
public Message deserialize(DirectByteBuffer data, byte version) throws MessageException
Description copied from interface:Message
Create a new instance of this message by decoding the given byte serialization.- Specified by:
deserialize
in interfaceMessage
- Parameters:
data
- to deserialize- Returns:
- decoded message instance
- Throws:
MessageException
- if the decoding process fails NOTE: Does not auto-return given direct buffer on thrown exception.
-
getRawData
public DirectByteBuffer[] getRawData()
Description copied from interface:RawMessage
Get the message's raw data payload.- Specified by:
getRawData
in interfaceRawMessage
- Returns:
- data payload buffers
-
getPriority
public int getPriority()
Description copied from interface:RawMessage
Get the message's queue priority.- Specified by:
getPriority
in interfaceRawMessage
- Returns:
- priority
-
isNoDelay
public boolean isNoDelay()
Description copied from interface:RawMessage
Is this a no-delay message. No-delay messages are transmitted immediately, i.e. force-flushed out the transport.- Specified by:
isNoDelay
in interfaceRawMessage
- Returns:
- true if a no-delay message
-
setNoDelay
public void setNoDelay()
Description copied from interface:RawMessage
Set no-delay for this message- Specified by:
setNoDelay
in interfaceRawMessage
-
messagesToRemove
public Message[] messagesToRemove()
Description copied from interface:RawMessage
Get the yet-unsent message types that should be removed before queueing this message for sending.- Specified by:
messagesToRemove
in interfaceRawMessage
- Returns:
- message types; null if no types
-
getBaseMessage
public Message getBaseMessage()
Description copied from interface:RawMessage
Get the message this raw message is based upon.- Specified by:
getBaseMessage
in interfaceRawMessage
- Returns:
- original message
-
-