ds.funnel.overlay

Interface OverlayLink

All Superinterfaces:

java.lang.AutoCloseable, MessageLink

All Known Implementing Classes:

OverlayLinkImpl

public interface OverlayLink
extends MessageLink

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	OverlayLink.LinkState

Method Summary

Modifier and Type	Method and Description
OverlayPath	getLinkedLoc()
long	getOverlayVer()
boolean	isDataOut()
boolean	isPrimary()
void	sendMessage(TopicEvent inMessage, java.util.List<OverlayPath> inDests) Send a message to the connected destination.
boolean	setPrimary(boolean inPrimary) Set the primary status of this link.

Methods inherited from interface ds.funnel.data.msglink.MessageLink

close, getDispatcher, getEventHandler, getEventProcessor, getLinkedTo, getRecvStats, getSendStats, isAlive, isClient, sendMessage, sendMessage, setEventHandler, setEventProcessor

Method Detail

getOverlayVer

long getOverlayVer()

Returns:

The version of the associated overlay.

getLinkedLoc

OverlayPath getLinkedLoc()

Returns:

The location of the linked node in the overlay.

isPrimary

boolean isPrimary()

Returns:

True if this is a primary link used for routing data.

isDataOut

boolean isDataOut()

Returns:

True if there are subscribers though this link.

setPrimary

boolean setPrimary(boolean inPrimary)
            throws OverlayException

Set the primary status of this link.

Parameters:

inPrimary - - True if this link should be primary.

Returns:

True if the status was changed, false otherwise.

Throws:

OverlayException

sendMessage

void sendMessage(TopicEvent inMessage,
                 java.util.List<OverlayPath> inDests)
          throws LinkException

Send a message to the connected destination.

Parameters:

inMessage - - The message to send.

inDests - - A list of overlay locations to send the message to.

Throws:

LinkException