ds.funnel.overlay

Class OverlayManagerImpl

java.lang.Object

ds.funnel.node.compnt.NodeComponentImpl

ds.funnel.overlay.OverlayManagerImpl

All Implemented Interfaces:

NodeComponent, OverlayManager

public class OverlayManagerImpl
extends NodeComponentImpl
implements OverlayManager

Field Summary

Fields inherited from interface ds.funnel.overlay.OverlayManager

CUR_VER, TEMP_VER

Constructor Summary

Constructors

Constructor and Description
OverlayManagerImpl(PeerGroupImpl inGroup)

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()
void	onLinkUpdatedRemote(ds.funnel.overlay.event.MsgTLinkUpdate inEvent)
MessageLink	openBackingLink(NodeDetails inNode)
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.
MessageLink	setBackingLink(NodeDetails inNode, MessageLink inLink)
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.
java.lang.String	toString()
boolean	updatePath(NodeDetails inNode, OverlayPath inPath) Update the known path to a node for a given version of the overlay.

Methods inherited from class ds.funnel.node.compnt.NodeComponentImpl

getComponentKey, getComponentLink, hashCode, setComponentKey, startComponent, stopComponent

Methods inherited from class java.lang.Object

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

Constructor Detail

OverlayManagerImpl

public OverlayManagerImpl(PeerGroupImpl inGroup)

Method Detail

isRequestDataIn

public boolean isRequestDataIn()

Specified by:

isRequestDataIn in interface OverlayManager

Returns:

True if there are subscribers requesting data on this node.

setRequestDataIn

public boolean setRequestDataIn(boolean inRequestDataIn)

Description copied from interface: OverlayManager

Set the request mode of this node in the overlay.

Specified by:

setRequestDataIn in interface OverlayManager

Parameters:

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

Returns:

True if the mode was changed, false otherwise.

getOverlays

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

Specified by:

getOverlays in interface OverlayManager

Returns:

A list of all active overlay versions.

Throws:

OverlayException

getOverlay

public OverlayVersion getOverlay(long inVersion)
                          throws OverlayException

Description copied from interface: OverlayManager

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

Specified by:

getOverlay in interface OverlayManager

Parameters:

inVersion - - The version of the overlay to create.

Returns:

The requested overlay version.

Throws:

OverlayException

getCurrentOverlay

public OverlayVersion getCurrentOverlay()
                                 throws OverlayException

Description copied from interface: OverlayManager

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

Specified by:

getCurrentOverlay in interface OverlayManager

Throws:

OverlayException

setCurrentOverlay

public boolean setCurrentOverlay(long inVersion)
                          throws OverlayException

Description copied from interface: OverlayManager

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

Specified by:

setCurrentOverlay in interface OverlayManager

Parameters:

inVersion - - The version to mark as current.

Throws:

OverlayException

createOverlay

public OverlayVersion createOverlay(long inVersion)
                             throws OverlayException

Description copied from interface: OverlayManager

Create a specific version of the overlay.

Specified by:

createOverlay in interface OverlayManager

Parameters:

inVersion - - The version to create.

Returns:

The empty, newly created overlay version.

Throws:

OverlayException

removeOverlay

public boolean removeOverlay(long inVersion)
                      throws OverlayException

Description copied from interface: OverlayManager

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

Specified by:

removeOverlay in interface OverlayManager

Parameters:

inVersion - - The version to remove.

Throws:

OverlayException

getPaths

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

Description copied from interface: OverlayManager

Get the known paths to a given node.

Specified by:

getPaths in interface OverlayManager

Parameters:

inNode - - The node to get paths to.

Returns:

A list of all known overlay paths.

Throws:

OverlayException

getPath

public OverlayPath getPath(NodeDetails inNode,
                           long inVersion)
                    throws OverlayException

Description copied from interface: OverlayManager

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

Specified by:

getPath in interface OverlayManager

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

public OverlayPath getCurrentPath(NodeDetails inNode)
                           throws OverlayException

Description copied from interface: OverlayManager

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

Specified by:

getCurrentPath in interface OverlayManager

Parameters:

inNode - - The node to get the path to.

Returns:

An overlay path if one is known, null otherwise.

Throws:

OverlayException

updatePath

public boolean updatePath(NodeDetails inNode,
                          OverlayPath inPath)
                   throws OverlayException

Description copied from interface: OverlayManager

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

Specified by:

updatePath in interface OverlayManager

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

public boolean removePath(NodeDetails inNode,
                          long inVersion)
                   throws OverlayException

Description copied from interface: OverlayManager

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

Specified by:

removePath in interface OverlayManager

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

openBackingLink

public MessageLink openBackingLink(NodeDetails inNode)
                            throws LinkException

Throws:

LinkException

setBackingLink

public MessageLink setBackingLink(NodeDetails inNode,
                                  MessageLink inLink)

onLinkUpdatedRemote

public void onLinkUpdatedRemote(ds.funnel.overlay.event.MsgTLinkUpdate inEvent)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object