Package io.hekate.network

Class NetworkServerHandlerConfig<T>

java.lang.Object

io.hekate.network.NetworkServerHandlerConfig<T>

Type Parameters:

T - Base type of messages that can be processed by NetworkServerHandler.

Direct Known Subclasses:

NettyServerHandlerConfig

public class NetworkServerHandlerConfig<T>
extends Object

Configuration for NetworkServerHandler.

See Also:

NetworkServerHandler

Constructor Summary

Constructors

Constructor	Description
NetworkServerHandlerConfig()

Method Summary

Modifier and Type	Method	Description
CodecFactory<T>	getCodecFactory()	Returns the codec factory that should be used for messages serialization (see setCodecFactory(CodecFactory)).
NetworkServerHandler<T>	getHandler()	Returns the handler (see setHandler(NetworkServerHandler).
String	getLoggerCategory()	Returns the logger category that should be used by NetworkServerHandler (see setLoggerCategory(String)).
String	getProtocol()	Returns the protocol identifier (see setProtocol(String)).
void	setCodecFactory(CodecFactory<T> codecFactory)	Sets the codec factory that should be used for messages serialization.
void	setHandler(NetworkServerHandler<T> handler)	Sets the handler.
void	setLoggerCategory(String loggerCategory)	Sets the logger category that should be used by NetworkServerHandler.
void	setProtocol(String protocol)	Sets the connector protocol identifier.
String	toString()
NetworkServerHandlerConfig<T>	withCodecFactory(CodecFactory<T> codecFactory)	Fluent-style version of setCodecFactory(CodecFactory).
NetworkServerHandlerConfig<T>	withHandler(NetworkServerHandler<T> handler)	Fluent-style version of setHandler(NetworkServerHandler).
NetworkServerHandlerConfig<T>	withLoggerCategory(String loggerCategory)	Fluent-style version of setLoggerCategory(String).
NetworkServerHandlerConfig<T>	withProtocol(String protocol)	Fluent-style version of setProtocol(String).

Methods inherited from class java.lang.Object

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

Constructor Detail

NetworkServerHandlerConfig

public NetworkServerHandlerConfig()

Method Detail

getProtocol

public String getProtocol()

Returns the protocol identifier (see setProtocol(String)).

Returns:

Protocol identifier.

setProtocol

public void setProtocol(String protocol)

Sets the connector protocol identifier. Can contain only alpha-numeric characters and non-repeatable dots/hyphens.

Only clients that have the same protocol identifier will be processed by the configured NetworkServerHandler.

This parameter is mandatory and doesn't have a default value.

Note: Protocol identifier must be unique across all registered NetworkServerHandlerConfigs within the NetworkServer.

Parameters:

protocol - Protocol identifier (can contain only alpha-numeric characters and non-repeatable dots/hyphens).

withProtocol

public NetworkServerHandlerConfig<T> withProtocol(String protocol)

Fluent-style version of setProtocol(String).

Parameters:

protocol - Protocol identifier.

Returns:

This instance.

getCodecFactory

public CodecFactory<T> getCodecFactory()

Returns the codec factory that should be used for messages serialization (see setCodecFactory(CodecFactory)).

Returns:

Codec factory.

setCodecFactory

public void setCodecFactory(CodecFactory<T> codecFactory)

Sets the codec factory that should be used for messages serialization.

Only messages that are supported by the specified CodecFactory can be sent/received by the configured NetworkServerHandler. Note that the same factory must be configured on the client side.

This parameter is mandatory and doesn't have a default value.

Parameters:

codecFactory - Codec factory.

withCodecFactory

public NetworkServerHandlerConfig<T> withCodecFactory(CodecFactory<T> codecFactory)

Fluent-style version of setCodecFactory(CodecFactory).

Parameters:

codecFactory - Codec factory.

Returns:

This instance.

getHandler

public NetworkServerHandler<T> getHandler()

Returns the handler (see setHandler(NetworkServerHandler).

Returns:

Handler.

setHandler

public void setHandler(NetworkServerHandler<T> handler)

Sets the handler.

Parameters:

handler - Handler.

withHandler

public NetworkServerHandlerConfig<T> withHandler(NetworkServerHandler<T> handler)

Fluent-style version of setHandler(NetworkServerHandler).

Parameters:

handler - Handler.

Returns:

This instance.

getLoggerCategory

public String getLoggerCategory()

Returns the logger category that should be used by NetworkServerHandler (see setLoggerCategory(String)).

Returns:

Logger category.

setLoggerCategory

public void setLoggerCategory(String loggerCategory)

Sets the logger category that should be used by NetworkServerHandler.

Parameters:

loggerCategory - Logger category.

withLoggerCategory

public NetworkServerHandlerConfig<T> withLoggerCategory(String loggerCategory)

Fluent-style version of setLoggerCategory(String).

Parameters:

loggerCategory - Logger category.

Returns:

This instance.

toString

public String toString()

Overrides:

toString in class Object