rice.p2p.commonapi
Interface RouteMessage

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

MultiringRouteMessage, PastRegrTest.TestRouteMessage, RawPastRegrTest.TestRouteMessage, RawScribeRegrTest.TestRouteMessage, RouteMessage, ScribeRegrTest.TestRouteMessage

public interface RouteMessage

extends java.io.Serializable

Version:

$Id: RouteMessage.java 3274 2006-05-15 16:17:47Z jeffh $

Author:

Alan Mislove, Peter Druschel

Method Summary

Id	getDestinationId() Returns the destination Id for this message
Message	getMessage() Deprecated. use getMesage(MessageDeserializer)
Message	getMessage(MessageDeserializer md) Gets the Message attribute of the RouteMessage object
NodeHandle	getNextHopHandle() Returns the next hop handle for this message
void	setDestinationId(Id id) Sets the destination Id for this message
void	setMessage(Message message) Sets the internal message for this message
void	setMessage(RawMessage message) Sets the internal message for this message Does the same as setMessage(Message) but with better performance, because it doesn't have to introspect if the message is a RawMessage
void	setNextHopHandle(NodeHandle nextHop) Sets the next hop handle for this message

Method Detail

getDestinationId

public Id getDestinationId()

Returns the destination Id for this message

Returns:

The destination Id

getNextHopHandle

public NodeHandle getNextHopHandle()

Returns the next hop handle for this message

Returns:

The next hop

getMessage

public Message getMessage()

Deprecated. use getMesage(MessageDeserializer)

Returns the enclosed message inside of this message

Returns:

The enclosed message

getMessage

public Message getMessage(MessageDeserializer md)
                   throws java.io.IOException

Gets the Message attribute of the RouteMessage object

Parameters:

md - DESCRIBE THE PARAMETER

Returns:

The Message value

Throws:

java.io.IOException - DESCRIBE THE EXCEPTION

setDestinationId

public void setDestinationId(Id id)

Sets the destination Id for this message

Parameters:

id - The destination Id

setNextHopHandle

public void setNextHopHandle(NodeHandle nextHop)

Sets the next hop handle for this message

Parameters:

nextHop - The next hop for this handle

setMessage

public void setMessage(Message message)

Sets the internal message for this message

Parameters:

message - The internal message

setMessage

public void setMessage(RawMessage message)

Sets the internal message for this message Does the same as setMessage(Message) but with better performance, because it doesn't have to introspect if the message is a RawMessage

Parameters:

message - The internal message