Package io.lettuce.core

Class SocketOptions.Builder

java.lang.Object

io.lettuce.core.SocketOptions.Builder

Enclosing class:

SocketOptions

public static class SocketOptions.Builder
extends Object

Builder for SocketOptions.

Method Summary

Modifier and Type	Method	Description
SocketOptions	build()	Create a new instance of SocketOptions
SocketOptions.Builder	connectTimeout(long connectTimeout, TimeUnit connectTimeoutUnit)	Deprecated. since 5.0, use connectTimeout(Duration)
SocketOptions.Builder	connectTimeout(Duration connectTimeout)	Set connection timeout.
SocketOptions.Builder	keepAlive(boolean keepAlive)	Set whether to enable TCP keepalive.
SocketOptions.Builder	keepAlive(SocketOptions.KeepAliveOptions keepAlive)	Configure TCP keepalive.
SocketOptions.Builder	tcpNoDelay(boolean tcpNoDelay)	Set whether to disable/enable Nagle's algorithm.
SocketOptions.Builder	tcpUserTimeout(SocketOptions.TcpUserTimeoutOptions tcpUserTimeout)	Configure TCP User Timeout.

Methods inherited from class java.lang.Object

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

Method Detail

connectTimeout

public SocketOptions.Builder connectTimeout(Duration connectTimeout)

Set connection timeout. Defaults to 10 SECONDS. See SocketOptions.DEFAULT_CONNECT_TIMEOUT and SocketOptions.DEFAULT_CONNECT_TIMEOUT_UNIT.

Parameters:

connectTimeout - connection timeout, must be greater 0.

Returns:

this

Since:

5.0

connectTimeout

@Deprecated
public SocketOptions.Builder connectTimeout(long connectTimeout,
                                            TimeUnit connectTimeoutUnit)

Deprecated.

since 5.0, use connectTimeout(Duration)

Set connection timeout. Defaults to 10 SECONDS. See SocketOptions.DEFAULT_CONNECT_TIMEOUT and SocketOptions.DEFAULT_CONNECT_TIMEOUT_UNIT.

Parameters:

connectTimeout - connection timeout, must be greater 0.

connectTimeoutUnit - unit for connectTimeout, must not be null.

Returns:

this

keepAlive

public SocketOptions.Builder keepAlive(boolean keepAlive)

Set whether to enable TCP keepalive. Defaults to false. See SocketOptions.DEFAULT_SO_KEEPALIVE.

Parameters:

keepAlive - whether to enable or disable the TCP keepalive.

Returns:

this

See Also:

SocketOptions.SO_KEEPALIVE

keepAlive

public SocketOptions.Builder keepAlive(SocketOptions.KeepAliveOptions keepAlive)

Configure TCP keepalive. Defaults to disabled. See SocketOptions.DEFAULT_SO_KEEPALIVE.

Parameters:

keepAlive - whether to enable or disable the TCP keepalive.

Returns:

this

Since:

6.1

See Also:

SocketOptions.KeepAliveOptions, SocketOptions.SO_KEEPALIVE

tcpUserTimeout

public SocketOptions.Builder tcpUserTimeout(SocketOptions.TcpUserTimeoutOptions tcpUserTimeout)

Configure TCP User Timeout. Defaults to disabled. See SocketOptions.DEFAULT_TCP_USER_TIMEOUT_ENABLED.

Parameters:

tcpUserTimeout - the TCP User Timeout options.

Returns:

this

Since:

6.2.7

See Also:

SocketOptions.TcpUserTimeoutOptions

tcpNoDelay

public SocketOptions.Builder tcpNoDelay(boolean tcpNoDelay)

Set whether to disable/enable Nagle's algorithm. Defaults to true (Nagle disabled). See SocketOptions.DEFAULT_SO_NO_DELAY.

Disabling TCP NoDelay delays TCP ACK packets to await more data input before confirming the packet.

Parameters:

tcpNoDelay - false to disable TCP NoDelay (enable Nagle's algorithm), true to enable TCP NoDelay (disable Nagle's algorithm).

Returns:

this

See Also:

SocketOptions.TCP_NODELAY

build

public SocketOptions build()

Create a new instance of SocketOptions

Returns:

new instance of SocketOptions