rice.pastry
Class ScheduledMessage

java.lang.Object
  rice.selector.TimerTask
      rice.pastry.ScheduledMessage

All Implemented Interfaces:

java.lang.Comparable, CancellableTask

Direct Known Subclasses:

DirectTimerTask, ExponentialBackoffScheduledMessage

public class ScheduledMessage
extends TimerTask

A class that represents scheduled message events

Version:

$Id: ScheduledMessage.java 2808 2005-11-22 15:38:49 +0100 (Tue, 22 Nov 2005) jeffh $

Author:

Peter Druschel

Field Summary

protected PastryNode	localNode DESCRIBE THE FIELD
protected Message	msg DESCRIBE THE FIELD

Fields inherited from class rice.selector.TimerTask

cancelled, fixedRate, nextExecutionTime, period, seq

Constructor Summary

ScheduledMessage(PastryNode pn, Message msg)
Constructor

Method Summary

boolean	cancel() DESCRIBE THE METHOD
PastryNode	getLocalNode() Gets the LocalNode attribute of the ScheduledMessage object
Message	getMessage() Returns the message
void	run() deliver the message
java.lang.String	toString() Converts to a String representation of the object.

Methods inherited from class rice.selector.TimerTask

compareTo, execute, isCancelled, scheduledExecutionTime

Methods inherited from class java.lang.Object

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

Field Detail

localNode

protected PastryNode localNode

DESCRIBE THE FIELD

msg

protected Message msg

DESCRIBE THE FIELD

Constructor Detail

ScheduledMessage

public ScheduledMessage(PastryNode pn,
                        Message msg)

Constructor

Parameters:

pn - DESCRIBE THE PARAMETER

msg - DESCRIBE THE PARAMETER

Method Detail

getMessage

public Message getMessage()

Returns the message

Returns:

the message

getLocalNode

public PastryNode getLocalNode()

Gets the LocalNode attribute of the ScheduledMessage object

Returns:

The LocalNode value

run

public void run()

deliver the message

Specified by:

run in interface CancellableTask

Specified by:

run in class TimerTask

toString

public java.lang.String toString()

Converts to a String representation of the object.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the object.

cancel

public boolean cancel()

DESCRIBE THE METHOD

Specified by:

cancel in interface CancellableTask

Overrides:

cancel in class TimerTask

Returns:

DESCRIBE THE RETURN VALUE