com.hazelcast.internal.networking.nio

Class NioChannel

java.lang.Object

com.hazelcast.internal.networking.AbstractChannel

com.hazelcast.internal.networking.nio.NioChannel

All Implemented Interfaces:

Channel, Closeable, AutoCloseable

public final class NioChannel
extends AbstractChannel

A Channel implementation tailored for non blocking IO using Selector in combination with a non blocking SocketChannel.

Field Summary

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

logger, socketChannel

Constructor Summary

Constructors

Constructor and Description
NioChannel(SocketChannel socketChannel, boolean clientMode, ChannelInitializer channelInitializer, MetricsRegistry metricsRegistry, Executor closeListenerExecutor)

Method Summary

Modifier and Type	Method and Description
long	bytesRead() Returns current count of bytes read from the Channel.
long	bytesWritten() Returns current count of bytes written into the Channel.
protected void	close0() Template method that is called when the Channel is closed.
NioInboundPipeline	inboundPipeline() Returns the InboundPipeline that belongs to this Channel.
void	init(NioInboundPipeline inboundPipeline, NioOutboundPipeline outboundPipeline)
long	lastReadTimeMillis() Returns the last time epoch time in ms a read of the socket was done.
long	lastWriteTimeMillis() Returns the last time epoch time in ms a write to the socket was done.
protected void	onConnect() Template method that can be implemented when the AbstractChannel.connect(InetSocketAddress, int) has completed.
com.hazelcast.internal.networking.nio.NioChannelOptions	options() Returns the ChannelOptions of this Channel.
NioOutboundPipeline	outboundPipeline() Returns the OutboundPipeline that belongs to this Channel.
void	start() Starts the Channel.
String	toString()
boolean	write(OutboundFrame frame) Queues the OutboundFrame to be written at some point in the future.

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

addCloseListener, attributeMap, close, connect, isClientMode, isClosed, localSocketAddress, notifyCloseListeners, remoteSocketAddress, socket, socketChannel

Methods inherited from class java.lang.Object

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

Constructor Detail

NioChannel

public NioChannel(SocketChannel socketChannel,
                  boolean clientMode,
                  ChannelInitializer channelInitializer,
                  MetricsRegistry metricsRegistry,
                  Executor closeListenerExecutor)

Method Detail

options

public com.hazelcast.internal.networking.nio.NioChannelOptions options()

Description copied from interface: Channel

Returns the ChannelOptions of this Channel. Call is threadsafe; but calls to the ChannelOptions are not.

Returns:

the config for this channel. Returned value will never be null.

init

public void init(NioInboundPipeline inboundPipeline,
                 NioOutboundPipeline outboundPipeline)

outboundPipeline

public NioOutboundPipeline outboundPipeline()

Description copied from interface: Channel

Returns the OutboundPipeline that belongs to this Channel. This method is threadsafe, but most methods on the OutboundPipeline are not!

Returns:

the OutboundPipeline.

inboundPipeline

public NioInboundPipeline inboundPipeline()

Description copied from interface: Channel

Returns the InboundPipeline that belongs to this Channel. This method is threadsafe, but most methods on the InboundPipeline are not!

Returns:

the InboundPipeline.

write

public boolean write(OutboundFrame frame)

Description copied from interface: Channel

Queues the OutboundFrame to be written at some point in the future. No guarantee is made that the frame actually is going to be written or received. This method is thread-safe.

Parameters:

frame - the frame to write.

Returns:

true if the frame was queued; false if rejected.

onConnect

protected void onConnect()

Description copied from class: AbstractChannel

Template method that can be implemented when the AbstractChannel.connect(InetSocketAddress, int) has completed.

Overrides:

onConnect in class AbstractChannel

lastReadTimeMillis

public long lastReadTimeMillis()

Description copied from interface: Channel

Returns the last time epoch time in ms a read of the socket was done. This method is thread-safe.

Returns:

the last time a read from the socket was done.

lastWriteTimeMillis

public long lastWriteTimeMillis()

Description copied from interface: Channel

Returns the last time epoch time in ms a write to the socket was done. Writing to the socket doesn't mean that data has been send or received; it means that data was written to the SocketChannel. It could very well be that this data is stuck somewhere in an network-buffer. This method is thread-safe.

Returns:

the last time something was written to the socket.

start

public void start()

Description copied from interface: Channel

Starts the Channel. In case of a client-mode channel, the Channel.connect(InetSocketAddress, int) should be called before start is called. When the Channel is started, the ChannelInitializer will be called to initialize the channel and to start with processing inbound and outbound data. This method is not threadsafe and should be made only once.

close0

protected void close0()

Description copied from class: AbstractChannel

Template method that is called when the Channel is closed. It will be called only once.

Overrides:

close0 in class AbstractChannel

bytesRead

public long bytesRead()

Description copied from interface: Channel

Returns current count of bytes read from the Channel. The read values might not reflect the most recent value.

Returns:

count of read bytes

bytesWritten

public long bytesWritten()

Description copied from interface: Channel

Returns current count of bytes written into the Channel. The read values might not reflect the most recent value.

Returns:

count of written bytes

toString

public String toString()

Overrides:

toString in class Object