Class GenericMessage
- java.lang.Object
-
- com.biglybt.pifimpl.local.messaging.GenericMessage
-
-
Field Summary
Fields Modifier and Type Field Description private boolean
already_encoded
private DirectByteBuffer
buffer
private java.lang.String
desc
private java.lang.String
id
-
Fields inherited from interface com.biglybt.core.peermanager.messaging.Message
TYPE_DATA_PAYLOAD, TYPE_PROTOCOL_PAYLOAD
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
GenericMessage(java.lang.String _id, java.lang.String _desc, DirectByteBuffer _buffer, boolean _already_encoded)
-
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.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()
DirectByteBuffer
getPayload()
int
getType()
Get message type.byte
getVersion()
protected boolean
isAlreadyEncoded()
-
-
-
Field Detail
-
buffer
private DirectByteBuffer buffer
-
id
private final java.lang.String id
-
desc
private final java.lang.String desc
-
already_encoded
private final boolean already_encoded
-
-
Constructor Detail
-
GenericMessage
protected GenericMessage(java.lang.String _id, java.lang.String _desc, DirectByteBuffer _buffer, boolean _already_encoded)
-
-
Method Detail
-
isAlreadyEncoded
protected boolean isAlreadyEncoded()
-
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.
-
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
-
getVersion
public byte getVersion()
- Specified by:
getVersion
in interfaceMessage
-
getPayload
public DirectByteBuffer getPayload()
-
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.
-
-