Package com.kristensoft.kdc

Class ClientParameters.Builder<T extends ClientParameters.Builder<T>>

java.lang.Object

com.kristensoft.kdc.Parameters.Builder<T>

com.kristensoft.kdc.ClientParameters.Builder<T>

Type Parameters:

T - the protocol-specific builder type.

Direct Known Subclasses:

KristenHttpClientParameters.Builder, MulticastParameters.Builder, TcpClientParameters.Builder, UdpClientParameters.Builder

Enclosing class:

ClientParameters

public abstract static class ClientParameters.Builder<T extends ClientParameters.Builder<T>>
extends Parameters.Builder<T>

Base builder for configuring client parameters. Provides common client configuration used by protocol-specific client parameter builders.

Constructor Summary

Constructors

Constructor	Description
Builder()	Creates a builder for configuring client parameters.

Method Summary

Modifier and Type	Method	Description
abstract ClientParameters	build()	Builds the client parameters using the current builder configuration.
T	withRemoteAddress(int port)	Sets the remote address to the local loopback address using the specified port.
T	withRemoteAddress(String host, int port)	Sets the remote address using the specified host and port.
T	withRemoteAddress(InetAddress address, int port)	Sets the remote address using the specified network address and port.
T	withRemoteAddress(InetSocketAddress remoteAddress)	Sets the remote address to which the client will connect.
T	withSendSyncTimeout(long replyWaitTime)	Sets the amount of time a synchronous send waits for a reply before timing out.

Methods inherited from class com.kristensoft.kdc.Parameters.Builder

addWhiteListEntry, registerApi, registerApi, registerApis, withAutoStart, withBindAddress, withBindAddress, withBindAddress, withCompressed, withConnectionQueuePoolSize, withCrc, withEncryptionKey, withLatencyMode, withLatencyReportingInterval, withMaxReceivedBufferSize, withMaxSendBufferSize, withSerializationFormat, withWhiteList

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Creates a builder for configuring client parameters.

Method Detail

withRemoteAddress

public T withRemoteAddress(InetSocketAddress remoteAddress)

Sets the remote address to which the client will connect.

Parameters:

remoteAddress - the remote socket address.

Returns:

this builder.

Throws:

IllegalArgumentException - if remoteAddress is null.

withRemoteAddress

public T withRemoteAddress(String host,
                           int port)

Sets the remote address using the specified host and port.

Parameters:

host - the remote host name or IP address.

port - the remote port, from 0 through 65535.

Returns:

this builder.

Throws:

IllegalArgumentException - if host is null, or if port is outside the range 0 through 65535.

withRemoteAddress

public T withRemoteAddress(InetAddress address,
                           int port)

Sets the remote address using the specified network address and port.

Parameters:

address - the remote network address.

port - the remote port, from 0 through 65535.

Returns:

this builder.

Throws:

IllegalArgumentException - if address is null, or if port is outside the range 0 through 65535.

withRemoteAddress

public T withRemoteAddress(int port)

Sets the remote address to the local loopback address using the specified port.

Parameters:

port - the remote port, from 0 through 65535.

Returns:

this builder.

Throws:

IllegalArgumentException - if port is outside the range 0 through 65535.

withSendSyncTimeout

public T withSendSyncTimeout(long replyWaitTime)

Sets the amount of time a synchronous send waits for a reply before timing out.

Parameters:

replyWaitTime - the synchronous reply timeout in milliseconds.

Returns:

this builder.

Throws:

IllegalArgumentException - if replyWaitTime is less than 0.

build

public abstract ClientParameters build()

Builds the client parameters using the current builder configuration.

Specified by:

build in class Parameters.Builder<T extends ClientParameters.Builder<T>>

Returns:

the configured client parameters.