com.aelitis.azureus.core.peermanager.messaging.azureus
Class AZRequestHint

java.lang.Object
  extended by com.aelitis.azureus.core.peermanager.messaging.azureus.AZRequestHint
All Implemented Interfaces:
AZMessage, Message

public class AZRequestHint
extends java.lang.Object
implements AZMessage


Field Summary
 
Fields inherited from interface com.aelitis.azureus.core.peermanager.messaging.azureus.AZMessage
AZ_FEATURE_ID, ID_AZ_BAD_PIECE, ID_AZ_BAD_PIECE_BYTES, ID_AZ_GENERIC_MAP, ID_AZ_GENERIC_MAP_BYTES, ID_AZ_HANDSHAKE, ID_AZ_HANDSHAKE_BYTES, ID_AZ_HAVE, ID_AZ_HAVE_BYTES, ID_AZ_METADATA, ID_AZ_METADATA_BYTES, ID_AZ_PEER_EXCHANGE, ID_AZ_PEER_EXCHANGE_BYTES, ID_AZ_REQUEST_HINT, ID_AZ_REQUEST_HINT_BYTES, ID_AZ_SESSION_ACK, ID_AZ_SESSION_ACK_BYTES, ID_AZ_SESSION_BITFIELD, ID_AZ_SESSION_BITFIELD_BYTES, ID_AZ_SESSION_CANCEL, ID_AZ_SESSION_CANCEL_BYTES, ID_AZ_SESSION_END, ID_AZ_SESSION_END_BYTES, ID_AZ_SESSION_HAVE, ID_AZ_SESSION_HAVE_BYTES, ID_AZ_SESSION_PIECE, ID_AZ_SESSION_PIECE_BYTES, ID_AZ_SESSION_REQUEST, ID_AZ_SESSION_REQUEST_BYTES, ID_AZ_SESSION_SYN, ID_AZ_SESSION_SYN_BYTES, ID_AZ_STAT_REPLY, ID_AZ_STAT_REPLY_BYTES, ID_AZ_STAT_REQUEST, ID_AZ_STAT_REQUEST_BYTES, SUBID_AZ_GENERIC_MAP, SUBID_AZ_HANDSHAKE, SUBID_AZ_PEER_EXCHANGE, SUBID_ID_AZ_BAD_PIECE, SUBID_ID_AZ_HAVE, SUBID_ID_AZ_METADATA, SUBID_ID_AZ_REQUEST_HINT, SUBID_ID_AZ_STAT_REPLY, SUBID_ID_AZ_STAT_REQUEST
 
Fields inherited from interface com.aelitis.azureus.core.peermanager.messaging.Message
TYPE_DATA_PAYLOAD, TYPE_PROTOCOL_PAYLOAD
 
Constructor Summary
AZRequestHint(int _piece_number, int _offset, int _length, int _life, byte _version)
           
 
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()
           
 int getLength()
           
 int getLife()
           
 int getOffset()
           
 int getPieceNumber()
           
 int getType()
          Get message type.
 byte getVersion()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AZRequestHint

public AZRequestHint(int _piece_number,
                     int _offset,
                     int _length,
                     int _life,
                     byte _version)
Method Detail

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

getVersion

public byte getVersion()
Specified by:
getVersion in interface Message

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

getPieceNumber

public int getPieceNumber()

getOffset

public int getOffset()

getLength

public int getLength()

getLife

public int getLife()

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