com.hazelcast.internal.networking.nonblocking

Class NonBlockingSocketReader

java.lang.Object

com.hazelcast.internal.networking.nonblocking.AbstractHandler

com.hazelcast.internal.networking.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

Modifier and Type	Field and Description
protected ByteBuffer	inputBuffer

Fields inherited from class com.hazelcast.internal.networking.nonblocking.AbstractHandler

connection, eventCount, ioThread, logger, selectionKey, socketChannel

Constructor Summary

Constructors

Constructor and Description
NonBlockingSocketReader(SocketConnection connection, NonBlockingIOThread ioThread, ILogger logger, IOBalancer balancer, SocketReaderInitializer initializer)

Method Summary

Modifier and Type	Method and Description
void	close() Closes this SocketReader.
SwCounter	getNormalFramesReadCounter() Gets the SwCounter that counts the number of normal packets that have been read.
SwCounter	getPriorityFramesReadCounter() Gets the SwCounter that counts the number of priority packets that have been read.
ByteBuffer	getProtocolBuffer()
void	handle() Called when there are bytes available for reading, or space available to write.
void	init() Initializes this SocketReader.
void	initInputBuffer(ByteBuffer inputBuffer)
void	initReadHandler(ReadHandler readHandler)
long	lastReadTimeMillis() Returns the last Clock.currentTimeMillis() a read of the socket was done.
void	requestMigration(NonBlockingIOThread newOwner) Migrates this handler to a new NonBlockingIOThread.
String	toString()

Methods inherited from class com.hazelcast.internal.networking.nonblocking.AbstractHandler

getEventCount, getOwner, getSelectionKey, getSocketChannel, onFailure

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.hazelcast.internal.networking.SocketReader

getSocketChannel

Field Detail

inputBuffer

protected ByteBuffer inputBuffer

Constructor Detail

NonBlockingSocketReader

public NonBlockingSocketReader(SocketConnection connection,
                               NonBlockingIOThread ioThread,
                               ILogger logger,
                               IOBalancer balancer,
                               SocketReaderInitializer initializer)

Method Detail

getProtocolBuffer

public ByteBuffer getProtocolBuffer()

Specified by:

getProtocolBuffer in interface SocketReader

initInputBuffer

public void initInputBuffer(ByteBuffer inputBuffer)

Specified by:

initInputBuffer in interface SocketReader

initReadHandler

public void initReadHandler(ReadHandler readHandler)

Specified by:

initReadHandler in interface SocketReader

getNormalFramesReadCounter

public SwCounter getNormalFramesReadCounter()

Description copied from interface: SocketReader

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

Specified by:

getNormalFramesReadCounter in interface SocketReader

Returns:

the normal frame counter.

getPriorityFramesReadCounter

public SwCounter getPriorityFramesReadCounter()

Description copied from interface: SocketReader

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

Specified by:

getPriorityFramesReadCounter in interface SocketReader

Returns:

the priority frame counter.

lastReadTimeMillis

public long lastReadTimeMillis()

Description copied from interface: SocketReader

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

Specified by:

lastReadTimeMillis in interface SocketReader

Returns:

the last time a read from the socket was done.

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 Connection.close(String, Throwable) method.

Specified by:

close in interface SocketReader

toString

public String toString()

Overrides:

toString in class Object