org.gudy.azureus2.plugins.messaging
Interface Message

All Known Subinterfaces:
RawMessage

public interface Message

Basic peer message. A message is uniquely identified by the combination of ID and version.


Field Summary
static int TYPE_DATA_PAYLOAD
          Is a data-bearing message, i.e.
static int TYPE_PROTOCOL_PAYLOAD
          Is a protocol-bearing message, i.e.
 
Method Summary
 Message create(java.nio.ByteBuffer data)
          Create a new instance of this message by decoding the given byte serialization.
 void destroy()
          Destroy the message; i.e.
 java.lang.String getDescription()
          Get textual description of this particular message.
 java.lang.String getID()
          Get message id.
 java.nio.ByteBuffer[] getPayload()
          Get message payload data.
 int getType()
          Get message type.
 

Field Detail

TYPE_PROTOCOL_PAYLOAD

static final int TYPE_PROTOCOL_PAYLOAD
Is a protocol-bearing message, i.e. messaging/overhead data.

See Also:
Constant Field Values

TYPE_DATA_PAYLOAD

static final int TYPE_DATA_PAYLOAD
Is a data-bearing message, i.e. file data.

See Also:
Constant Field Values
Method Detail

getID

java.lang.String getID()
Get message id.

Returns:
id

getType

int getType()
Get message type.

Returns:
type

getDescription

java.lang.String getDescription()
Get textual description of this particular message.

Returns:
description

getPayload

java.nio.ByteBuffer[] getPayload()
Get message payload data.

Returns:
message data buffers

create

Message create(java.nio.ByteBuffer data)
               throws MessageException
Create a new instance of this message by decoding the given byte serialization.

Parameters:
data - to deserialize
Returns:
decoded message instance
Throws:
MessageException - if the decoding process fails

destroy

void destroy()
Destroy the message; i.e. perform cleanup actions.