TcpClientParameters (kdc-java 0.9.0-SNAPSHOT API)

java.lang.Object
- com.kristensoft.kdc.Parameters
- - com.kristensoft.kdc.ClientParameters
  - - com.kristensoft.kdc.TcpClientParameters

```
public class TcpClientParameters
extends ClientParameters
```
Defines the configuration parameters for a TcpClient.
TCP client parameters control connection behavior, automatic reconnection, connection and reconnect timing, socket options, event handlers, and the common client settings inherited from ClientParameters.
Instances are created using the TcpClientParameters.Builder.

Author:

Charles B. Kozoyed

See Also:

TcpClient, TcpClientParameters.Builder, TcpClientSocketOptions

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class TcpClientParameters.Builder
Builds TcpClientParameters instances.
- Nested classes/interfaces inherited from class com.kristensoft.kdc.Parameters
  Parameters.Defaults

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`getConnectionTimeout()`	Returns the amount of time allowed for establishing a TCP connection.
`int`	`getReconnectDelay()`	Returns the amount of time to wait between TCP reconnection attempts.
`TcpClientSocketOptions`	`getSocketOptions()`	Returns the socket options used to configure the TCP client's socket.
`List<TcpClientEventHandler>`	`getTcpClientEventHandlers()`	Returns the TCP client event handlers registered with this configuration.
`boolean`	`isAutoReconnect()`	Returns whether automatic reconnection is enabled.

Methods inherited from class com.kristensoft.kdc.ClientParameters
getClientType, getRemoteAddress, getSyncReplyTimeout

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
  - isAutoReconnect
```
public boolean isAutoReconnect()
```
    Returns whether automatic reconnection is enabled.
    
    Returns:
    
    true if automatic reconnection is enabled; false otherwise
  - getConnectionTimeout
```
public int getConnectionTimeout()
```
    Returns the amount of time allowed for establishing a TCP connection.
    
    Returns:
    
    the connection timeout in milliseconds
  - getReconnectDelay
```
public int getReconnectDelay()
```
    Returns the amount of time to wait between TCP reconnection attempts.
    
    Returns:
    
    the reconnect delay in milliseconds
  - getTcpClientEventHandlers
```
public List<TcpClientEventHandler> getTcpClientEventHandlers()
```
    Returns the TCP client event handlers registered with this configuration.
    The returned list is unmodifiable.
    
    Returns:
    
    the registered TCP client event handlers
  - getSocketOptions
```
public TcpClientSocketOptions getSocketOptions()
```
    Returns the socket options used to configure the TCP client's socket.
    
    Returns:
    
    the TCP client socket options