ds.funnel.data.msglink

Interface MessageLink

All Superinterfaces:

java.lang.AutoCloseable

All Known Subinterfaces:

OverlayLink

All Known Implementing Classes:

MessageProtocol, OverlayLinkImpl

public interface MessageLink
extends java.lang.AutoCloseable

Method Summary

Modifier and Type	Method and Description
void	close() Close the connection used by this message handler.
EventDispatcher	getDispatcher() Deprecated.
EventHandler<? super MessageEvent>	getEventHandler() Deprecated.
EventProcessor<MessageEvent>	getEventProcessor() Deprecated.
NodeDetails	getLinkedTo()
LinkStatistics	getRecvStats()
LinkStatistics	getSendStats()
boolean	isAlive()
boolean	isClient()
void	sendMessage(MessageEvent sendMsg) Send a message to the connected destination.
<M extends MessageEvent> Task<M>	sendMessage(MessageEvent sendMsg, java.lang.Class<M> respType) Send a message to the connected destination, and get a reply task.
void	setEventHandler(EventHandler<? super MessageEvent> inHandler) Set the event handler that incoming events are passed to.
void	setEventProcessor(EventProcessor<MessageEvent> inProcess) Set the event handler that incoming events are passed to.

Method Detail

getLinkedTo

NodeDetails getLinkedTo()

Returns:

The details of the connected node.

isAlive

boolean isAlive()

Returns:

True if the connection is still able to send messages.

isClient

boolean isClient()

Returns:

True if this is the client (opening) side of a connection.

getRecvStats

LinkStatistics getRecvStats()

Returns:

Statistics for messages received by this message handler.

getSendStats

LinkStatistics getSendStats()

Returns:

Statistics for messages sent using this message handler.

getDispatcher

@Deprecated
EventDispatcher getDispatcher()

Deprecated.

Returns:

The event dispatcher used for received messages.

getEventHandler

@Deprecated
EventHandler<? super MessageEvent> getEventHandler()

Deprecated.

Returns:

The event handler that incoming events are passed to.

setEventHandler

void setEventHandler(EventHandler<? super MessageEvent> inHandler)
              throws LinkException

Set the event handler that incoming events are passed to.

Throws:

LinkException

getEventProcessor

@Deprecated
EventProcessor<MessageEvent> getEventProcessor()

Deprecated.

Returns:

The event processor that incoming events are passed to.

setEventProcessor

void setEventProcessor(EventProcessor<MessageEvent> inProcess)
                throws LinkException

Set the event handler that incoming events are passed to.

Throws:

LinkException

sendMessage

void sendMessage(MessageEvent sendMsg)
          throws LinkException

Send a message to the connected destination.

Parameters:

sendMsg - - The message to send.

Throws:

java.io.IOException

LinkException

sendMessage

<M extends MessageEvent> Task<M> sendMessage(MessageEvent sendMsg,
                                             java.lang.Class<M> respType)
                                      throws LinkException

Send a message to the connected destination, and get a reply task.

Parameters:

sendMsg - - The message to send.

respType - - The class of the expected response message.

Returns:

A task that will return the response message.

Throws:

java.io.IOException

LinkException

close

void close()

Close the connection used by this message handler.

Specified by:

close in interface java.lang.AutoCloseable