com.hazelcast.internal.networking

Interface InboundPipeline

All Known Implementing Classes:

NioInboundPipeline

public interface InboundPipeline

The InboundPipeline is pipeline responsible for inbound traffic. For example there could be a TLSDecoder followed by a PacketDecoder. A InboundPipeline contains a sequence of InboundHandler instances and the pipeline can be dynamically be modified.

Spurious wakeups

InboundHandlers/OutboundHandlers need to be able to deal with spurious wakeups. E.g. it could be that a PacketDecoder is called without any Packets being available.

Automatic reprocessing on change

When a change in the pipeline is detected, the pipeline is automatically reprocessed. For example when the ProtocolDecoder replaced itself by a PacketDecoder, the whole pipeline (in this case the PacketDecoder) is automatically reprocessed.

Method Summary

Modifier and Type	Method and Description
InboundPipeline	addLast(InboundHandler... handlers) Adds the handlers at the end of the pipeline.
InboundPipeline	remove(InboundHandler handler) Removes the given handler from the pipeline.
InboundPipeline	replace(InboundHandler oldHandler, InboundHandler... newHandlers) Replaces the old InboundHandler by the new ones.
InboundPipeline	wakeup() Wakes up the inbound pipeline and lets it to start reading again from the network.

Method Detail

addLast

InboundPipeline addLast(InboundHandler... handlers)

Adds the handlers at the end of the pipeline. No verification is done if the handler is already added and a handler should only be added once. This method should only be made on the thread 'owning' the handler.

Parameters:

handlers - the handlers to add

Returns:

this

replace

InboundPipeline replace(InboundHandler oldHandler,
                        InboundHandler... newHandlers)

Replaces the old InboundHandler by the new ones. So if there is a sequence of handlers [H1,H2,H3] and H2 gets replaced by [H4,H5] the new pipeline will be [H1,H4,H5,H3]. No verification is done if any of the handlers is already added and a handler should only be added once. This method should only be made on the thread 'owning' the handler.

Parameters:

oldHandler - the handler to replace

newHandlers - the new handlers to insert

Returns:

this

Throws:

IllegalArgumentException - is the oldHandler isn't part of this pipeline.

remove

InboundPipeline remove(InboundHandler handler)

Removes the given handler from the pipeline. This method should only be made on the thread 'owning' the handler.

Parameters:

handler - the handler to remove

Returns:

this

Throws:

IllegalArgumentException - is the handler isn't part of this pipeline.

wakeup

InboundPipeline wakeup()

Wakes up the inbound pipeline and lets it to start reading again from the network. Even if there is no data to be read, it will cause at least one processing of the inbound pipeline. This will force any buffered data to be pushed through the inbound pipeline. This method is threadsafe and can safely be called from any thread. Calling it while it is already waken up will not do any damage, it will just cause some temporary overhead. This method is useful for example to restart the pipeline after a task that has been offloaded, completes.

Returns:

this