SocketOptions.TcpUserTimeoutOptions (Lettuce 6.3.3.BUILD-SNAPSHOT API)

java.lang.Object
- io.lettuce.core.SocketOptions.TcpUserTimeoutOptions

Enclosing class:

SocketOptions
```
public static class SocketOptions.TcpUserTimeoutOptions
extends Object
```
TCP_USER_TIMEOUT comes from RFC5482 , configuring this parameter can allow the user TCP to initiate a reconnection to solve this problem when the network is abnormal.
The timeout is currently only supported with epoll and io_uring native transports.

Since:

6.2.7

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class SocketOptions.TcpUserTimeoutOptions.Builder
Builder class for SocketOptions.TcpUserTimeoutOptions.

Field Summary

Fields
Modifier and Type Field Description

static Duration DEFAULT_TCP_USER_TIMEOUT
Recommended default TCP_KEEPIDLE(2 hour) + TCP_KEEPINTVL(75 s) * TCP_KEEPCNT(9) 2 * 3600 + 75 * 9 = 7875

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static SocketOptions.TcpUserTimeoutOptions.Builder`	`builder()`	Returns a new `SocketOptions.TcpUserTimeoutOptions.Builder` to construct `SocketOptions.TcpUserTimeoutOptions`.
`Duration`	`getTcpUserTimeout()`	Returns the actual timeout.
`boolean`	`isEnabled()`	Returns whether to enable TCP User Timeout.
`SocketOptions.TcpUserTimeoutOptions.Builder`	`mutate()`	Returns a builder to create new `SocketOptions.TcpUserTimeoutOptions` whose settings are replicated from the current `SocketOptions.TcpUserTimeoutOptions`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_TCP_USER_TIMEOUT
```
public static final Duration DEFAULT_TCP_USER_TIMEOUT
```
    Recommended default TCP_KEEPIDLE(2 hour) + TCP_KEEPINTVL(75 s) * TCP_KEEPCNT(9) 2 * 3600 + 75 * 9 = 7875
- Method Detail
  - builder
```
public static SocketOptions.TcpUserTimeoutOptions.Builder builder()
```
    Returns a new SocketOptions.TcpUserTimeoutOptions.Builder to construct SocketOptions.TcpUserTimeoutOptions.
    
    Returns:
    
    a new SocketOptions.TcpUserTimeoutOptions.Builder to construct SocketOptions.TcpUserTimeoutOptions.
  - mutate
```
public SocketOptions.TcpUserTimeoutOptions.Builder mutate()
```
    Returns a builder to create new SocketOptions.TcpUserTimeoutOptions whose settings are replicated from the current SocketOptions.TcpUserTimeoutOptions.
    
    Returns:
    
    a SocketOptions.TcpUserTimeoutOptions.Builder to create new SocketOptions.TcpUserTimeoutOptions whose settings are replicated from the current SocketOptions.TcpUserTimeoutOptions
  - isEnabled
```
public boolean isEnabled()
```
    Returns whether to enable TCP User Timeout.
    
    Returns:
    
    whether to enable TCP User Timeout
  - getTcpUserTimeout
```
public Duration getTcpUserTimeout()
```
    Returns the actual timeout.
    
    Returns:
    
    the actual timeout.