com.hazelcast.nio.tcp.nonblocking

Class NonBlockingSocketReader

java.lang.Object

com.hazelcast.nio.tcp.nonblocking.AbstractHandler

com.hazelcast.nio.tcp.nonblocking.NonBlockingSocketReader

All Implemented Interfaces:

MigratableHandler, SelectionHandler, SocketReader

public final class NonBlockingSocketReader
extends AbstractHandler
implements SocketReader

A SocketReader tailored for non blocking IO. When the NonBlockingIOThread receives a read event from the Selector, then the handle() is called to read out the data from the socket into a bytebuffer and hand it over to the ReadHandler to get processed.

Field Summary

Fields inherited from class com.hazelcast.nio.tcp.nonblocking.AbstractHandler

connection, connectionManager, ioService, ioThread, logger, selectionKey, socketChannel

Constructor Summary

Constructors

Constructor and Description
NonBlockingSocketReader(TcpIpConnection connection, NonBlockingIOThread ioThread, MetricsRegistry metricsRegistry)

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes this SocketReader.
long	getEventCount() Get number of events recorded by the current handler.
long	getLastReadTimeMillis() Returns the last Clock.currentTimeMillis() a read of the socket was done.
Counter	getNormalFramesReadCounter() Gets the Counter that counts the number of normal packets that have been read.
Counter	getPriorityFramesReadCounter() Gets the Counter that counts the number of priority packets that have been read.
void	handle() Called when there are bytes available for reading, or space available to write.
void	init() Initializes this SocketReader.
void	requestMigration(NonBlockingIOThread newOwner) Migrates this handler to a new NonBlockingIOThread.
String	toString()

Methods inherited from class com.hazelcast.nio.tcp.nonblocking.AbstractHandler

getOwner, getSelectionKey, onFailure

Methods inherited from class java.lang.Object

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

Constructor Detail

NonBlockingSocketReader

public NonBlockingSocketReader(TcpIpConnection connection,
                       NonBlockingIOThread ioThread,
                       MetricsRegistry metricsRegistry)

Method Detail

getNormalFramesReadCounter

public Counter getNormalFramesReadCounter()

Description copied from interface: SocketReader

Gets the Counter that counts the number of normal packets that have been read.

Specified by:

getNormalFramesReadCounter in interface SocketReader

Returns:

the normal packets counter.

getPriorityFramesReadCounter

public Counter getPriorityFramesReadCounter()

Description copied from interface: SocketReader

Gets the Counter that counts the number of priority packets that have been read.

Specified by:

getPriorityFramesReadCounter in interface SocketReader

Returns:

the priority packets counter.

getLastReadTimeMillis

public long getLastReadTimeMillis()

Description copied from interface: SocketReader

Returns the last Clock.currentTimeMillis() a read of the socket was done.

Specified by:

getLastReadTimeMillis in interface SocketReader

Returns:

the last time a read from the socket was done.

getEventCount

public long getEventCount()

Description copied from interface: MigratableHandler

Get number of events recorded by the current handler. It can be used to calculate whether this handler should be migrated to a different NonBlockingIOThread

Specified by:

getEventCount in interface MigratableHandler

Returns:

total number of events recorded by this handler

init

public void init()

Description copied from interface: SocketReader

Initializes this SocketReader. This method is called from an arbitrary thread and is only called once.

Specified by:

init in interface SocketReader

requestMigration

public void requestMigration(NonBlockingIOThread newOwner)

Migrates this handler to a new NonBlockingIOThread. The migration logic is rather simple:

• Submit a de-registration task to a current NonBlockingIOThread
• The de-registration task submits a registration task to the new NonBlockingIOThread

Specified by:

requestMigration in interface MigratableHandler

Parameters:

newOwner - target NonBlockingIOThread this handler migrates to

handle

public void handle()
            throws Exception

Description copied from interface: SelectionHandler

Called when there are bytes available for reading, or space available to write. Any exception that leads to a termination of the connection like an IOException should not be handled in the handle method but should be propagated. The reason behind this is that the handle logic already is complicated enough and by pulling it out the flow will be easier to understand.

Specified by:

handle in interface SelectionHandler

Throws:

Exception

close

public void close()

Description copied from interface: SocketReader

Closes this SocketReader. This method can be called from an arbitrary thread, and should only be called once. This should be coordinated through the TcpIpConnection#close() method.

Specified by:

close in interface SocketReader

toString

public String toString()

Overrides:

toString in class Object