public interface OverlayPath extends FormatMarshaller, FormatUnmarshaller<OverlayPath>
| Modifier and Type | Field and Description |
|---|---|
static OverlayPath |
EMPTY_PATH |
static OverlayPath |
UNMARSHALL |
| 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.
|
marshallunmarshallstatic final OverlayPath EMPTY_PATH
static final OverlayPath UNMARSHALL
long getVersion()
int getNodeID()
int[] getPath()
boolean onPathOf(OverlayPath inDestPath)
inDestPath - - The destination location/path.int distanceTo(OverlayPath inDestPath)
inDestPath - - The destination location/path.OverlayPath branchPath(int inMemberId)
inMemberId - - The node ID to add.OverlayPath branchPath(long inVersion, int inMemberId)
inVersion - - The overlay version to route using.inMemberId - - The node ID to add.OverlayPath returnPath()
inMemberId - - The ID of this node in the path.