ds.funnel.overlay

Interface OverlayPath

All Superinterfaces:

FormatMarshaller, FormatUnmarshaller<OverlayPath>

All Known Implementing Classes:

OverlayPathImpl

public interface OverlayPath
extends FormatMarshaller, FormatUnmarshaller<OverlayPath>

Field Summary

Fields

Modifier and Type	Field and Description
static OverlayPath	EMPTY_PATH
static OverlayPath	UNMARSHALL

Method Summary

Modifier and Type	Method and Description
OverlayPath	branchPath(int inMemberId) Return a near copy of this path, adding an additional node.
OverlayPath	branchPath(long inVersion, int inMemberId) Return a near copy of this path, adding an additional node, and changing the overlay version.
int	distanceTo(OverlayPath inDestPath) The number of hops to reach the given destination using primary links.
int	getNodeID()
int[]	getPath()
long	getVersion()
boolean	onPathOf(OverlayPath inDestPath) True is this location is on the path of the given destination.
OverlayPath	returnPath() Reverse this path, creating a return routing path.

Methods inherited from interface ds.funnel.data.format.FormatMarshaller

marshall

Methods inherited from interface ds.funnel.data.format.FormatUnmarshaller

unmarshall

Field Detail

EMPTY_PATH

static final OverlayPath EMPTY_PATH

UNMARSHALL

static final OverlayPath UNMARSHALL

Method Detail

getVersion

long getVersion()

Returns:

The version of the associated overlay.

getNodeID

int getNodeID()

Returns:

The IDs of the node specified by this path.

getPath

int[] getPath()

Returns:

An array of node IDs indicating the location of the node in the overlay. This is the the path from the coordinator using primary links.

onPathOf

boolean onPathOf(OverlayPath inDestPath)

True is this location is on the path of the given destination.

Parameters:

inDestPath - - The destination location/path.

Returns:

True if this location is on the given path.

distanceTo

int distanceTo(OverlayPath inDestPath)

The number of hops to reach the given destination using primary links.

Parameters:

inDestPath - - The destination location/path.

Returns:

The number of hops to reach the given destination.

branchPath

OverlayPath branchPath(int inMemberId)

Return a near copy of this path, adding an additional node. The overlay version remains the same.

Parameters:

inMemberId - - The node ID to add.

Returns:

The newly created path.

branchPath

OverlayPath branchPath(long inVersion,
                       int inMemberId)

Return a near copy of this path, adding an additional node, and changing the overlay version.

Parameters:

inVersion - - The overlay version to route using.

inMemberId - - The node ID to add.

Returns:

The newly created path.

returnPath

OverlayPath returnPath()

Reverse this path, creating a return routing path.

Parameters:

inMemberId - - The ID of this node in the path.

Returns:

The newly created return path.