Package org.omegazero.net.client

Class NetClientManagerBuilder

java.lang.Object

org.omegazero.net.common.NetworkApplicationBuilder

org.omegazero.net.client.NetClientManagerBuilder

Direct Known Subclasses:

NioClientManagerBuilder

public abstract class NetClientManagerBuilder
extends NetworkApplicationBuilder

A NetworkApplicationBuilder for creating NetClientManagers.

Since:

2.1.0

Nested Class Summary

Nested classes/interfaces inherited from class org.omegazero.net.common.NetworkApplicationBuilder

NetworkApplicationBuilder.TransportType

Field Summary

Fields inherited from class org.omegazero.net.common.NetworkApplicationBuilder

encrypted, sslContext, transportType, workerCreator

Constructor Summary

Constructors

Constructor	Description
NetClientManagerBuilder()

Method Summary

Modifier and Type	Method	Description
abstract NetClientManager	build()	Creates the NetworkApplication from the previously set parameters.
NetClientManagerBuilder	encrypted(boolean encrypted)	Sets whether to use encryption.
NetClientManagerBuilder	set(String option, Object value)	Sets an implementation specific configuration parameter.
NetClientManagerBuilder	sslContext(SSLContext sslContext)	Sets the SSLContext to use for encryption.
NetClientManagerBuilder	transportType(NetworkApplicationBuilder.TransportType transportType)	Sets the NetworkApplicationBuilder.TransportType to use in this instance.
NetClientManagerBuilder	workerCreator(Function<SocketConnection,Consumer<Runnable>> workerCreator)	Sets a worker creator which creates a worker instance for each connection created.

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

addImplementationAlias, newClientManager, newServer, prepareBuild

Methods inherited from class java.lang.Object

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

Constructor Details

NetClientManagerBuilder

public NetClientManagerBuilder()

Method Details

build

public abstract NetClientManager build()

Description copied from class: NetworkApplicationBuilder

Creates the NetworkApplication from the previously set parameters.

Specified by:

build in class NetworkApplicationBuilder

Returns:

The NetworkApplication

transportType

public NetClientManagerBuilder transportType(NetworkApplicationBuilder.TransportType transportType)

Description copied from class: NetworkApplicationBuilder

Sets the NetworkApplicationBuilder.TransportType to use in this instance.

The default is NetworkApplicationBuilder.TransportType.STREAM.

Overrides:

transportType in class NetworkApplicationBuilder

Parameters:

transportType - The TransportType

Returns:

This builder

encrypted

public NetClientManagerBuilder encrypted(boolean encrypted)

Description copied from class: NetworkApplicationBuilder

Sets whether to use encryption. Specific implementation or types may require additional parameters to enable encryption.

The default is false.

Overrides:

encrypted in class NetworkApplicationBuilder

Parameters:

encrypted - Whether encryption is enabled

Returns:

This builder

workerCreator

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

Description copied from class: NetworkApplicationBuilder

Sets a worker creator which creates a worker instance for each connection created.

The default is null (no workers).

Overrides:

workerCreator in class NetworkApplicationBuilder

Parameters:

workerCreator - The function

Returns:

This builder

sslContext

public NetClientManagerBuilder sslContext(SSLContext sslContext)

Description copied from class: NetworkApplicationBuilder

Sets the SSLContext to use for encryption.

This method implicitly enables encryption if the given parameter is not null, and disables it otherwise.

The default is null. Setting this parameter may be required by the implementation if encryption is enabled.

Overrides:

sslContext in class NetworkApplicationBuilder

Parameters:

sslContext - The SSLContext

Returns:

This builder

set

public NetClientManagerBuilder set(String option,
 Object value)

Description copied from class: NetworkApplicationBuilder

Sets an implementation specific configuration parameter.

Overrides:

set in class NetworkApplicationBuilder

Parameters:

option - The name of the parameter

value - The value