io.lettuce.core

Class SocketOptions.TcpUserTimeoutOptions.Builder

java.lang.Object

io.lettuce.core.SocketOptions.TcpUserTimeoutOptions.Builder

Enclosing class:

SocketOptions.TcpUserTimeoutOptions

public static class SocketOptions.TcpUserTimeoutOptions.Builder
extends Object

Builder class for SocketOptions.TcpUserTimeoutOptions.

Method Summary

Modifier and Type	Method and Description
SocketOptions.TcpUserTimeoutOptions	build() Create a new instance of SocketOptions.TcpUserTimeoutOptions
SocketOptions.TcpUserTimeoutOptions.Builder	disable() Disable TCP User Timeout.
SocketOptions.TcpUserTimeoutOptions.Builder	enable() Enable TCP User Timeout.
SocketOptions.TcpUserTimeoutOptions.Builder	enable(boolean enabled) Enable or disable TCP User Timeout.
SocketOptions.TcpUserTimeoutOptions.Builder	tcpUserTimeout(Duration tcpUserTimeout) The TCP User Timeout.

Methods inherited from class java.lang.Object

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

Method Detail

enable

public SocketOptions.TcpUserTimeoutOptions.Builder enable()

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

Returns:

this

disable

public SocketOptions.TcpUserTimeoutOptions.Builder disable()

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

Returns:

this

enable

public SocketOptions.TcpUserTimeoutOptions.Builder enable(boolean enabled)

Enable or disable TCP User Timeout. Defaults to disabled. See SocketOptions.DEFAULT_TCP_USER_TIMEOUT_ENABLED.

Parameters:

enabled - whether to enable TCP User Timeout.

Returns:

this

tcpUserTimeout

public SocketOptions.TcpUserTimeoutOptions.Builder tcpUserTimeout(Duration tcpUserTimeout)

The TCP User Timeout. Defaults to 7875 second. See also SocketOptions.TcpUserTimeoutOptions.DEFAULT_TCP_USER_TIMEOUT.

The time granularity of is seconds.

Parameters:

tcpUserTimeout - connection interval time, must be greater 0

Returns:

this

build

public SocketOptions.TcpUserTimeoutOptions build()

Create a new instance of SocketOptions.TcpUserTimeoutOptions

Returns:

new instance of SocketOptions.TcpUserTimeoutOptions