io.lettuce.core.resource

Class ExtendedKeepAliveSupport

java.lang.Object

io.lettuce.core.resource.ExtendedKeepAliveSupport

public class ExtendedKeepAliveSupport
extends Object

Utility class to determine if extended TCP keep-alive options are supported on the current platform and to apply them.

Extended keep-alive options (TCP_KEEPIDLE, TCP_KEEPINTVL, TCP_KEEPCNT) are supported on:

• Linux with io_uring transport
• Linux with epoll transport
• NIO transport with Java 11+ (except on macOS/kqueue)

macOS (kqueue) does not support per-socket extended keep-alive options.

Since:

7.5

Author:

Aleksandar Todorov

Method Summary

Modifier and Type	Method and Description
static boolean	applyKeepAlive(io.netty.bootstrap.Bootstrap bootstrap, int count, Duration idle, Duration interval) Apply extended keep-alive options to the bootstrap.
static boolean	isSupported() Returns whether extended TCP keep-alive options are supported on the current platform.

Methods inherited from class java.lang.Object

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

Method Detail

isSupported

public static boolean isSupported()

Returns whether extended TCP keep-alive options are supported on the current platform.

Returns:

true if extended keep-alive options can be applied, false otherwise

applyKeepAlive

public static boolean applyKeepAlive(io.netty.bootstrap.Bootstrap bootstrap,
                                     int count,
                                     Duration idle,
                                     Duration interval)

Apply extended keep-alive options to the bootstrap. This method delegates to the appropriate provider based on platform availability.

Parameters:

bootstrap - the Netty bootstrap to configure

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

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

interval - the time between individual keepalive probes

Returns:

true if the options were applied, false otherwise