com.hazelcast.internal.networking

Class OutboundHandler<S,D>

java.lang.Object

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

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

Type Parameters:

S - the type of the source. E.g. a ByteBuffer or a Supplier.

D - the type of the destination. E.g. a ByteBuffer or a Consumer.

Direct Known Subclasses:

ClientMessageEncoder, ClientProtocolEncoder, PacketEncoder, ProtocolEncoder, TextEncoder

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

The OutboundHandler is a ChannelHandler for outbound traffic. An example is the PacketEncoder that takes packets from the src (Provider) and encodes them to the dst (ByteBuffer). OutboundHandler instances are not expected to be thread-safe; each channel will gets its own instance(s). A OutboundHandler is constructed through a ChannelInitializer.

Buffer

The OutboundHandler is responsible for its own destination buffer if it has one. So if needs to be compacted/flipped etc, it should take care of that. If OutboundHandler has an destination buffer and the onWrite() is called, the first thing it should do is to call IOUtil.compactOrClear(ByteBuffer) so it flips to writing mode. And at the end of the onWrite method, the destination buffer should be flipped into reading mode. If the OutboundHandler has a source buffer, it is expected to be in reading mode and it is the responsibility of the OutboundHandler in front to put that buffer in reading mode.

See Also:

Networking, InboundHandler, ChannelInitializer, ChannelErrorHandler, Channel

Field Summary

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

channel, dst, src

Constructor Summary

Constructors

Constructor and Description
OutboundHandler()

Method Summary

Modifier and Type	Method and Description
protected void	initDstBuffer() Initializes the dst ByteBuffer with the value for ChannelOption.SO_SNDBUF.
protected void	initDstBuffer(int sizeBytes) Initializes the dst ByteBuffer with the configured size.
protected void	initDstBuffer(int sizeBytes, byte[] bytes) Initializes the dst ByteBuffer with the configured size.
abstract HandlerStatus	onWrite() A callback to indicate that this OutboundHandler should be processed.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

OutboundHandler

public OutboundHandler()

Method Detail

onWrite

public abstract HandlerStatus onWrite()
                               throws Exception

A callback to indicate that this OutboundHandler should be processed. A OutboundHandler should be able to deal with a spurious wakeup. So it could be for example there is no frame for it to write to.

Returns:

HandlerStatus the status of the handler after processing the src.

Throws:

Exception - if something fails while executing the onWrite. When an exception is thrown, the ChannelErrorHandler is called.

initDstBuffer

protected final void initDstBuffer()

Initializes the dst ByteBuffer with the value for ChannelOption.SO_SNDBUF. The buffer created is reading mode.

initDstBuffer

protected final void initDstBuffer(int sizeBytes)

Initializes the dst ByteBuffer with the configured size. The buffer created is reading mode.

Parameters:

sizeBytes - the size of the dst ByteBuffer.

initDstBuffer

protected final void initDstBuffer(int sizeBytes,
                                   byte[] bytes)

Initializes the dst ByteBuffer with the configured size. The buffer created is reading mode.

Parameters:

sizeBytes - the size of the dst ByteBuffer.

bytes - the bytes added to the buffer. Can be null if nothing should be added.

Throws:

IllegalArgumentException - if the size of the buffer is too small.