|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This interface is a container which represents a message, as it is about to be forwarded to another node.
Method Summary | |
void |
decTimeToLive()
Decreases the Time to Live for the packet. |
java.lang.String |
getApplicationId()
Returns the application Id for this message |
NodeHandle |
getDestination()
Returns the destination NodeHandle for this message |
java.lang.String |
getKey()
Gets the identification key of this communication. |
Message |
getMessage()
Returns the enclosed message inside of this message |
int |
getMode()
Gets the mode of the actual Message. |
NodeHandle |
getNextHopHandle()
Returns the next hop handle for this message. |
java.lang.Object |
getOptions()
|
NodeHandle |
getPreviousHopHandle()
Gets the previous hop handle for this message. |
java.util.Collection |
getRoute()
Returns the route from the source to the destination. |
NodeHandle |
getSource()
Returns the source NodeHandle for this message |
int |
getTimeToLive()
Gets the time to live for the packet. |
int |
getType()
Gets the type of the actual Message. |
boolean |
routeMessagesHasExpired()
Returns true if RouteMessage has expired. |
void |
setApplicationId(java.lang.String app)
Sets the application name |
void |
setDestination(NodeHandle handle)
Sets the destination NodeHandle for this message |
void |
setKey(java.lang.String key)
Sets the identification key of this communication. |
void |
setMessage(Message message)
Sets the internal message for this message |
void |
setMode(int mode)
Sets the mode of the actual Message. |
void |
setNewNodeAlongRoute(NodeHandle node)
Adds a new node along the current path. |
void |
setNextHopHandle(NodeHandle nextHop)
Sets the next hop handle for this message |
void |
setOptions(java.lang.Object o)
Set RouteMessage additional options. |
void |
setPreviousHopHandle(NodeHandle previousHop)
Sets the previous hop handle for this message. |
void |
setRoute(java.util.Collection route)
Sets the route for the new path from the source to the destination |
void |
setSource(NodeHandle handle)
Sets the source NodeHandle for this message |
void |
setTimeToLive(int ttl)
Sets Time to Live For The Message. |
void |
setType(int type)
Sets the type of the actual Message. |
void |
setValues(java.lang.String appId,
NodeHandle to,
NodeHandle from,
NodeHandle nh,
Message msg,
java.lang.String key,
int type,
int mode)
Sets all values of the actual RouteMessage, before to be sent. |
Method Detail |
public java.lang.String getApplicationId()
public NodeHandle getDestination()
public NodeHandle getSource()
public NodeHandle getNextHopHandle()
public void setNextHopHandle(NodeHandle nextHop)
nextHop
- The next hop for this handlepublic NodeHandle getPreviousHopHandle()
public void setPreviousHopHandle(NodeHandle previousHop)
previousHop
- The previous hop to Set.public void setNewNodeAlongRoute(NodeHandle node)
node
- the new node to be added.public java.util.Collection getRoute()
public void setRoute(java.util.Collection route) throws InitializationException
route
- route from the source to the destination.
planet.commonapi.exception.InitializationException.
InitializationException
public void setTimeToLive(int ttl)
ttl
- time to live number.public int getTimeToLive()
public boolean routeMessagesHasExpired()
public void decTimeToLive()
public Message getMessage()
public java.lang.String getKey()
public void setApplicationId(java.lang.String app)
app
- The application namepublic void setDestination(NodeHandle handle)
handle
- The destination NodeHandlepublic void setSource(NodeHandle handle)
handle
- The source NodeHandlepublic void setMessage(Message message)
message
- The internal messagepublic void setKey(java.lang.String key)
key
- key of this communication.public void setMode(int mode)
mode
- The mode of the actual Message.Globals
public int getType()
public int getMode()
public void setType(int type)
type
- The type of the actual Message.public void setOptions(java.lang.Object o)
o
- additional options.public java.lang.Object getOptions()
public void setValues(java.lang.String appId, NodeHandle to, NodeHandle from, NodeHandle nh, Message msg, java.lang.String key, int type, int mode)
appId
- Identification of the Application which generate this
message.to
- Destination Id of this RouteMessage.from
- Source Id of this RouteMessage.nh
- NodeHandle for next hop.msg
- Message wrapped to this RouteMessage.key
- Identification key for this communication with the remote node.type
- Type of this message.mode
- Mode of this message.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |