transport.protocol
Class MulticastMessage

java.lang.Object
  |
  +--transport.protocol.Message
        |
        +--transport.protocol.MulticastMessage
All Implemented Interfaces:
java.io.Serializable

public class MulticastMessage
extends Message
implements java.io.Serializable

This class represents a Multicast message. This message is sent by agents to the simulator, the simulator then sends the message to all agents that are with within range and certain number of hops.

See Also:
Serialized Form

Field Summary
private  java.lang.Object content
          Content to send in this message.
private  int hops
          The maximum number hops the message can make.
private  java.lang.String message
          The string content of this Message.
 
Fields inherited from class transport.protocol.Message
 
Constructor Summary
MulticastMessage(java.lang.String message, int from)
          This constructor initializes the Message.
MulticastMessage(java.lang.String message, int from, int hops)
          This constructor initializes the Message.
 
Method Summary
 java.lang.Object getContent()
          This method returns the object content of the message.
 int getHops()
          This method returns the max number of hops for this message to take.
 java.lang.String getMessage()
          This method returns the String content of the message.
 void setContent(java.lang.Object c)
          This method sets the object data to send in this message.
 
Methods inherited from class transport.protocol.Message
getFrom, getTo, setTo
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

message

private java.lang.String message
The string content of this Message.


content

private java.lang.Object content
Content to send in this message. Must be Serializable.


hops

private int hops
The maximum number hops the message can make.

Constructor Detail

MulticastMessage

public MulticastMessage(java.lang.String message,
                        int from)
This constructor initializes the Message. Object content must be added seperately with setContent() method, and the object must be Serializable.

Parameters:
message - The String message.
from - The port the message sender listens to.

MulticastMessage

public MulticastMessage(java.lang.String message,
                        int from,
                        int hops)
This constructor initializes the Message. Object content must be added seperately with setContent() method, and the object must be Serializable.

Parameters:
message - The String message.
from - The port the message sender listens to.
hops - The max number of hops.
Method Detail

getMessage

public java.lang.String getMessage()
This method returns the String content of the message.

Returns:
String The message.

getContent

public java.lang.Object getContent()
This method returns the object content of the message.

Returns:
Object The object content.

setContent

public void setContent(java.lang.Object c)
This method sets the object data to send in this message.


getHops

public int getHops()
This method returns the max number of hops for this message to take.

Returns:
int The number of hops.