ds.funnel.peer

Class PeerGroupImpl

java.lang.Object

ds.funnel.node.compnt.NodeComponentImpl

ds.funnel.peer.PeerGroupImpl

All Implemented Interfaces:

NodeComponent, PeerGroup

public class PeerGroupImpl
extends NodeComponentImpl
implements PeerGroup

Constructor Summary

Constructors

Constructor and Description
PeerGroupImpl(PeerManager inManager, Topic inTopic)

Method Summary

Modifier and Type	Method and Description
void	addUtilizer(PeerGroupUtilizer inUtilizer) Register a utilizer with this group.
java.lang.String	debugTopology()
void	forwardEvent(TopicEvent inEvent) Send a topic event to other nodes connected to this overlay.
ReplyStatus	forwardEventTracked(TopicEvent inEvent)
java.util.List<PeerDetails>	getCoordinators()
java.util.List<PeerDetails>	getKnownPeers() Get the overlay information for any known nodes.
PeerDetails	getLocalDetails()
OverlayVersion	getOverlayLinks()
OverlayManager	getOverlayManager()
PeerDetails	getPeerDetails(NodeDetails inDetails) Get overlay information for a specific node.
Topic	getTopic()
java.util.List<PeerGroupUtilizer>	getUtilizers()
void	processEvent(TopicEvent inEvent) Process a topic event.
void	processQueued(TopicEvent inEvent)
boolean	removePeerDetails(NodeDetails inDetails) Remove overlay information for a given node, removing it from the set of known nodes.
void	removeUtilizer(PeerGroupUtilizer inUtilizer) Unregister a utilizer of this group.
void	setGraphBuilder(GraphBuilder inBuilder) Set the desired topology type.
void	setTreeBuilder(GraphBuilder inBuilder) Set the desired routing tree type.
PeerDetails	updatePeerDetails(NodeDetails inDetails, OverlayPath inPath, int inCoordOrder) Update overlay information for a given node.

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, toString, wait, wait, wait

Constructor Detail

PeerGroupImpl

public PeerGroupImpl(PeerManager inManager,
                     Topic inTopic)

Method Detail

getTopic

public Topic getTopic()

Specified by:

getTopic in interface PeerGroup

Returns:

The topic for this group.

getLocalDetails

public PeerDetails getLocalDetails()

Specified by:

getLocalDetails in interface PeerGroup

Returns:

Overlay information for this node.

getPeerDetails

public PeerDetails getPeerDetails(NodeDetails inDetails)

Description copied from interface: PeerGroup

Get overlay information for a specific node. Only a subset of overlay participants are known by a given node, so this method may return null.

Specified by:

getPeerDetails in interface PeerGroup

Parameters:

inDetails - - The node to lookup.

Returns:

Overlay information if the node is known, null otherwise.

getCoordinators

public java.util.List<PeerDetails> getCoordinators()

Specified by:

getCoordinators in interface PeerGroup

Returns:

Overlay information for coordinator nodes, listed in order of succession.

getKnownPeers

public java.util.List<PeerDetails> getKnownPeers()
                                          throws OverlayException

Description copied from interface: PeerGroup

Get the overlay information for any known nodes. Only a subset of overlay participants are known by a given node, so the result may be empty.

Specified by:

getKnownPeers in interface PeerGroup

Returns:

Overlay information for any known nodes.

Throws:

OverlayException

updatePeerDetails

public PeerDetails updatePeerDetails(NodeDetails inDetails,
                                     OverlayPath inPath,
                                     int inCoordOrder)
                              throws OverlayException

Description copied from interface: PeerGroup

Update overlay information for a given node.

Specified by:

updatePeerDetails in interface PeerGroup

Parameters:

inDetails - - The connection details for the node.

inPath - - The overlay path of the node.

inCoordOrder - - The succession order if a coordinator.

Returns:

Updated overlay information for the node.

Throws:

OverlayException

removePeerDetails

public boolean removePeerDetails(NodeDetails inDetails)

Description copied from interface: PeerGroup

Remove overlay information for a given node, removing it from the set of known nodes. Alternatively, clean the set of known nodes.

Specified by:

removePeerDetails in interface PeerGroup

Parameters:

inDetails - - The node to remove. If null, all expired nodes are removed.

Returns:

True if the node was removed.

getUtilizers

public java.util.List<PeerGroupUtilizer> getUtilizers()

Specified by:

getUtilizers in interface PeerGroup

Returns:

A list of all utilizers registered with this group.

addUtilizer

public void addUtilizer(PeerGroupUtilizer inUtilizer)
                 throws OverlayException

Description copied from interface: PeerGroup

Register a utilizer with this group. When one or more utilizers are registered, the overlay becomes active and connects to other peers. Utilizers are generally publisher or subscriber objects that interact with the group.

Specified by:

addUtilizer in interface PeerGroup

Parameters:

inUtilizer - - The utilizer to register.

Throws:

OverlayException

removeUtilizer

public void removeUtilizer(PeerGroupUtilizer inUtilizer)

Description copied from interface: PeerGroup

Unregister a utilizer of this group. If no more utilizers are registered, this peer will disconnect from other peers and the overlay becomes inactive.

Specified by:

removeUtilizer in interface PeerGroup

Parameters:

inUtilizer - - The utilizer to unregister.

getOverlayManager

public OverlayManager getOverlayManager()
                                 throws OverlayException

Specified by:

getOverlayManager in interface PeerGroup

Returns:

The overlay manager for this topic overlay. Controls overlay versions.

Throws:

OverlayException

getOverlayLinks

public OverlayVersion getOverlayLinks()
                               throws OverlayException

Specified by:

getOverlayLinks in interface PeerGroup

Returns:

The current version of the routing overlay.

Throws:

OverlayException

setGraphBuilder

public void setGraphBuilder(GraphBuilder inBuilder)
                     throws OverlayException

Description copied from interface: PeerGroup

Set the desired topology type. For this method to have any effect, the overlay must be active and this peer must be a coordinator.

Specified by:

setGraphBuilder in interface PeerGroup

Parameters:

inBuilder - - The builder that will construct the desired graph topology.

Throws:

OverlayException

setTreeBuilder

public void setTreeBuilder(GraphBuilder inBuilder)
                    throws OverlayException

Description copied from interface: PeerGroup

Set the desired routing tree type. For this method to have any effect, the overlay must be active and this peer must be a coordinator.

Specified by:

setTreeBuilder in interface PeerGroup

Parameters:

inBuilder - - The builder that will construct the desired routing tree.

Throws:

OverlayException

processEvent

public void processEvent(TopicEvent inEvent)
                  throws java.lang.Exception

Description copied from interface: PeerGroup

Process a topic event. It may be newly created or incoming. Processing an event automatically forwards it based on the needs of the event type.

Specified by:

processEvent in interface PeerGroup

Parameters:

inEvent - - The event to process.

Throws:

LinkException

java.lang.Exception

processQueued

public void processQueued(TopicEvent inEvent)
                   throws java.lang.Exception

Throws:

java.lang.Exception

forwardEvent

public void forwardEvent(TopicEvent inEvent)
                  throws LinkException

Description copied from interface: PeerGroup

Send a topic event to other nodes connected to this overlay.

Specified by:

forwardEvent in interface PeerGroup

Parameters:

inEvent - - The event to send over the overlay.

Throws:

LinkException

forwardEventTracked

public ReplyStatus forwardEventTracked(TopicEvent inEvent)
                                throws LinkException

Throws:

LinkException

debugTopology

public java.lang.String debugTopology()