com.hazelcast.internal.networking

Interface OutboundPipeline

All Known Implementing Classes:

NioOutboundPipeline

public interface OutboundPipeline

The outbound pipeline of a Channel. So all data that gets written to the network, goes through the outbound pipeline.

Method Summary

Modifier and Type	Method and Description
OutboundPipeline	addLast(OutboundHandler... 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.
OutboundPipeline	remove(OutboundHandler handler) Removes the given handler from the pipeline.
OutboundPipeline	replace(OutboundHandler oldHandler, OutboundHandler... newHandlers) Replaces the old OutboundHandler by the new ones.
OutboundPipeline	wakeup() Request to flush all data to flush from the handlers to the network.

Method Detail

addLast

OutboundPipeline addLast(OutboundHandler... 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

OutboundPipeline replace(OutboundHandler oldHandler,
                         OutboundHandler... newHandlers)

Replaces the old OutboundHandler 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 handlers to replace

newHandlers - the new handlers to insert.

Returns:

this

Throws:

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

remove

OutboundPipeline remove(OutboundHandler 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

OutboundPipeline wakeup()

Request to flush all data to flush from the handlers to the network. It will cause at least one processing of the outbound pipeline. This method is threadsafe and can safely be called from any thread. Calling it while there is nothing in the pipeline will not do any damage, apart from consuming cpu cycles. This can be used for example, with protocol or handshaking. So imagine there is a handshake decoder (e.g. protocol or tls), that as soon as it has received some data like 'hello', it wants to send back a message to the other side as part of the handshake. This can be done by looking up the handshake encoder, queue the message on that encoder and then call this method. This will cause the outbound pipeline to get processed.

Returns:

this