ch.awae.netcode

Class NetcodeServerFactory

java.lang.Object

ch.awae.netcode.NetcodeServerFactory

public final class NetcodeServerFactory
extends java.lang.Object

Factory for creating netcode server instances. The following configuration is assumed by default:

• socketMode: TLS
• securityMode: ANONYMOUS
• appId validation: appIds of the pattern [a-zA-Z0-9_]+ are accepted
• channelId generation: random String of the pattern [a-zA-Z0-9]{6}
• enable public channels: true
• enable server commands: true

Since:

netcode 0.1.0

Author:

Andreas Wälchli

See Also:

NetcodeServer, RandomStringGenerator

Constructor Summary

Constructors

Constructor and Description
NetcodeServerFactory(int port) Creates a new factory instance with a specified port number.

Method Summary

Modifier and Type	Method and Description
void	runAfterBind(java.util.function.Consumer<java.net.ServerSocket> runner) Adds a function to the post-bind queue.
void	setAppIdValidator(java.util.function.Predicate<java.lang.String> appIdValidator) Defines an application id validator.
void	setChannelIdProvider(java.util.function.Supplier<java.lang.String> channelIdProvider) Defines a generator for channel ids.
void	setMaxClients(int max) specifies the connection backlog.
void	setMode(SocketMode socketMode, SecurityMode securityMode) Specifies both the socket mode and the security mode to use for new connections.
NetcodeServer	start() Start the server

Methods inherited from class java.lang.Object

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

Constructor Detail

NetcodeServerFactory

public NetcodeServerFactory(int port)

Creates a new factory instance with a specified port number. must be in the range 0-65535.

Method Detail

setMode

public void setMode(SocketMode socketMode,
                    SecurityMode securityMode)

Specifies both the socket mode and the security mode to use for new connections. The socket mode specifies if a plain (unencrypted) connection, SSL, TLS or both (SSL or TLS) should be used. The security mode specifies for secured (TLS/SSL) sockets if an anonymous cipher, a certificate-based cipher (or both) is acceptable. This information is used to negociate a cipher that is acceptable to both the server and the client. If socketMode is set to SocketMode.PLAIN, then the securityMode must be set to SecurityMode.ANY.

Throws:

java.lang.IllegalArgumentException - an illegal combination has been provided

java.lang.NullPointerException - any parameter is null

runAfterBind

public void runAfterBind(java.util.function.Consumer<java.net.ServerSocket> runner)

Adds a function to the post-bind queue. The post-bind queue allows access to the ServerSocket or SSLServerSocket as soon as it is created (but for SSLSockets before the handshake). This allows arbitrary modification of the socket configuration. This is especially useful for SSLServerSockets where more control over the security configuration may be desired. If the socket mode is set to SocketMode.PLAIN, the passed socket will be of type ServerSocket, for all other modes it will be a SSLServerSocket.

Parameters:

runner - the runner to add to the post-bind queue. may not be null.

setMaxClients

public void setMaxClients(int max)

specifies the connection backlog.

See Also:

ServerSocket.ServerSocket(int, int)

start

public NetcodeServer start()
                    throws java.io.IOException

Start the server

Throws:

java.io.IOException

setAppIdValidator

public void setAppIdValidator(java.util.function.Predicate<java.lang.String> appIdValidator)

Defines an application id validator. this validator will be used whenever a client connects to decide wether or not to reject that client.

Parameters:

appIdValidator - may not be null.

setChannelIdProvider

public void setChannelIdProvider(java.util.function.Supplier<java.lang.String> channelIdProvider)

Defines a generator for channel ids. this generator will be used whenever a channel gets created.

Parameters:

appIdValidator - may not be null.