Package net.sf.eBusx.util

Class TimerReply

java.lang.Object

net.sf.eBus.messages.EMessageObject

net.sf.eBus.messages.EMessage

net.sf.eBus.messages.EReplyMessage

net.sf.eBusx.util.TimerReply

All Implemented Interfaces:

java.io.Serializable

@Deprecated
@ELocalOnly
public final class TimerReply
extends EReplyMessage
implements java.io.Serializable

Deprecated.

Please move to net.sf.eBus.client.EScheduledTimer for scheduled task timing.

This reply message is sent when the requested timer expires. The reply contains the requestor-defined timer name and sequence number. If this is a one-shot timer, then EReplyMessage.replyStatus is set to EReplyMessage.ReplyStatus.OK_FINAL and sequenceNumber the final reply flag is set zero. Repeating timers always have a EReplyMessage.replyStatus of EReplyMessage.ReplyStatus.OK_CONTINUING since timer replies keep coming until either the requestor closes the timer or ETimer is shut down.

Author:

Charles W. Rapp

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TimerReply.Builder	Deprecated.

Nested classes/interfaces inherited from class net.sf.eBus.messages.EReplyMessage

EReplyMessage.ConcreteBuilder, EReplyMessage.ReplyStatus

Nested classes/interfaces inherited from class net.sf.eBus.messages.EMessage

EMessage.MessageType

Field Summary

Fields

Modifier and Type	Field	Description
int	sequenceNumber	Deprecated. The time message sequence number.
java.lang.String	timerName	Deprecated. The requestor-assigned name for this timer request.

Fields inherited from class net.sf.eBus.messages.EReplyMessage

replyReason, replyStatus

Fields inherited from class net.sf.eBus.messages.EMessage

MAX_SUBJECT_LENGTH, subject, timestamp

Method Summary

Modifier and Type	Method	Description
static TimerReply.Builder	builder()	Deprecated. Returns the TimerReply message builder.
boolean	equals(java.lang.Object o)	Deprecated. Returns true if o is a non-null EReplyMessage instance with a reply status and reply reason equal to this EReplyMessage instance and false otherwise.
int	hashCode()	Deprecated. Returns the reply message hash code.

Methods inherited from class net.sf.eBus.messages.EReplyMessage

isFinal, toString

Methods inherited from class net.sf.eBus.messages.EMessage

isApplicationMessage, isSystemMessage, key, messageType, timestampAsInstant

Methods inherited from class java.lang.Object

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

Field Detail

timerName

public final java.lang.String timerName

Deprecated.

The requestor-assigned name for this timer request.

sequenceNumber

public final int sequenceNumber

Deprecated.

The time message sequence number. Values begin at zero. This means that a one-time timer has a zero sequence number.

Method Detail

equals

public boolean equals(java.lang.Object o)

Deprecated.

Description copied from class: EReplyMessage

Returns true if o is a non-null EReplyMessage instance with a reply status and reply reason equal to this EReplyMessage instance and false otherwise.

Overrides:

equals in class EReplyMessage

Parameters:

o - comparison object.

Returns:

true if the message fields are equal and false otherwise.

hashCode

public int hashCode()

Deprecated.

Description copied from class: EReplyMessage

Returns the reply message hash code.

Overrides:

hashCode in class EReplyMessage

Returns:

the reply message hash code.

builder

public static TimerReply.Builder builder()

Deprecated.

Returns the TimerReply message builder.

Returns:

message builder.