com.hazelcast.internal.networking.nio

Class NioInboundPipeline

java.lang.Object

com.hazelcast.internal.networking.nio.NioPipeline

com.hazelcast.internal.networking.nio.NioInboundPipeline

All Implemented Interfaces:

InboundPipeline, MigratablePipeline, Runnable

public final class NioInboundPipeline
extends NioPipeline
implements InboundPipeline

When the NioThread receives a read event from the Selector, then the process() is called to read out the data from the socket into a bytebuffer and hand it over to the InboundHandler to get processed.

Field Summary

Fields inherited from class com.hazelcast.internal.networking.nio.NioPipeline

channel, LOAD_BALANCING_BYTE, LOAD_BALANCING_FRAME, LOAD_BALANCING_HANDLE, loadType, logger, owner, processCount, selectionKey, socketChannel

Method Summary

Modifier and Type	Method and Description
InboundPipeline	addLast(InboundHandler... addedHandlers) Adds the handlers at the end of the pipeline.
protected Iterable<? extends ChannelHandler>	handlers() Returns an Iterable that can iterate over each ChannelHandler of the pipeline.
long	lastReadTimeMillis()
long	load() Get 'load' recorded by the current pipeline.
long	normalFramesRead()
long	priorityFramesRead()
InboundPipeline	remove(InboundHandler handler) Removes the given handler from the pipeline.
InboundPipeline	replace(InboundHandler oldHandler, InboundHandler... addedHandlers) Replaces the old InboundHandler by the new ones.
String	toString()
NioInboundPipeline	wakeup() Wakes up the inbound pipeline and lets it to start reading again from the network.

Methods inherited from class com.hazelcast.internal.networking.nio.NioPipeline

getChannel, onError, owner, requestMigration, run

Methods inherited from class java.lang.Object

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

Method Detail

normalFramesRead

public long normalFramesRead()

priorityFramesRead

public long priorityFramesRead()

load

public long load()

Description copied from interface: MigratablePipeline

Get 'load' recorded by the current pipeline. It can be used to calculate whether this pipeline should be migrated to a different NioThread

Specified by:

load in interface MigratablePipeline

Returns:

total load recorded by this pipeline

lastReadTimeMillis

public long lastReadTimeMillis()

toString

public String toString()

Overrides:

toString in class Object

handlers

protected Iterable<? extends ChannelHandler> handlers()

Description copied from class: NioPipeline

Returns an Iterable that can iterate over each ChannelHandler of the pipeline.

This method is called only by the NioPipeline.onError(Throwable).

Specified by:

handlers in class NioPipeline

Returns:

the Iterable.

remove

public InboundPipeline remove(InboundHandler handler)

Description copied from interface: InboundPipeline

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

Specified by:

remove in interface InboundPipeline

Parameters:

handler - the handler to remove

Returns:

this

addLast

public InboundPipeline addLast(InboundHandler... addedHandlers)

Description copied from interface: InboundPipeline

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.

Specified by:

addLast in interface InboundPipeline

Parameters:

addedHandlers - the handlers to add

Returns:

this

replace

public InboundPipeline replace(InboundHandler oldHandler,
                               InboundHandler... addedHandlers)

Description copied from interface: InboundPipeline

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.

Specified by:

replace in interface InboundPipeline

Parameters:

oldHandler - the handler to replace

addedHandlers - the new handlers to insert

Returns:

this

wakeup

public NioInboundPipeline wakeup()

Description copied from interface: InboundPipeline

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.

Specified by:

wakeup in interface InboundPipeline

Returns:

this