com.hazelcast.nio.tcp

Interface IOThreadingModel

All Known Implementing Classes:

NonBlockingIOThreadingModel, SpinningIOThreadingModel

public interface IOThreadingModel

An abstract of the threading model used by the TcpIpConnection. The default implementation of this is the NonBlockingIOThreadingModel that relies on selectors. But also different implementations can be added like spinning, thread per connection etc. Apart from providing a hook to add new functionality, it also simplifies the TcpIpConnection and TcpIpConnectionManager since concerns are separated: separated:

1. the TcpIpConnectManager is responsible for managing connections
2. the IOThreadingModel is responsible for providing threads to the connections.

The 2 crucial parts of the IOThreadingModel are the:

1. SocketReader: responsible for reading data from the socket(channel)
2. SocketWriter: responsible for writing data to the socket(channel)

The TcpIpConnection is pretty dumb; it doesn't know anything about threading models; it just owns a SocketReader and SocketWriter. This keeps the TcpIpConnection very clean and flexible. The idea is that different SocketReader and SocketWriter implementations can be made. We already have specific one for non blocking (selector based) IO and for spinning io. These SocketReader/SocketWriter instances only focus on getting data to and from the socket; they do not concern themselves about interpreting the data. This is a concern of the ReadHandler and the WriteHandler instance each SocketReader/SocketWriter has. So a SocketReader/SocketWriter-class is independent of the type of communication that runs on top of it.

See Also:

NonBlockingIOThreadingModel, SpinningIOThreadingModel, SocketReader, SocketWriter, ReadHandler, WriteHandler, TcpIpConnection

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isBlocking() Tells whether or not every I/O operation on SocketChannel should block until it completes.
SocketReader	newSocketReader(TcpIpConnection connection) Creates a new SocketReader for the given connection.
SocketWriter	newSocketWriter(TcpIpConnection connection) Creates a new SocketWriter for the given connection.
void	onConnectionAdded(TcpIpConnection connection) Is called when a connection is added.
void	onConnectionRemoved(TcpIpConnection connection) Is called when a connection is removed.
void	shutdown() Shuts down the IOThreadingModel.
void	start() Starts the IOThreadingModel.

Method Detail

isBlocking

boolean isBlocking()

Tells whether or not every I/O operation on SocketChannel should block until it completes.

Returns:

true if blocking, false otherwise.

See Also:

java.nio.channels.SelectableChannel#configureBlocking(boolean)}

newSocketWriter

SocketWriter newSocketWriter(TcpIpConnection connection)

Creates a new SocketWriter for the given connection.

Parameters:

connection - the TcpIpConnection to create the SocketWriter for.

Returns:

the created SocketWriter

newSocketReader

SocketReader newSocketReader(TcpIpConnection connection)

Creates a new SocketReader for the given connection.

Parameters:

connection - the TcpIpConnection to create the SocketReader for.

Returns:

the created SocketReader

onConnectionAdded

void onConnectionAdded(TcpIpConnection connection)

Is called when a connection is added.

Parameters:

connection - the connection added.

onConnectionRemoved

void onConnectionRemoved(TcpIpConnection connection)

Is called when a connection is removed.

Parameters:

connection - the connection removed.

start

void start()

Starts the IOThreadingModel. Is called by the TcpIpConnectionManager when it starts.

See Also:

TcpIpConnectionManager.start()

shutdown

void shutdown()

Shuts down the IOThreadingModel. Is called by the TcpIpConnectionManager when it shuts down.

See Also:

TcpIpConnectionManager.shutdown()