org.gudy.azureus2.pluginsimpl.local.messaging
Class GenericMessage

java.lang.Object
  org.gudy.azureus2.pluginsimpl.local.messaging.GenericMessage

All Implemented Interfaces:

Message

public class GenericMessage
extends java.lang.Object
implements Message

Field Summary

Fields inherited from interface com.aelitis.azureus.core.peermanager.messaging.Message

TYPE_DATA_PAYLOAD, TYPE_PROTOCOL_PAYLOAD

Constructor Summary

protected

GenericMessage(java.lang.String _id, java.lang.String _desc, DirectByteBuffer _buffer, boolean _already_encoded)

Method Summary

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()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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.

Specified by:

getID in interface Message

Returns:

id

getIDBytes

public byte[] getIDBytes()

Specified by:

getIDBytes in interface Message

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 interface Message

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 interface Message

Returns:

sub id

getType

public int getType()

Description copied from interface: Message

Get message type.

Specified by:

getType in interface Message

Returns:

type

getDescription

public java.lang.String getDescription()

Description copied from interface: Message

Get textual description of this particular message.

Specified by:

getDescription in interface Message

Returns:

description

getVersion

public byte getVersion()

Specified by:

getVersion in interface Message

getPayload

public DirectByteBuffer getPayload()

getData

public DirectByteBuffer[] getData()

Description copied from interface: Message

Get message payload data.

Specified by:

getData in interface Message

Returns:

message data buffers

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 interface Message

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.

destroy

public void destroy()

Description copied from interface: Message

Destroy the message; i.e. perform cleanup actions.

Specified by:

destroy in interface Message