viceroy.net
Class LeavingPeerMessage

java.lang.Object
  |
  +--viceroy.net.LeavingPeerMessage
All Implemented Interfaces:
Message

public final class LeavingPeerMessage
extends java.lang.Object
implements Message

represents a 'leaving peer' message. This message is sent to the connected peers of a peer that is preparing to leave.

Author:
Anat Talmy
, Oren Dobzinski

Field Summary
private  ViceroyPeer leaving
          the peer which is leaving
private  ViceroyPeer leavingPredecessor
          The leaving peer's predeccessor
private  ViceroyPeer leavingSuccessor
          The leaving peer's successor
private  java.util.SortedMap leavingValues
          The leaving peer's values
 
Constructor Summary
LeavingPeerMessage(ViceroyPeer peer, ViceroyPeer _leavingPredecessor, ViceroyPeer _leavingSuccessor, java.util.SortedMap _leavingValues)
          generates a new message
 
Method Summary
 ViceroyPeer getLeavingPredecessor()
          gets the leaving peer's predecessor
 ViceroyPeer getLeavingSuccessor()
          gets the leaving peer's successor
 java.util.SortedMap getLeavingValues()
          gets the leaving peer's values
 ViceroyPeer getPeer()
          gets the peer that is going to leave
 MessageType getType()
          gets the type of the message
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

leaving

private ViceroyPeer leaving
the peer which is leaving


leavingPredecessor

private ViceroyPeer leavingPredecessor
The leaving peer's predeccessor


leavingSuccessor

private ViceroyPeer leavingSuccessor
The leaving peer's successor


leavingValues

private java.util.SortedMap leavingValues
The leaving peer's values

Constructor Detail

LeavingPeerMessage

public LeavingPeerMessage(ViceroyPeer peer,
                          ViceroyPeer _leavingPredecessor,
                          ViceroyPeer _leavingSuccessor,
                          java.util.SortedMap _leavingValues)
generates a new message

Parameters:
peer - the leaving peer
_leavingPredecessor - The leaving peer's predecessor
_leavingSuccessor - The leaving peer's successor
_leavingValues - The leaving peer's values
Method Detail

getPeer

public ViceroyPeer getPeer()
gets the peer that is going to leave

Returns:
the leaving peer

getLeavingPredecessor

public ViceroyPeer getLeavingPredecessor()
gets the leaving peer's predecessor

Returns:
the leaving peer's predecessor

getLeavingSuccessor

public ViceroyPeer getLeavingSuccessor()
gets the leaving peer's successor

Returns:
the leaving peer's successor

getLeavingValues

public java.util.SortedMap getLeavingValues()
gets the leaving peer's values

Returns:
the leaving peer's values

getType

public MessageType getType()
gets the type of the message

Specified by:
getType in interface Message
Returns:
the type of the message
See Also:
MessageType