ds.funnel.data.channel

Interface ChannelProtocol

All Known Implementing Classes:

MessageProtocol

public interface ChannelProtocol

Method Summary

Modifier and Type	Method and Description
long	getWriteQueueSize() Deprecated.
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.

Method Detail

onRecvBuffer

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

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.

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:

ConnectException

java.io.IOException

onSendBuffer

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

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

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
long getWriteQueueSize()

Deprecated.

Returns:

The size in bytes of the write queue.

onClose

void onClose(ChannelManager inManager)

Indicate that the channel used by this protocol has closed.

Parameters:

inManager - - The channel manager that has closed.