ds.funnel.data.msglink.protocol3

Class MessageProtocol

java.lang.Object

ds.funnel.data.msglink.protocol3.MessageProtocol

All Implemented Interfaces:

ChannelProtocol, MessageLink, java.lang.AutoCloseable

public class MessageProtocol
extends java.lang.Object
implements MessageLink, ChannelProtocol, java.lang.AutoCloseable

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.concurrent.atomic.AtomicInteger	logQueueCt
static java.util.concurrent.atomic.AtomicInteger	logQueueCtF
static java.util.concurrent.atomic.AtomicInteger	logQueueCtL
static java.util.concurrent.atomic.AtomicLong	logQueueNano
static java.util.concurrent.atomic.AtomicLong	logQueueNanoF
static java.util.concurrent.atomic.AtomicLong	logQueueNanoL
static java.util.concurrent.atomic.AtomicLong	logQueueNanoM

Constructor Summary

Constructors

Constructor and Description
MessageProtocol(NodeDetails inLinkedTo, int inMaxChannels)

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()
long	getWriteQueueSize() Deprecated.
boolean	isAlive()
boolean	isClient()
void	onClose(ChannelManager inManager) Indicate that the channel used by this protocol has closed.
boolean	onRecvBuffer(ChannelManager inManager, java.nio.ByteBuffer inBuffer) Called by a channel reader task to pass received bytes to the protocol.
boolean	onSendBuffer(ChannelManager inManager, java.nio.ByteBuffer inBuffer) Called by a channel writer task to obtain bytes to send from the protocol.
MessageProtocol	openVirtual()
void	sendMessage(MessageEvent inMessage) 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.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

logQueueCt

public static java.util.concurrent.atomic.AtomicInteger logQueueCt

logQueueNano

public static java.util.concurrent.atomic.AtomicLong logQueueNano

logQueueNanoM

public static java.util.concurrent.atomic.AtomicLong logQueueNanoM

logQueueCtL

public static java.util.concurrent.atomic.AtomicInteger logQueueCtL

logQueueNanoL

public static java.util.concurrent.atomic.AtomicLong logQueueNanoL

logQueueCtF

public static java.util.concurrent.atomic.AtomicInteger logQueueCtF

logQueueNanoF

public static java.util.concurrent.atomic.AtomicLong logQueueNanoF

Constructor Detail

MessageProtocol

public MessageProtocol(NodeDetails inLinkedTo,
                       int inMaxChannels)

Method Detail

getLinkedTo

public NodeDetails getLinkedTo()

Specified by:

getLinkedTo in interface MessageLink

Returns:

The details of the connected node.

isAlive

public boolean isAlive()

Specified by:

isAlive in interface MessageLink

Returns:

True if the connection is still able to send messages.

isClient

public boolean isClient()

Specified by:

isClient in interface MessageLink

Returns:

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

getRecvStats

public LinkStatistics getRecvStats()

Specified by:

getRecvStats in interface MessageLink

Returns:

Statistics for messages received by this message handler.

getSendStats

public LinkStatistics getSendStats()

Specified by:

getSendStats in interface MessageLink

Returns:

Statistics for messages sent using this message handler.

getDispatcher

@Deprecated
public EventDispatcher getDispatcher()

Deprecated.

Specified by:

getDispatcher in interface MessageLink

Returns:

The event dispatcher used for received messages.

getEventHandler

@Deprecated
public EventHandler<? super MessageEvent> getEventHandler()

Deprecated.

Specified by:

getEventHandler in interface MessageLink

Returns:

The event handler that incoming events are passed to.

setEventHandler

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

Description copied from interface: MessageLink

Set the event handler that incoming events are passed to.

Specified by:

setEventHandler in interface MessageLink

Throws:

LinkException

getEventProcessor

@Deprecated
public EventProcessor<MessageEvent> getEventProcessor()

Deprecated.

Specified by:

getEventProcessor in interface MessageLink

Returns:

The event processor that incoming events are passed to.

setEventProcessor

public void setEventProcessor(EventProcessor<MessageEvent> inProcess)
                       throws LinkException

Description copied from interface: MessageLink

Set the event handler that incoming events are passed to.

Specified by:

setEventProcessor in interface MessageLink

Throws:

LinkException

onRecvBuffer

public boolean onRecvBuffer(ChannelManager inManager,
                            java.nio.ByteBuffer inBuffer)
                     throws java.io.IOException

Description copied from interface: ChannelProtocol

Called by a channel reader task to pass received bytes to the protocol. The protocol should copy the bytes from the buffer and compact it.

Specified by:

onRecvBuffer in interface ChannelProtocol

Parameters:

inManager - - The manager performing the read.

inBuffer - - The (partially) filled direct buffer.

Returns:

True if the protocol is active, False if the channel may be closed.

Throws:

java.io.IOException

sendMessage

public void sendMessage(MessageEvent inMessage)
                 throws LinkException

Description copied from interface: MessageLink

Send a message to the connected destination.

Specified by:

sendMessage in interface MessageLink

Parameters:

inMessage - - The message to send.

Throws:

LinkException

sendMessage

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

Description copied from interface: MessageLink

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

Specified by:

sendMessage in interface MessageLink

Parameters:

sendMsg - - The message to send.

respType - - The class of the expected response message.

Returns:

A task that will return the response message.

Throws:

LinkException

onSendBuffer

public boolean onSendBuffer(ChannelManager inManager,
                            java.nio.ByteBuffer inBuffer)
                     throws java.io.IOException

Description copied from interface: ChannelProtocol

Called by a channel writer task to obtain bytes to send from the protocol.

Specified by:

onSendBuffer in interface ChannelProtocol

Parameters:

inManager - - The manager requesting to write.

inBuffer - - A buffer to be filled by the protocol.

Returns:

True if the protocol is active, False if the channel may be closed.

Throws:

java.io.IOException

getWriteQueueSize

@Deprecated
public long getWriteQueueSize()

Deprecated.

Specified by:

getWriteQueueSize in interface ChannelProtocol

Returns:

The size in bytes of the write queue.

openVirtual

public MessageProtocol openVirtual()
                            throws LinkException

Throws:

LinkException

onClose

public void onClose(ChannelManager inManager)

Description copied from interface: ChannelProtocol

Indicate that the channel used by this protocol has closed.

Specified by:

onClose in interface ChannelProtocol

Parameters:

inManager - - The channel manager that has closed.

close

public void close()

Description copied from interface: MessageLink

Close the connection used by this message handler.

Specified by:

close in interface MessageLink

Specified by:

close in interface java.lang.AutoCloseable