dans.algorithm

Class Message

java.lang.Object

dans.algorithm.Message

public final class Message
extends java.lang.Object

The Message class warps a message sent between processors with meta data about how it is or will be transmitted. To create a message to be sent, one of the constructors should be used. Received Message objects can not be resent, instead a new message object with the same message should be created. After a message object is created, none of its values can be changed (this is intentional). All messages are treated as strings, however, other values can be encoded in them. If nonprintable characters are used or the message is long, it may not be displayed correctly in the front-end GUI.

Version:

0.1beta

Author:

Daniel Servos

Constructor Summary

Constructors

Constructor and Description
Message(java.lang.String toID, java.lang.String message) Creates a new Message object to be sent to a given processor.
Message(java.lang.String toID, java.lang.String message, boolean isLinkID) Creates a new Message object to be sent to a given processor or link.
Message(java.lang.String toID, java.lang.String message, int port) Creates a new Message object to be set to a given processor on a given port.
Message(java.lang.String toID, java.lang.String message, int port, boolean isLinkID) Creates a new Message object to be sent to a given processor or link on a given port.

Method Summary

Modifier and Type	Method and Description
java.lang.String	from() Gets the processor ID of the processor that sent the message or null if the message has not yet been sent.
java.lang.String	link() Gets the link ID of the link that transmitted or will transmit the message or null if no link ID is set (e.g.
java.lang.String	message() Gets the message as a string.
int	port() Gets the port this message was sent to or will be sent to.
int	received() Gets time (in ticks) that the message was received at or -1 if the message has not yet been received.
int	senderPort() The port the algorithm was listening on that sent this message or -1 if the message has not yet been sent.
int	sent() Gets time (in ticks) that the message was sent at or -1 if the message has not yet been sent.
int	size() Gets the size of the message in bytes.
int	sourcePort() Deprecated. duplicate of senderPort().
java.lang.String	to() Gets the processor ID of the processor that message was or will be sent to or null if no processor ID is set (e.g.
double	toDouble() Attempts to convert the message string into a double.
int	toInt() Attempts to convert the message string into an integer.
long	toLong() Attempts to convert the message string into a long.
java.lang.String	toString() Equivalent to message().

Methods inherited from class java.lang.Object

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

Constructor Detail

Message

public Message(java.lang.String toID,
               java.lang.String message)

Creates a new Message object to be sent to a given processor. Message objects can be sent using the Algorithm.send(dans.algorithm.Message) command in the Algorithm class.

Parameters:

toID - the processor's ID

message - the message to be sent.

See Also:

Algorithm.send(dans.algorithm.Message), Message(java.lang.String, java.lang.String, boolean), Message(java.lang.String, java.lang.String, int), Message(java.lang.String, java.lang.String, int, boolean)

Message

public Message(java.lang.String toID,
               java.lang.String message,
               int port)

Creates a new Message object to be set to a given processor on a given port. Message objects can be sent using the Algorithm.send(dans.algorithm.Message) command in the Algorithm class.

Parameters:

toID - the processor's ID

message - the message to be sent.

port - the port to send the message to on the target processor.

See Also:

Algorithm.send(dans.algorithm.Message), Message(java.lang.String, java.lang.String), Message(java.lang.String, java.lang.String, boolean), Message(java.lang.String, java.lang.String, int, boolean)

Message

public Message(java.lang.String toID,
               java.lang.String message,
               boolean isLinkID)

Creates a new Message object to be sent to a given processor or link. If the isLinkID parameter is set to true, toID is assumed to be a link ID and the message will be sent down the given link when sent. If isLinkID is false, toID is assumed to be a processor ID and the message will be sent to the given processor when sent. Message objects can be sent using the Algorithm.send(dans.algorithm.Message) command in the Algorithm class.

Parameters:

toID - the ID of the processor or link the message is for.

message - the message to be sent.

isLinkID - if toID is a link ID or a processor ID.

See Also:

Algorithm.send(dans.algorithm.Message), Message(java.lang.String, java.lang.String), Message(java.lang.String, java.lang.String, int), Message(java.lang.String, java.lang.String, int, boolean)

Message

public Message(java.lang.String toID,
               java.lang.String message,
               int port,
               boolean isLinkID)

Creates a new Message object to be sent to a given processor or link on a given port. If the isLinkID parameter is set to true, toID is assumed to be a link ID and the message will be sent down the given link when sent. If isLinkID is false, toID is assumed to be a processor ID and the message will be sent to the given processor when sent. Message objects can be sent using the Algorithm.send(dans.algorithm.Message) command in the Algorithm class.

Parameters:

toID - the ID of the processor or link the message is for.

message - the message to be sent.

port - the port to send the message to on the target processor.

isLinkID - if toID is a link ID or a processor ID.

Method Detail

sent

public final int sent()

Gets time (in ticks) that the message was sent at or -1 if the message has not yet been sent.

Returns:

the time he message was sent at or -1 if the message has not yet been sent.

received

public final int received()

Gets time (in ticks) that the message was received at or -1 if the message has not yet been received.

Returns:

time that the message was received at or -1 if the message has not yet been received.

from

public final java.lang.String from()

Gets the processor ID of the processor that sent the message or null if the message has not yet been sent.

Returns:

a processor ID or null.

to

public final java.lang.String to()

Gets the processor ID of the processor that message was or will be sent to or null if no processor ID is set (e.g. if the message will be sent by using a link ID).

Returns:

a processor ID or null.

link

public final java.lang.String link()

Gets the link ID of the link that transmitted or will transmit the message or null if no link ID is set (e.g. if the message has not yet been sent and will be sent by using a processor ID).

Returns:

a link ID or null.

message

public final java.lang.String message()

Gets the message as a string.

Returns:

the message.

size

public final int size()

Gets the size of the message in bytes. This is equivalent to the length of the string. The '\0' character is not counted in this size.

Returns:

the size of the message in bytes.

senderPort

public final int senderPort()

The port the algorithm was listening on that sent this message or -1 if the message has not yet been sent. This allows an algorithm to respond to messages on the correct port.

Returns:

a port number or -1.

See Also:

port()

toString

public final java.lang.String toString()

Equivalent to message().

Overrides:

toString in class java.lang.Object

Returns:

the message as a string.

See Also:

message(), toInt(), toDouble(), toLong()

toInt

public final int toInt()

Attempts to convert the message string into an integer.

Returns:

the message represented as an integer

Throws:

java.lang.NumberFormatException - if the string does not contain a parsable integer.

See Also:

toString(), toDouble(), toLong()

toDouble

public final double toDouble()

Attempts to convert the message string into a double.

Returns:

the message represented as a double

Throws:

java.lang.NumberFormatException - if the string does not contain a parsable double.

See Also:

toString(), toInt(), toLong()

toLong

public final long toLong()

Attempts to convert the message string into a long.

Returns:

the message represented as a long

Throws:

java.lang.NumberFormatException - if the string does not contain a parsable long.

See Also:

toString(), toInt(), toDouble()

port

public final int port()

Gets the port this message was sent to or will be sent to. -1 is returned if this message has not yet been sent and the port is not set in the constructor.

Returns:

the port number or -1.

See Also:

senderPort()

sourcePort

public final int sourcePort()

Deprecated. duplicate of senderPort().

Duplicate of the senderPort() method. To be removed.

Returns:

the port number or -1.

See Also:

senderPort()