ds.funnel.overlay

Interface OverlayVersion

All Known Implementing Classes:

OverlayVersionImpl

public interface OverlayVersion

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	OverlayVersion.OverlayState

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.
boolean	unlink(NodeDetails inNode) Close a link.
boolean	updateLocation(int[] inLocation) Update the known location of this node in this version of the overlay.

Method Detail

getVersion

long getVersion()

Returns:

The version of this overlay.

getState

OverlayVersion.OverlayState getState()

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

OverlayPath getLocation()

Returns:

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

updateLocation

boolean updateLocation(int[] inLocation)
                throws OverlayException

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

Parameters:

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

Returns:

True if the location was changed, false otherwise.

Throws:

OverlayException

isActive

boolean isActive()

Returns:

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

isCurrent

boolean isCurrent()

Returns:

True if this is the current version of the overlay.

isLinked

boolean isLinked(NodeDetails inNode)
          throws OverlayException

Check if a link to another node exists.

Parameters:

inNode - - The remote node to test.

Returns:

True if a link to the node exists.

Throws:

OverlayException

getLinks

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

Returns:

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

Throws:

OverlayException

getPrimaryLinks

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

Returns:

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

Throws:

OverlayException

getLink

OverlayLink getLink(NodeDetails inNode)
             throws OverlayException

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

Parameters:

inNode - - The remote node that is linked to.

Returns:

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

Throws:

OverlayException

openLink

OverlayLink openLink(NodeDetails inNode,
                     boolean inPrimary)
              throws OverlayException

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

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

boolean unlink(NodeDetails inNode)
        throws OverlayException

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

Parameters:

inNode - - The remote node to close and remove.

Returns:

Throws:

OverlayException