freenet.io.comm

Class Message

java.lang.Object

freenet.io.comm.Message

public class Message
extends java.lang.Object

A Message which can be read from and written to a DatagramPacket. SECURITY REDFLAG WARNING: Messages should normally be recreated rather than passed on. Messages can contain sub-messages, these are used to avoid having to add whole new message types every time we add one field to a message... Passing on a message as-is means it includes the sub-messages, which could lead to e.g. labelling, communication between colluding nodes along a request route, and just wasting bytes. FIXME we should get rid of sub-messages.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Message.FieldNotSetException

Field Summary

Fields

Modifier and Type	Field and Description
long	localInstantiationTime
static java.lang.String	VERSION

Constructor Summary

Constructors

Constructor and Description
Message(MessageType spec)

Method Summary

Modifier and Type	Method and Description
void	addSubMessage(Message subMessage)
long	age()
void	boostPriority()
Message	cloneAndDropSubMessages() Clone the message, clear sub-messages and set originator to self.
static Message	decodeMessageFromPacket(byte[] buf, int offset, int length, PeerContext peer, int overhead)
static Message	decodeMessageLax(byte[] buf, PeerContext peer, int overhead)
byte[]	encodeToPacket()
boolean	getBoolean(java.lang.String key)
byte	getByte(java.lang.String key)
double	getDouble(java.lang.String key)
double[]	getDoubleArray(java.lang.String key)
float	getFloat(java.lang.String key)
float[]	getFloatArray(java.lang.String key)
java.lang.Object	getFromPayload(java.lang.String fieldName)
int	getInt(java.lang.String key)
long	getLong(java.lang.String key)
java.lang.Object	getObject(java.lang.String key)
short	getPriority()
short	getShort(java.lang.String key)
byte[]	getShortBufferBytes(java.lang.String key)
PeerContext	getSource()
MessageType	getSpec()
java.lang.String	getString(java.lang.String key)
Message	getSubMessage(MessageType t)
Message	grabSubMessage(MessageType t)
boolean	isInternal()
boolean	isSet(java.lang.String fieldName)
boolean	needsLoadBulk()
boolean	needsLoadRT()
int	receivedByteCount()
void	set(java.lang.String key, boolean b)
void	set(java.lang.String key, byte b)
void	set(java.lang.String key, double d)
void	set(java.lang.String key, float f)
void	set(java.lang.String key, int i)
void	set(java.lang.String key, long l)
void	set(java.lang.String key, java.lang.Object value)
void	set(java.lang.String key, short s)
void	setNeedsLoadBulk()
void	setNeedsLoadRT()
void	setRoutedToNodeFields(long uid, double targetLocation, short htl, byte[] nodeIdentity) Set fields for a routed-to-a-specific-node message.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

VERSION

public static final java.lang.String VERSION

See Also:

Constant Field Values

localInstantiationTime

public final long localInstantiationTime

Constructor Detail

Message

public Message(MessageType spec)

Method Detail

decodeMessageFromPacket

public static Message decodeMessageFromPacket(byte[] buf,
                                              int offset,
                                              int length,
                                              PeerContext peer,
                                              int overhead)

decodeMessageLax

public static Message decodeMessageLax(byte[] buf,
                                       PeerContext peer,
                                       int overhead)

getBoolean

public boolean getBoolean(java.lang.String key)

getByte

public byte getByte(java.lang.String key)

getShort

public short getShort(java.lang.String key)

getInt

public int getInt(java.lang.String key)

getLong

public long getLong(java.lang.String key)

getDouble

public double getDouble(java.lang.String key)

getFloat

public float getFloat(java.lang.String key)

getDoubleArray

public double[] getDoubleArray(java.lang.String key)

getFloatArray

public float[] getFloatArray(java.lang.String key)

getString

public java.lang.String getString(java.lang.String key)

getObject

public java.lang.Object getObject(java.lang.String key)

getShortBufferBytes

public byte[] getShortBufferBytes(java.lang.String key)

set

public void set(java.lang.String key,
                boolean b)

set

public void set(java.lang.String key,
                byte b)

set

public void set(java.lang.String key,
                short s)

set

public void set(java.lang.String key,
                int i)

set

public void set(java.lang.String key,
                long l)

set

public void set(java.lang.String key,
                double d)

set

public void set(java.lang.String key,
                float f)

set

public void set(java.lang.String key,
                java.lang.Object value)

encodeToPacket

public byte[] encodeToPacket()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getSource

public PeerContext getSource()

isInternal

public boolean isInternal()

getSpec

public MessageType getSpec()

isSet

public boolean isSet(java.lang.String fieldName)

getFromPayload

public java.lang.Object getFromPayload(java.lang.String fieldName)
                                throws Message.FieldNotSetException

Throws:

Message.FieldNotSetException

setRoutedToNodeFields

public void setRoutedToNodeFields(long uid,
                                  double targetLocation,
                                  short htl,
                                  byte[] nodeIdentity)

Set fields for a routed-to-a-specific-node message.

Parameters:

nodeIdentity -

receivedByteCount

public int receivedByteCount()

addSubMessage

public void addSubMessage(Message subMessage)

getSubMessage

public Message getSubMessage(MessageType t)

grabSubMessage

public Message grabSubMessage(MessageType t)

age

public long age()

getPriority

public short getPriority()

boostPriority

public void boostPriority()

needsLoadRT

public boolean needsLoadRT()

needsLoadBulk

public boolean needsLoadBulk()

setNeedsLoadRT

public void setNeedsLoadRT()

setNeedsLoadBulk

public void setNeedsLoadBulk()

cloneAndDropSubMessages

public Message cloneAndDropSubMessages()

Clone the message, clear sub-messages and set originator to self.