com.hazelcast.internal.networking

Class InboundHandler<S,D>

java.lang.Object

com.hazelcast.internal.networking.ChannelHandler<InboundHandler,S,D>

com.hazelcast.internal.networking.InboundHandler<S,D>

Direct Known Subclasses:

InboundHandlerWithCounters, SingleProtocolDecoder, TextDecoder, UnifiedProtocolDecoder

public abstract class InboundHandler<S,D>
extends ChannelHandler<InboundHandler,S,D>

The InboundHandler provides control when data is received and needs to be processed. For example data has received on the socket and needs to be decoded into a Packet. InboundHandler are not expected to be thread-safe; each channel will gets its own instance(s). A InboundHandler is constructed through a ChannelInitializer. If the main task of a InboundHandler is to decode a message (e.g. a Packet), it is best to call this handler a decoder. For example PacketDecoder.

See Also:

OutboundHandler, Networking, ChannelInitializer, ChannelErrorHandler, Channel

Field Summary

Fields inherited from class com.hazelcast.internal.networking.ChannelHandler

channel, dst, src

Constructor Summary

Constructors

Constructor and Description
InboundHandler()

Method Summary

Modifier and Type	Method and Description
protected void	initSrcBuffer() Initializes the src buffer.
protected void	initSrcBuffer(int sizeBytes) Initializes the src buffer.
abstract HandlerStatus	onRead() A callback to indicate that data is available in the src to be processed.

Methods inherited from class com.hazelcast.internal.networking.ChannelHandler

dst, dst, handlerAdded, interceptError, setChannel, src, src

Methods inherited from class java.lang.Object

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

Constructor Detail

InboundHandler

public InboundHandler()

Method Detail

onRead

public abstract HandlerStatus onRead()
                              throws Exception

A callback to indicate that data is available in the src to be processed. InboundHandlers should be able to deal with spurious onReads (so a read even though there is nothing to be processed).

Returns:

HandlerStatus the status of the handler after processing the src.

Throws:

Exception - if something fails while reading data from the src or processing the data (e.g. when a Packet fails to get processed). When an exception is thrown, the ChannelErrorHandler is called.

initSrcBuffer

protected final void initSrcBuffer()

Initializes the src buffer. Should only be called by InboundHandler implementations that have a ByteBuffer as source. The capacity of the src buffer will come from the ChannelOptions using ChannelOption.SO_RCVBUF

initSrcBuffer

protected final void initSrcBuffer(int sizeBytes)

Initializes the src buffer. Should only be called by InboundHandler implementations that have a ByteBuffer as source.

Parameters:

sizeBytes - the size of the srcBuffer in bytes.