Package org.omegazero.net.server

Class TCPServer

java.lang.Object

org.omegazero.net.common.SelectorHandler

org.omegazero.net.common.ConnectionSelectorHandler

org.omegazero.net.server.TCPServer

All Implemented Interfaces:

Runnable, NetworkApplication, NetServer

Direct Known Subclasses:

PlainTCPServer, TLSServer

public abstract class TCPServer
extends ConnectionSelectorHandler
implements NetServer

TCP/IP server implementation of a NetServer based on java.nio channels.

Field Summary

Fields

Modifier and Type	Field	Description
protected final int	backlog
protected final Collection<InetAddress>	bindAddresses
protected final Collection<Integer>	ports
protected final Consumer<Runnable>	worker

Constructor Summary

Constructors

Constructor	Description
TCPServer(Collection<Integer> ports)
TCPServer(Collection<InetAddress> bindAddresses, Collection<Integer> ports, int backlog, Consumer<Runnable> worker, long idleTimeout)	Constructs a new TCPServer instance. To initialize the server, NetworkApplication.init() of this object must be called.

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.
int	getBacklog()
long	getIdleTimeout()
protected abstract ChannelConnection	handleConnection(SelectionKey selectionKey)
protected void	handleConnectionClosed(SocketConnection conn)	Called when a connection closed.
protected void	handleConnectionPost(ChannelConnection connection)
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.
void	setConnectionCallback(Consumer<SocketConnection> handler)	Sets the callback for a new incoming request. The first parameter of this callback is an SocketConnection instance representing the new connection from the client.
void	setIdleTimeout(long idleTimeout)
void	start()	Runs the main loop of this instance.

Methods inherited from class org.omegazero.net.common.ConnectionSelectorHandler

loopIteration, onConnectionClosed

Methods inherited from class org.omegazero.net.common.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

bindAddresses

protected final Collection<InetAddress> bindAddresses

ports

protected final Collection<Integer> ports

backlog

protected final int backlog

worker

protected final Consumer<Runnable> worker

Constructor Details

TCPServer

public TCPServer(Collection<Integer> ports)

See Also:

• TCPServer#TCPServer(String, Collection, int, Consumer, long)

TCPServer

public TCPServer(Collection<InetAddress> bindAddresses,
 Collection<Integer> ports,
 int backlog,
 Consumer<Runnable> worker,
 long idleTimeout)

Constructs a new TCPServer instance.

To initialize the server, NetworkApplication.init() of this object must be called. After the call succeeded, the server will listen on the specified local address (bindAddress) on the given ports and NetworkApplication.start() must be called to start processing incoming connection requests and data.

Parameters:

bindAddresses - A collection of local addresses to bind to (see ServerSocketChannel.bind(java.net.SocketAddress, int)). May be null to use an automatically assigned address

ports - The list of ports to listen on

backlog - The maximum number of pending connections (see ServerSocketChannel.bind(java.net.SocketAddress, int)). May be 0 to use a default value

worker - A callback accepting tasks to run that may require increased processing time. May be null to run everything using a single thread

idleTimeout - The time in milliseconds to keep connections that had no traffic. May be 0 to disable closing idle connections

Method Details

handleConnection

protected abstract ChannelConnection handleConnection(SelectionKey selectionKey)
                                               throws IOException

Throws:

IOException

handleConnectionPost

protected void handleConnectionPost(ChannelConnection connection)

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, should never return 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 an IO error occurs during any networking operation

setConnectionCallback

public void setConnectionCallback(Consumer<SocketConnection> handler)

Description copied from interface: NetServer

Sets the callback for a new incoming request.

The first parameter of this callback is an SocketConnection instance representing the new connection from the client.

Specified by:

setConnectionCallback in interface NetServer

Parameters:

handler - The connection callback

handleConnectionClosed

protected void handleConnectionClosed(SocketConnection conn)
                               throws IOException

Description copied from class: ConnectionSelectorHandler

Called when a connection closed.

Overrides:

handleConnectionClosed in class ConnectionSelectorHandler

Throws:

IOException

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

getIdleTimeout

public long getIdleTimeout()

setIdleTimeout

public void setIdleTimeout(long idleTimeout)

getBacklog

public int getBacklog()