de.unkrig.commons.net

Class TcpServer

java.lang.Object

de.unkrig.commons.net.TcpServer

All Implemented Interfaces:

de.unkrig.commons.lang.protocol.RunnableWhichThrows<IOException>, de.unkrig.commons.lang.protocol.Stoppable

public class TcpServer
extends Object
implements de.unkrig.commons.lang.protocol.RunnableWhichThrows<IOException>, de.unkrig.commons.lang.protocol.Stoppable

A runnable that accepts TCP connections on a given interface/port and passes them to a TcpServer.ConnectionHandler. Supports SSL.

Notice that this implementation does not use java.nio.channels, i.e. connections are handled synchronously and each blocks one thread. In other words, it does not scale well for thousands of client connections; consider using NioTcpServer for that use case.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TcpServer.ConnectionHandler Represents a TCP connection to a remote peer (e.g. a server or a client).

Constructor Summary

Constructors

Constructor and Description
TcpServer(InetSocketAddress endpoint, int backlog, SSLContext sslContext, TcpServer.ConnectionHandler clientConnectionHandler) Creates a secure server with the specified endpoint and listen backlog.
TcpServer(InetSocketAddress endpoint, int backlog, TcpServer.ConnectionHandler clientConnectionHandler) Creates a (non-secure) server with the specified endpoint and listen backlog.

Method Summary

Modifier and Type	Method and Description
InetSocketAddress	getEndpointAddress() Returns the address and port of the actual endpoint, which may differ from the endpoint given to TcpServer(InetSocketAddress, int, ConnectionHandler)
void	run() Accepts connection requests from clients until the end of time.
void	stop()

Methods inherited from class java.lang.Object

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

Constructor Detail

TcpServer

public TcpServer(InetSocketAddress endpoint,
                 int backlog,
                 TcpServer.ConnectionHandler clientConnectionHandler)
          throws IOException

Creates a (non-secure) server with the specified endpoint and listen backlog.

The address of the endpoint can be used on a multi-homed host for a server that will only accept connect requests to one of its addresses. If address of the endpoint is the wildcard address, it will default accepting connections on any/all local addresses.

The port of the endpoint must be between 0 and 65535, inclusive. If it is zero, then an ephemeral port will be picked for the server socket.

The backlog argument must be a positive value greater than 0. If the value passed if equal or less than 0, then the default value (as of Java 6, 7 and 8: 50) will be assumed.

Parameters:

endpoint - The InetAddress and local port the server will bind to; InetSocketAddress.InetSocketAddress(int) will accept connections on any/all local addresses; port number zero will pick an ephemeral port

backlog - The listen backlog

clientConnectionHandler - Is called exactly once for each accepted connection

Throws:

IOException

TcpServer

public TcpServer(InetSocketAddress endpoint,
                 int backlog,
                 SSLContext sslContext,
                 TcpServer.ConnectionHandler clientConnectionHandler)
          throws IOException

Creates a secure server with the specified endpoint and listen backlog.

The address of the endpoint can be used on a multi-homed host for a server that will only accept connect requests to one of its addresses. If address of the endpoint is the wildcard address, it will default accepting connections on any/all local addresses.

The port of the endpoint must be between 0 and 65535, inclusive. If it is zero, then an ephemoral port will be picked for the server socket.

The backlog argument must be a positive value greater than 0. If the value passed if equal or less than 0, then the default value will be assumed.

Parameters:

endpoint - The local port and InetAddress the server will bind to. If null, then the system will pick up an ephemeral port and a valid local address to bind the socket.

backlog - The listen backlog

clientConnectionHandler - Is called exactly once for each accepted connection

Throws:

IOException

Method Detail

getEndpointAddress

public InetSocketAddress getEndpointAddress()

Returns the address and port of the actual endpoint, which may differ from the endpoint given to TcpServer(InetSocketAddress, int, ConnectionHandler)

run

public void run()
         throws IOException

Accepts connection requests from clients until the end of time. For each accepted connection it creates a deamon thread which invokes the clientConnectionHandler. When that returns, it closes the client socket and the thread dies.

This method completes normally only when stop() is invoked by another thread.

Specified by:

run in interface de.unkrig.commons.lang.protocol.RunnableWhichThrows<IOException>

Throws:

IOException

stop

public void stop()

Specified by:

stop in interface de.unkrig.commons.lang.protocol.Stoppable