io.lettuce.core

Class SocketOptions.KeepAliveOptions

java.lang.Object

io.lettuce.core.SocketOptions.KeepAliveOptions

Enclosing class:

SocketOptions

public static class SocketOptions.KeepAliveOptions
extends Object

Extended Keep-Alive options (idle, interval, count). Extended options should not be used in code intended to be portable as options are applied only when using NIO sockets with Java 11 or newer epoll sockets, or io_uring sockets. Not applicable for kqueue in general or NIO sockets using Java 10 or earlier.

The time granularity of getIdle() and getInterval() is seconds.

Since:

6.1

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SocketOptions.KeepAliveOptions.Builder Builder for SocketOptions.KeepAliveOptions.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_COUNT
static Duration	DEFAULT_IDLE
static Duration	DEFAULT_INTERVAL

Method Summary

Modifier and Type	Method and Description
static SocketOptions.KeepAliveOptions.Builder	builder() Returns a new SocketOptions.KeepAliveOptions.Builder to construct SocketOptions.KeepAliveOptions.
int	getCount() Returns the maximum number of keepalive probes TCP should send before dropping the connection.
Duration	getIdle() The time the connection needs to remain idle before TCP starts sending keepalive probes if keepalive is enabled.
Duration	getInterval() The time between individual keepalive probes.
boolean	isEnabled() Returns whether to enable TCP keepalive.
SocketOptions.KeepAliveOptions.Builder	mutate() Returns a builder to create new SocketOptions.KeepAliveOptions whose settings are replicated from the current SocketOptions.KeepAliveOptions.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_COUNT

public static final int DEFAULT_COUNT

See Also:

Constant Field Values

DEFAULT_IDLE

public static final Duration DEFAULT_IDLE

DEFAULT_INTERVAL

public static final Duration DEFAULT_INTERVAL

Method Detail

builder

public static SocketOptions.KeepAliveOptions.Builder builder()

Returns a new SocketOptions.KeepAliveOptions.Builder to construct SocketOptions.KeepAliveOptions.

Returns:

a new SocketOptions.KeepAliveOptions.Builder to construct SocketOptions.KeepAliveOptions.

mutate

public SocketOptions.KeepAliveOptions.Builder mutate()

Returns a builder to create new SocketOptions.KeepAliveOptions whose settings are replicated from the current SocketOptions.KeepAliveOptions.

Returns:

a SocketOptions.KeepAliveOptions.Builder to create new SocketOptions.KeepAliveOptions whose settings are replicated from the current SocketOptions.KeepAliveOptions

getCount

public int getCount()

Returns the maximum number of keepalive probes TCP should send before dropping the connection. Defaults to 9. See also DEFAULT_COUNT and TCP_KEEPCNT.

Returns:

the maximum number of keepalive probes TCP should send before dropping the connection.

isEnabled

public boolean isEnabled()

Returns whether to enable TCP keepalive.

Returns:

whether to enable TCP keepalive

See Also:

SocketOptions.SO_KEEPALIVE

getIdle

public Duration getIdle()

The time the connection needs to remain idle before TCP starts sending keepalive probes if keepalive is enabled. Defaults to 2 hours. See also @link DEFAULT_IDLE and TCP_KEEPIDLE.

The time granularity of is seconds.

Returns:

the time the connection needs to remain idle before TCP starts sending keepalive probes.

getInterval

public Duration getInterval()

The time between individual keepalive probes. Defaults to 1 second. See also DEFAULT_INTERVAL and TCP_KEEPINTVL.

The time granularity of is seconds.

Returns:

the time the connection needs to remain idle before TCP starts sending keepalive probes.