Package com.kristensoft.kdc

Class ClientParameters

java.lang.Object

com.kristensoft.kdc.Parameters

com.kristensoft.kdc.ClientParameters

Direct Known Subclasses:

KristenHttpClientParameters, MulticastParameters, TcpClientParameters, UdpClientParameters

public abstract class ClientParameters
extends Parameters

Base class for parameters used to configure KDC clients. Client parameters define client-specific settings such as the remote address and synchronous reply timeout.

Client parameter instances are created using the builder provided by the protocol-specific client parameters class.

Author:

Charles B. Kozoyed

See Also:

Client, Parameters

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ClientParameters.Builder<T extends ClientParameters.Builder<T>>	Base builder for configuring client parameters.

Nested classes/interfaces inherited from class com.kristensoft.kdc.Parameters

Parameters.Defaults

Method Summary

Modifier and Type	Method	Description
ClientType	getClientType()	Gets the type of this client.
InetSocketAddress	getRemoteAddress()	Gets the remote address associated with this client.
long	getSyncReplyTimeout()	Gets the amount of time a synchronous send waits for a reply before timing out.

Methods inherited from class com.kristensoft.kdc.Parameters

getApiMap, getBindAddress, getConnectionQueuePoolSize, getEncryptionKey, getLatencyReportingInterval, getMaxReceiveBufferSize, getMaxSendBufferSize, getProtocol, getProtocolVersion, getSerializationFormat, getWhiteList, isAutoStart, isCompressed, isCrc, isLatencyModeOn

Methods inherited from class java.lang.Object

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

Method Detail

getClientType

public ClientType getClientType()

Gets the type of this client. The client type identifies the role the client has in the KDC connection and indicates whether it is operating on the client or server side. This is set by KDC.

Returns:

the client type.

getRemoteAddress

public InetSocketAddress getRemoteAddress()

Gets the remote address associated with this client. The remote address identifies the network endpoint to which this client communicates.

Returns:

the remote socket address.

getSyncReplyTimeout

public long getSyncReplyTimeout()

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

Returns:

the synchronous reply timeout in milliseconds.