org.jgroups
Class ViewId

java.lang.Object
  org.jgroups.ViewId

All Implemented Interfaces:

java.lang.Comparable<ViewId>, Streamable

public class ViewId
extends java.lang.Object
implements java.lang.Comparable<ViewId>, Streamable

ViewIds are used for ordering views (each view has a ViewId and a list of members). Ordering between views is important for example in a virtual synchrony protocol where all views seen by a member have to be ordered.

Field Summary

protected Address	creator
protected long	id

Constructor Summary

ViewId()

ViewId(Address creator)
Creates a ViewID with the coordinator address and a Lamport timestamp of 0.

ViewId(Address creator, long id)
Creates a ViewID with the coordinator address and the given Lamport timestamp.

Method Summary

int	compareTo(ViewId other) Establishes an order between 2 ViewIds.
int	compareToIDs(ViewId other) Establishes an order between 2 ViewIds.
ViewId	copy()
boolean	equals(java.lang.Object other)
Address	getCreator() Returns the address of the member that issued this view
long	getId() returns the lamport time of the view
int	hashCode()
void	readFrom(java.io.DataInput in) Read the state of the current object (including superclasses) from instream Note that the input stream must not be closed
int	serializedSize()
java.lang.String	toString()
void	writeTo(java.io.DataOutput out) Write the entire state of the current object (including superclasses) to outstream.

Methods inherited from class java.lang.Object

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

Field Detail

creator

protected Address creator

id

protected long id

Constructor Detail

ViewId

public ViewId()

ViewId

public ViewId(Address creator)

Creates a ViewID with the coordinator address and a Lamport timestamp of 0.

Parameters:

creator - the address of the member that issued this view

ViewId

public ViewId(Address creator,
              long id)

Creates a ViewID with the coordinator address and the given Lamport timestamp.

Parameters:

creator - - the address of the member that issued this view

id - - the Lamport timestamp of the view

Method Detail

getCreator

public Address getCreator()

Returns the address of the member that issued this view

Returns:

the Address of the the creator

getId

public long getId()

returns the lamport time of the view

Returns:

the lamport time timestamp

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

copy

public ViewId copy()

compareTo

public int compareTo(ViewId other)

Establishes an order between 2 ViewIds. The comparison is done on the IDs, if they are equal, we use the creator.

Specified by:

compareTo in interface java.lang.Comparable<ViewId>

Returns:

0 for equality, value less than 0 if smaller, greater than 0 if greater.

compareToIDs

public int compareToIDs(ViewId other)

Establishes an order between 2 ViewIds. Note that we compare only on IDs !

Returns:

0 for equality, value less than 0 if smaller, greater than 0 if greater.

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

writeTo

public void writeTo(java.io.DataOutput out)
             throws java.lang.Exception

Description copied from interface: Streamable

Write the entire state of the current object (including superclasses) to outstream. Note that the output stream must not be closed

Specified by:

writeTo in interface Streamable

Throws:

java.lang.Exception

readFrom

public void readFrom(java.io.DataInput in)
              throws java.lang.Exception

Description copied from interface: Streamable

Read the state of the current object (including superclasses) from instream Note that the input stream must not be closed

Specified by:

readFrom in interface Streamable

Throws:

java.lang.Exception

serializedSize

public int serializedSize()