ds.funnel.peer

Interface PeerGroup

All Known Implementing Classes:

PeerGroupImpl

public interface PeerGroup

Method Summary

Modifier and Type	Method and Description
void	addUtilizer(PeerGroupUtilizer inUtilizer) Register a utilizer with this group.
void	forwardEvent(TopicEvent inEvent) Send a topic event to other nodes connected to this overlay.
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.
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.

Method Detail

getTopic

Topic getTopic()

Returns:

The topic for this group.

getLocalDetails

PeerDetails getLocalDetails()

Returns:

Overlay information for this node.

getPeerDetails

PeerDetails getPeerDetails(NodeDetails inDetails)

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.

Parameters:

inDetails - - The node to lookup.

Returns:

Overlay information if the node is known, null otherwise.

getCoordinators

java.util.List<PeerDetails> getCoordinators()

Returns:

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

getKnownPeers

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

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.

Returns:

Overlay information for any known nodes.

Throws:

OverlayException

updatePeerDetails

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

Update overlay information for a given node.

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

boolean removePeerDetails(NodeDetails inDetails)

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

Parameters:

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

Returns:

True if the node was removed.

getUtilizers

java.util.List<PeerGroupUtilizer> getUtilizers()

Returns:

A list of all utilizers registered with this group.

addUtilizer

void addUtilizer(PeerGroupUtilizer inUtilizer)
          throws OverlayException

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.

Parameters:

inUtilizer - - The utilizer to register.

Throws:

OverlayException

removeUtilizer

void removeUtilizer(PeerGroupUtilizer inUtilizer)

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

Parameters:

inUtilizer - - The utilizer to unregister.

getOverlayManager

OverlayManager getOverlayManager()
                          throws OverlayException

Returns:

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

Throws:

OverlayException

getOverlayLinks

OverlayVersion getOverlayLinks()
                        throws OverlayException

Returns:

The current version of the routing overlay.

Throws:

OverlayException

setGraphBuilder

void setGraphBuilder(GraphBuilder inBuilder)
              throws OverlayException

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

Parameters:

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

Throws:

OverlayException

setTreeBuilder

void setTreeBuilder(GraphBuilder inBuilder)
             throws OverlayException

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.

Parameters:

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

Throws:

OverlayException

processEvent

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

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.

Parameters:

inEvent - - The event to process.

Throws:

LinkException

java.lang.Exception

forwardEvent

void forwardEvent(TopicEvent inEvent)
           throws LinkException

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

Parameters:

inEvent - - The event to send over the overlay.

Throws:

LinkException