jgroup.relacs.events
Class DeliveryAck

java.lang.Object
  jgroup.relacs.events.Event
      jgroup.relacs.events.DeliveryAck

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable, EventTags

public final class DeliveryAck
extends Event

The DeliveryAck class represents a local message exchanged between members and the daemon; it is used by the member to notify the daemon that a message has been successfully delivered.

Since:

Jgroup 1.2

Author:

Alberto Montresor

See Also:

Serialized Form

Field Summary

Fields inherited from class jgroup.relacs.events.Event

gid, tag

Fields inherited from interface jgroup.relacs.events.EventTags

DAEMON_FAILURE_EVENT, DELIVERY_ACK, DELIVERY_EVENT, INSTALL_ACK, INSTALL_EVENT, JOIN_REQUEST, LEAVE_REQUEST, MEMBER_LEFT_EVENT, MULTICAST_REQUEST, PREPARE_ACK, PREPARE_EVENT

Constructor Summary

DeliveryAck()
Default constructor for externalization.

DeliveryAck(int gid, int hostIndex, int memberIndex, int viewIndex, int mid, MemberId sender, java.lang.Object result, MemberId ackSender)
Creates a DeliveryAck with the specified data.

Method Summary

MemberId	getAckSender() Returns the sender of this ack message.
int	getHostIndex() Returns the position index of the local host in the array of the hosts contained in the current view.
int	getMemberIndex() Returns the position index of this member in the array of the local members contained in the current view.
int	getMessageId() Returns the message identifier.
java.lang.Object	getResult() Returns the result object associated to the message acknowledgement.
MemberId	getSender() Returns the sender identifier of the original message sender.
int	getViewIndex() Returns the position index of this member in the array of the members contained in the current view.
void	readExternal(java.io.ObjectInput in) Restores the content of this object from the marshalled data contained in the specified input stream.
java.lang.String	toString() Returns a string representation of the object.
void	writeExternal(java.io.ObjectOutput out) Marshals the content of this object to the specified output stream.

Methods inherited from class jgroup.relacs.events.Event

getGid, getTag

Methods inherited from class java.lang.Object

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

Constructor Detail

DeliveryAck

public DeliveryAck()

Default constructor for externalization.

DeliveryAck

public DeliveryAck(int gid,
                   int hostIndex,
                   int memberIndex,
                   int viewIndex,
                   int mid,
                   MemberId sender,
                   java.lang.Object result,
                   MemberId ackSender)

Creates a DeliveryAck with the specified data.

Parameters:

gid - group identifier

hostIndex - host position in the current view

memberIndex - member position in the current view

viewIndex -

mid - message identifier

sender - sender identifier

result - result associated to the message acknowledgement

Method Detail

getHostIndex

public int getHostIndex()

Returns the position index of the local host in the array of the hosts contained in the current view.

getMemberIndex

public int getMemberIndex()

Returns the position index of this member in the array of the local members contained in the current view.

getViewIndex

public int getViewIndex()

Returns the position index of this member in the array of the members contained in the current view.

getMessageId

public int getMessageId()

Returns the message identifier.

getSender

public MemberId getSender()

Returns the sender identifier of the original message sender.

getResult

public java.lang.Object getResult()

Returns the result object associated to the message acknowledgement.

getAckSender

public MemberId getAckSender()

Returns the sender of this ack message.

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Restores the content of this object from the marshalled data contained in the specified input stream.

Specified by:

readExternal in interface java.io.Externalizable

Overrides:

readExternal in class Event

Parameters:

in - the stream to be read

Throws:

java.io.IOException

java.lang.ClassNotFoundException

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Marshals the content of this object to the specified output stream.

Specified by:

writeExternal in interface java.io.Externalizable

Overrides:

writeExternal in class Event

Parameters:

out - the stream to be written

Throws:

java.io.IOException

toString

public java.lang.String toString()

Returns a string representation of the object.

Overrides:

toString in class Event