org.objectweb.proactive.core.body.message
Interface Message

All Known Subinterfaces:
ComponentRequest, Reply, Request
All Known Implementing Classes:
AwaitedRequest, BodyRequest, ComponentRequestImpl, MessageEvent, MessageImpl, ReplyImpl, RequestImpl

public interface Message

A class implementing this interface is an object encapsulating a reified method call either the sending of the call with the arguments or the reply of the call with the result.

A Message clearly identifies a sender and a receiver of the message. Each message is associated with a unique sequence number.

Since:
ProActive 0.9
Version:
1.0, 2001/10/23
Author:
ProActive Team

Method Summary
 FTManager getFTManager()
          Return the FTManager that have to treat this message
 char[] getMessageInfo()
          Returns fault-tolerance infos piggybacked on this message
 java.lang.String getMethodName()
          Returns the method name of the method call packed in this message
 long getSequenceNumber()
          Returns a unique sequence number of this message
 UniqueID getSourceBodyID()
          Returns the id of the body source of this message
 long getTimeStamp()
          Returns the time this message was created or deserialized
 boolean ignoreIt()
          Return true if this message must be ignored by the receiver
 boolean isOneWay()
          Returns true if the message will not generate a response message
 void setFTManager(FTManager ft)
          Set the FTManager that have to treat this message
 void setIgnoreIt(boolean ignore)
          Set or unset the ignore tag.
 void setMessageInfo(char[] mi)
          Set fault-tolerance infos piggybacked on this message
 

Method Detail

getSourceBodyID

public UniqueID getSourceBodyID()
Returns the id of the body source of this message

Returns:
the id of the body source of this message

getMethodName

public java.lang.String getMethodName()
Returns the method name of the method call packed in this message

Returns:
the method name of the method call packed in this message

getSequenceNumber

public long getSequenceNumber()
Returns a unique sequence number of this message

Returns:
a unique sequence number of this message

isOneWay

public boolean isOneWay()
Returns true if the message will not generate a response message

Returns:
true if the message will not generate a response message

getTimeStamp

public long getTimeStamp()
Returns the time this message was created or deserialized

Returns:
the time this message was created or deserialized

getMessageInfo

public char[] getMessageInfo()
Returns fault-tolerance infos piggybacked on this message

Returns:
an array of chars that contains fault-tolerance infos

setMessageInfo

public void setMessageInfo(char[] mi)
Set fault-tolerance infos piggybacked on this message

Parameters:
mi - an array of chars that contains fault-tolerance infos

ignoreIt

public boolean ignoreIt()
Return true if this message must be ignored by the receiver

Returns:
true if this message must be ignored by the receiver

setIgnoreIt

public void setIgnoreIt(boolean ignore)
Set or unset the ignore tag.

Parameters:
ignore - true if this request must be ignored, false otherwise.

setFTManager

public void setFTManager(FTManager ft)
Set the FTManager that have to treat this message

Parameters:
ft - the FTManager that have to treat this message

getFTManager

public FTManager getFTManager()
Return the FTManager that have to treat this message

Returns:
the FTManager that have to treat this message


Copyright ? April 2005 INRIA All Rights Reserved.