com.almasb.fxgl.ai.msg

Class Telegram

java.lang.Object

com.almasb.fxgl.ai.msg.Telegram

All Implemented Interfaces:

Poolable, Comparable<Telegram>

public class Telegram
extends Object
implements Comparable<Telegram>, Poolable

A Telegram is the container of a message. The MessageDispatcher manages telegram life-cycle.

Author:

davebaol

Field Summary

Fields

Modifier and Type	Field and Description
Object	extraInfo Any additional information that may accompany the message
int	message The message type.
Telegraph	receiver The agent that is to receive this telegram
static int	RETURN_RECEIPT_NEEDED Indicates that the sender needs the return receipt
static int	RETURN_RECEIPT_SENT Indicates that the return receipt has been sent back to the original sender of the telegram
static int	RETURN_RECEIPT_UNNEEDED Indicates that the sender doesn't need any return receipt
int	returnReceiptStatus The return receipt status of this telegram.
Telegraph	sender The agent that sent this telegram

Constructor Summary

Constructors

Constructor and Description
Telegram() Creates an empty Telegram.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Telegram other)
boolean	equals(Object obj)
float	getTimestamp() Returns the time stamp of this telegram.
int	hashCode()
void	reset() Resets the object for reuse.
void	setTimestamp(float timestamp) Sets the time stamp of this telegram.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

RETURN_RECEIPT_UNNEEDED

public static final int RETURN_RECEIPT_UNNEEDED

Indicates that the sender doesn't need any return receipt

See Also:

Constant Field Values

RETURN_RECEIPT_NEEDED

public static final int RETURN_RECEIPT_NEEDED

Indicates that the sender needs the return receipt

See Also:

Constant Field Values

RETURN_RECEIPT_SENT

public static final int RETURN_RECEIPT_SENT

Indicates that the return receipt has been sent back to the original sender of the telegram

See Also:

Constant Field Values

sender

public Telegraph sender

The agent that sent this telegram

receiver

public Telegraph receiver

The agent that is to receive this telegram

message

public int message

The message type.

returnReceiptStatus

public int returnReceiptStatus

The return receipt status of this telegram. Its value should be RETURN_RECEIPT_UNNEEDED, RETURN_RECEIPT_NEEDED or RETURN_RECEIPT_SENT.

extraInfo

public Object extraInfo

Any additional information that may accompany the message

Constructor Detail

Telegram

public Telegram()

Creates an empty Telegram.

Method Detail

getTimestamp

public float getTimestamp()

Returns the time stamp of this telegram.

setTimestamp

public void setTimestamp(float timestamp)

Sets the time stamp of this telegram.

reset

public void reset()

Description copied from interface: Poolable

Resets the object for reuse. Object references should be nulled and fields may be set to default values.

Specified by:

reset in interface Poolable

compareTo

public int compareTo(Telegram other)

Specified by:

compareTo in interface Comparable<Telegram>

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object