ds.funnel.overlay

Interface OverlayManager

All Known Implementing Classes:

OverlayManagerImpl

public interface OverlayManager

Field Summary

Fields

Modifier and Type	Field and Description
static long	CUR_VER
static long	TEMP_VER

Method Summary

Modifier and Type	Method and Description
OverlayVersion	createOverlay(long inVersion) Create a specific version of the overlay.
OverlayVersion	getCurrentOverlay() Get the current version of the overlay used for routing new events.
OverlayPath	getCurrentPath(NodeDetails inNode) Get the most recent known path to the node, up to the current version.
OverlayVersion	getOverlay(long inVersion) Get a specific version of the overlay, creating it if needed.
java.util.List<OverlayVersion>	getOverlays()
OverlayPath	getPath(NodeDetails inNode, long inVersion) Get the known path to a given node for a specific overlay version.
java.util.List<OverlayPath>	getPaths(NodeDetails inNode) Get the known paths to a given node.
boolean	isRequestDataIn()
boolean	removeOverlay(long inVersion) Remove a specific version of the overlay from the set of active overlays.
boolean	removePath(NodeDetails inNode, long inVersion) Remove the known path to a node over a specific version of the overlay.
boolean	setCurrentOverlay(long inVersion) Set a specific version of the overlay as the current version.
boolean	setRequestDataIn(boolean inRequestDataIn) Set the request mode of this node in the overlay.
boolean	updatePath(NodeDetails inNode, OverlayPath inPath) Update the known path to a node for a given version of the overlay.

Field Detail

CUR_VER

static final long CUR_VER

See Also:

Constant Field Values

TEMP_VER

static final long TEMP_VER

See Also:

Constant Field Values

Method Detail

isRequestDataIn

boolean isRequestDataIn()

Returns:

True if there are subscribers requesting data on this node.

setRequestDataIn

boolean setRequestDataIn(boolean inRequestDataIn)

Set the request mode of this node in the overlay.

Parameters:

inRequestDataIn - - True if data should be sent to this node.

Returns:

True if the mode was changed, false otherwise.

getOverlays

java.util.List<OverlayVersion> getOverlays()
                                    throws OverlayException

Returns:

A list of all active overlay versions.

Throws:

OverlayException

getOverlay

OverlayVersion getOverlay(long inVersion)
                   throws OverlayException

Get a specific version of the overlay, creating it if needed.

Parameters:

inVersion - - The version of the overlay to create.

Returns:

The requested overlay version.

Throws:

OverlayException

getCurrentOverlay

OverlayVersion getCurrentOverlay()
                          throws OverlayException

Get the current version of the overlay used for routing new events.

Throws:

OverlayException

setCurrentOverlay

boolean setCurrentOverlay(long inVersion)
                   throws OverlayException

Set a specific version of the overlay as the current version.

Parameters:

inVersion - - The version to mark as current.

Throws:

OverlayException

createOverlay

OverlayVersion createOverlay(long inVersion)
                      throws OverlayException

Create a specific version of the overlay.

Parameters:

inVersion - - The version to create.

Returns:

The empty, newly created overlay version.

Throws:

OverlayException

removeOverlay

boolean removeOverlay(long inVersion)
               throws OverlayException

Remove a specific version of the overlay from the set of active overlays.

Parameters:

inVersion - - The version to remove.

Throws:

OverlayException

getPaths

java.util.List<OverlayPath> getPaths(NodeDetails inNode)
                              throws OverlayException

Get the known paths to a given node.

Parameters:

inNode - - The node to get paths to.

Returns:

A list of all known overlay paths.

Throws:

OverlayException

getPath

OverlayPath getPath(NodeDetails inNode,
                    long inVersion)
             throws OverlayException

Get the known path to a given node for a specific overlay version.

Parameters:

inNode - - The node to get the path to.

inVersion - - The version of the overlay.

Returns:

An overlay path if one is known, null otherwise.

Throws:

OverlayException

getCurrentPath

OverlayPath getCurrentPath(NodeDetails inNode)
                    throws OverlayException

Get the most recent known path to the node, up to the current version.

Parameters:

inNode - - The node to get the path to.

Returns:

An overlay path if one is known, null otherwise.

Throws:

OverlayException

updatePath

boolean updatePath(NodeDetails inNode,
                   OverlayPath inPath)
            throws OverlayException

Update the known path to a node for a given version of the overlay.

Parameters:

inNode - - The node that the path references.

inPath - - The overlay path to the node.

Returns:

True if the path was added or changed, false otherwise.

Throws:

OverlayException

removePath

boolean removePath(NodeDetails inNode,
                   long inVersion)
            throws OverlayException

Remove the known path to a node over a specific version of the overlay.

Parameters:

inNode - - The node that the path references.

inVersion - - The version of the overlay.

Returns:

True if a path was removed, false otherwise.

Throws:

OverlayException