Package org.omegazero.net.nio.client

Class TCPClientManager

java.lang.Object

org.omegazero.net.nio.util.SelectorHandler

org.omegazero.net.nio.util.ConnectionSelectorHandler

org.omegazero.net.nio.client.TCPClientManager

All Implemented Interfaces:

Runnable, NetClientManager, NetworkApplication

Direct Known Subclasses:

PlainTCPClientManager, TLSClientManager

public abstract class TCPClientManager
extends ConnectionSelectorHandler
implements NetClientManager

TCP/IP implementation of a NetClientManager.

API Note:

Before version 2.1.0, this class was in package org.omegazero.net.client.

Field Summary

Fields

Modifier and Type	Field	Description
protected final Function<SocketConnection,Consumer<Runnable>>	workerCreator

Constructor Summary

Constructors

Constructor	Description
TCPClientManager(Function<SocketConnection,Consumer<Runnable>> workerCreator)

Method Summary

Modifier and Type	Method	Description
void	close()	Closes this application, closing all bound and connected sockets and stopping the main loop, causing a call to NetworkApplication.start() to return.
SocketConnection	connection(ConnectionParameters params)	Creates a new connection instance based on the given parameters to be managed by this NetClientManager.
protected abstract ChannelConnection	createConnection(SelectionKey selectionKey, ConnectionParameters params)
protected abstract void	handleConnect(ChannelConnection conn)	Called when a connection was established.
protected void	handleSelectedKey(SelectionKey key)	Called when a key was selected in a select call in the SelectorHandler.runSelectorLoop() method.
void	init()	Initializes this application.
protected void	loopIteration()	Called every loop iteration in SelectorHandler.runSelectorLoop(), which is every time Selector.select() returns, either because a SelectionKey was selected or the selector was woken up for any other reason (for example after a call to SelectorHandler.selectorWakeup()). This method does nothing by default.
void	start()	Runs the main loop of this instance.

Methods inherited from class org.omegazero.net.nio.util.ConnectionSelectorHandler

handleConnectionClosed, onConnectionClosed

Methods inherited from class org.omegazero.net.nio.util.SelectorHandler

closeSelector, initSelector, isRunning, registerChannel, registerChannel, runSelectorLoop, selectorKeys, selectorWakeup

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.omegazero.net.common.NetworkApplication

run

Field Details

workerCreator

protected final Function<SocketConnection,Consumer<Runnable>> workerCreator

Constructor Details

TCPClientManager

public TCPClientManager(Function<SocketConnection,Consumer<Runnable>> workerCreator)

Method Details

createConnection

protected abstract ChannelConnection createConnection(SelectionKey selectionKey,
 ConnectionParameters params)
                                               throws IOException

Throws:

IOException

handleConnect

protected abstract void handleConnect(ChannelConnection conn)

Called when a connection was established.

Parameters:

conn - The ChannelConnection object representing the connection that was established

init

public void init()
          throws IOException

Description copied from interface: NetworkApplication

Initializes this application.

Specified by:

init in interface NetworkApplication

Throws:

IOException - If an IO error occurs during initialization

close

public void close()
           throws IOException

Description copied from interface: NetworkApplication

Closes this application, closing all bound and connected sockets and stopping the main loop, causing a call to NetworkApplication.start() to return.

Specified by:

close in interface NetworkApplication

Throws:

IOException - If an IO error occurs

start

public void start()
           throws IOException

Description copied from interface: NetworkApplication

Runs the main loop of this instance. This loop processes incoming or outgoing connection requests and network traffic.

Under normal circumstances, never returns before NetworkApplication.close() is called. After close() is called, this function should return as soon as possible.

If this method is called before NetworkApplication.init(), the behavior is undefined.

Specified by:

start in interface NetworkApplication

Throws:

IOException - If a fatal IO error occurs during any networking operation

connection

public SocketConnection connection(ConnectionParameters params)
                            throws IOException

Description copied from interface: NetClientManager

Creates a new connection instance based on the given parameters to be managed by this NetClientManager.

SocketConnection.connect(int) will need to be called on the returned connection instance to initiate the connection.

Specified by:

connection in interface NetClientManager

Parameters:

params - Parameters for this connection

Returns:

The new connection instance

Throws:

IOException - If an error occurs while creating the connection. Subsequent network errors (for example, because the server refused the connection) are usually passed to the onError callback of the new connection instead

loopIteration

protected void loopIteration()
                      throws IOException

Description copied from class: SelectorHandler

Called every loop iteration in SelectorHandler.runSelectorLoop(), which is every time Selector.select() returns, either because a SelectionKey was selected or the selector was woken up for any other reason (for example after a call to SelectorHandler.selectorWakeup()).

This method does nothing by default. Subclasses may override this method to perform additional required operations.

Overrides:

loopIteration in class ConnectionSelectorHandler

Throws:

IOException - If an IO error occurs

handleSelectedKey

protected void handleSelectedKey(SelectionKey key)
                          throws IOException

Description copied from class: SelectorHandler

Called when a key was selected in a select call in the SelectorHandler.runSelectorLoop() method.

Specified by:

handleSelectedKey in class SelectorHandler

Parameters:

key - The selected key

Throws:

IOException - If an IO error occurs