Module lettuce.core

Package io.lettuce.core

Class SocketOptions.KeepAliveOptions.Builder

java.lang.Object

io.lettuce.core.SocketOptions.KeepAliveOptions.Builder

Enclosing class:

SocketOptions.KeepAliveOptions

public static class SocketOptions.KeepAliveOptions.Builder
extends Object

Builder for SocketOptions.KeepAliveOptions.

Method Summary

Modifier and Type	Method	Description
SocketOptions.KeepAliveOptions	build()	Create a new instance of SocketOptions.KeepAliveOptions
SocketOptions.KeepAliveOptions.Builder	count(int count)	Set the the maximum number of keepalive probes TCP should send before dropping the connection.
SocketOptions.KeepAliveOptions.Builder	disable()	Disable TCP keepalive.
SocketOptions.KeepAliveOptions.Builder	enable()	Enable TCP keepalive.
SocketOptions.KeepAliveOptions.Builder	enable(boolean enabled)	Enable TCP keepalive.
SocketOptions.KeepAliveOptions.Builder	idle(Duration idle)	The time the connection needs to remain idle before TCP starts sending keepalive probes if keepalive is enabled.
SocketOptions.KeepAliveOptions.Builder	interval(Duration interval)	The time between individual keepalive probes.

Methods inherited from class java.lang.Object

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

Method Details

count

public SocketOptions.KeepAliveOptions.Builder count(int count)

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

Parameters:

count - the maximum number of keepalive probes TCP

Returns:

this

enable

public SocketOptions.KeepAliveOptions.Builder enable()

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

Returns:

this

See Also:

SocketOptions.SO_KEEPALIVE

disable

public SocketOptions.KeepAliveOptions.Builder disable()

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

Returns:

this

See Also:

SocketOptions.SO_KEEPALIVE

enable

public SocketOptions.KeepAliveOptions.Builder enable(boolean enabled)

Enable TCP keepalive. Defaults to false. See SocketOptions.DEFAULT_SO_KEEPALIVE.

Parameters:

enabled - whether to enable TCP keepalive.

Returns:

this

See Also:

SocketOptions.SO_KEEPALIVE

idle

public SocketOptions.KeepAliveOptions.Builder idle(Duration idle)

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 SocketOptions.KeepAliveOptions.DEFAULT_IDLE and TCP_KEEPIDLE.

The time granularity of is seconds.

Parameters:

idle - connection idle time, must be greater 0.

Returns:

this

interval

public SocketOptions.KeepAliveOptions.Builder interval(Duration interval)

The time between individual keepalive probes. Defaults to 75 second. See also SocketOptions.KeepAliveOptions.DEFAULT_INTERVAL and TCP_KEEPINTVL.

The time granularity of is seconds.

Parameters:

interval - connection interval time, must be greater 0

Returns:

this

build

public SocketOptions.KeepAliveOptions build()

Create a new instance of SocketOptions.KeepAliveOptions

Returns:

new instance of SocketOptions.KeepAliveOptions