ds.funnel.overlay

Class OverlayVersionImpl

java.lang.Object

ds.funnel.overlay.OverlayVersionImpl

All Implemented Interfaces:

OverlayVersion

public class OverlayVersionImpl
extends java.lang.Object
implements OverlayVersion

Nested Class Summary

Nested classes/interfaces inherited from interface ds.funnel.overlay.OverlayVersion

OverlayVersion.OverlayState

Constructor Summary

Constructors

Constructor and Description
OverlayVersionImpl(OverlayManagerImpl inManager, long inVersion)

Method Summary

Modifier and Type	Method and Description
OverlayLink	getLink(NodeDetails inNode) Get a link to a specific remote node, if one exists.
java.util.List<OverlayLink>	getLinks()
OverlayPath	getLocation()
java.util.List<OverlayLink>	getPrimaryLinks()
OverlayVersion.OverlayState	getState()
long	getVersion()
boolean	isActive()
boolean	isCurrent()
boolean	isLinked(NodeDetails inNode) Check if a link to another node exists.
OverlayLink	openLink(NodeDetails inNode, boolean inPrimary) Open a link to a specific remote node, if one does not exist.
java.lang.String	toString()
boolean	unlink(NodeDetails inNode) Close a link.
boolean	updateLocation(int[] inLoc) Update the known location of this node in this version of the overlay.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

OverlayVersionImpl

public OverlayVersionImpl(OverlayManagerImpl inManager,
                          long inVersion)
                   throws OverlayException

Throws:

OverlayException

Method Detail

getVersion

public long getVersion()

Specified by:

getVersion in interface OverlayVersion

Returns:

The version of this overlay.

getState

public OverlayVersion.OverlayState getState()

Specified by:

getState in interface OverlayVersion

Returns:

The state of this overlay. Active overlays are used for routing, with the current overlay used for new events. Overlays being built may be altered, and closed overlays should be discarded.

getLocation

public OverlayPath getLocation()

Specified by:

getLocation in interface OverlayVersion

Returns:

The location of the current node in this version of the overlay.

updateLocation

public boolean updateLocation(int[] inLoc)
                       throws OverlayException

Description copied from interface: OverlayVersion

Update the known location of this node in this version of the overlay.

Specified by:

updateLocation in interface OverlayVersion

Parameters:

inLoc - - The path to this node, assigned by a coordinator.

Returns:

True if the location was changed, false otherwise.

Throws:

OverlayException

isActive

public boolean isActive()

Specified by:

isActive in interface OverlayVersion

Returns:

True if this overlay is active and can be used for routing.

isCurrent

public boolean isCurrent()

Specified by:

isCurrent in interface OverlayVersion

Returns:

True if this is the current version of the overlay.

isLinked

public boolean isLinked(NodeDetails inNode)
                 throws OverlayException

Description copied from interface: OverlayVersion

Check if a link to another node exists.

Specified by:

isLinked in interface OverlayVersion

Parameters:

inNode - - The remote node to test.

Returns:

True if a link to the node exists.

Throws:

OverlayException

getLinks

public java.util.List<OverlayLink> getLinks()
                                     throws OverlayException

Specified by:

getLinks in interface OverlayVersion

Returns:

Get a list of all links in this version of the overlay. Closed links may be returned.

Throws:

OverlayException

getPrimaryLinks

public java.util.List<OverlayLink> getPrimaryLinks()
                                            throws OverlayException

Specified by:

getPrimaryLinks in interface OverlayVersion

Returns:

Get a list of all primary links that may be used for routing.

Throws:

OverlayException

getLink

public OverlayLink getLink(NodeDetails inNode)
                    throws OverlayException

Description copied from interface: OverlayVersion

Get a link to a specific remote node, if one exists.

Specified by:

getLink in interface OverlayVersion

Parameters:

inNode - - The remote node that is linked to.

Returns:

A link to the node if one exists, null otherwise.

Throws:

OverlayException

openLink

public OverlayLink openLink(NodeDetails inNode,
                            boolean inPrimary)
                     throws OverlayException

Description copied from interface: OverlayVersion

Open a link to a specific remote node, if one does not exist.

Specified by:

openLink in interface OverlayVersion

Parameters:

inNode - - The remote node to link to.

inPrimary - - True if the new link is primary.

Returns:

The newly opened link, or an existing one.

Throws:

OverlayException

unlink

public boolean unlink(NodeDetails inNode)
               throws OverlayException

Description copied from interface: OverlayVersion

Close a link. The link may or may not be removed depending on overlay state.

Specified by:

unlink in interface OverlayVersion

Parameters:

inNode - - The remote node to close and remove.

Returns:

Throws:

OverlayException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object