net.sf.eBus.client.sysmessages

Class RemoteAck

java.lang.Object

net.sf.eBus.messages.EMessageObject

net.sf.eBus.messages.EMessage

net.sf.eBus.messages.ESystemMessage

net.sf.eBus.client.sysmessages.RemoteAck

All Implemented Interfaces:

Serializable

public final class RemoteAck
extends ESystemMessage
implements Serializable

Acknowledges receipt of a request message from a remote eBus application. This message is used to link the two feed identifiers associated with the request. This allows a request to be canceled before a reply is sent. This message has no fields since no information beyond the header is required.

Author:

Charles W. Rapp

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RemoteAck.Builder Class used to create RemoteAck messages.

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

EMessage.MessageType

Field Summary

Fields

Modifier and Type	Field and Description
int	remaining The number of remaining remote repliers.

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

SYSTEM_SUBJECT

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

subject, timestamp

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

MAX_FIELDS

Constructor Summary

Constructors

Constructor and Description
RemoteAck(int remaining) Deprecated. use RemoteAck(RemoteAck.Builder) in the future.
RemoteAck(String subject, long timestamp, int remaining) Deprecated. use RemoteAck(RemoteAck.Builder) in the future.

Method Summary

Modifier and Type	Method and Description
static RemoteAck.Builder	builder() Returns a new instance of the RemoteAck message builder.
boolean	equals(Object o) Returns true if o is a non-null EMessage instance with a subject and timestamp equal to this EMessage instance and false otherwise.
int	hashCode() Returns the message header hash code.
String	toString() Returns a human-readable text version of this message.

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

isApplicationMessage, isSystemMessage, key, messageType

Methods inherited from class java.lang.Object

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

Field Detail

remaining

public final int remaining

The number of remaining remote repliers. When this value reaches zero, the request is completed.

Constructor Detail

RemoteAck

@Deprecated
public RemoteAck(int remaining)

Deprecated. use RemoteAck(RemoteAck.Builder) in the future.

Creates a new remote acknowledgment message.

Parameters:

remaining - number of remaining remote repliers.

RemoteAck

@Deprecated
public RemoteAck(String subject,
                             long timestamp,
                             int remaining)
                      throws IllegalArgumentException

Deprecated. use RemoteAck(RemoteAck.Builder) in the future.

Creates a new remote acknowledgment message from the de-serialized information.

Parameters:

subject - message subject.

timestamp - message timestamp.

remaining - number of remaining remote repliers.

Throws:

IllegalArgumentException - if remaining is < zero.

Method Detail

equals

public boolean equals(Object o)

Description copied from class: EMessage

Returns true if o is a non-null EMessage instance with a subject and timestamp equal to this EMessage instance and false otherwise.

Overrides:

equals in class EMessage

Parameters:

o - comparison object.

Returns:

true if the message fields are equal and false otherwise.

hashCode

public int hashCode()

Description copied from class: EMessage

Returns the message header hash code.

Overrides:

hashCode in class EMessage

Returns:

the message header hash code.

toString

public String toString()

Returns a human-readable text version of this message.

Overrides:

toString in class EMessage

Returns:

text version of this message.

builder

public static RemoteAck.Builder builder()

Returns a new instance of the RemoteAck message builder.

Returns:

message builder instance.