com.hazelcast.internal.networking

Interface SocketReader

All Known Implementing Classes:

NonBlockingSocketReader, SpinningSocketReader

public interface SocketReader

The SocketReader is responsible for reading data from the socket, on behalf of a connection, into a ByteBuffer. Once the data is read into the ByteBuffer, this ByteBuffer is passed to the ReadHandler that takes care of the actual processing of the incoming data. Each SocketConnection has its own SocketReader instance. There are many different flavors of SocketReader:

1. reader for member to member communication
2. reader for (old and new) client to member communication
3. reader for encrypted member to member communication
4. reader for REST/Memcached

A SocketReader is tightly coupled to the threading model; so a SocketReader instance is created using IOThreadingModel.newSocketReader(SocketConnection). Before Hazelcast 3.6 the name of this interface was ReadHandler.

See Also:

ReadHandler, SocketWriter, IOThreadingModel

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()
SocketChannelWrapper	getSocketChannel()
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.

Method Detail

lastReadTimeMillis

long lastReadTimeMillis()

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

Returns:

the last time a read from the socket was done.

getNormalFramesReadCounter

SwCounter getNormalFramesReadCounter()

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

Returns:

the normal frame counter.

getPriorityFramesReadCounter

SwCounter getPriorityFramesReadCounter()

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

Returns:

the priority frame counter.

init

void init()

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

close

void close()

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.

initInputBuffer

void initInputBuffer(ByteBuffer inputBuffer)

initReadHandler

void initReadHandler(ReadHandler readHandler)

getSocketChannel

SocketChannelWrapper getSocketChannel()

getProtocolBuffer

ByteBuffer getProtocolBuffer()