Package io.servicetalk.http.netty

Class H2KeepAlivePolicies

java.lang.Object

io.servicetalk.http.netty.H2KeepAlivePolicies

public final class H2KeepAlivePolicies
extends Object

A factory to create H2ProtocolConfig.KeepAlivePolicy instances.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	H2KeepAlivePolicies.KeepAlivePolicyBuilder	A builder of H2ProtocolConfig.KeepAlivePolicy.

Method Summary

Modifier and Type	Method	Description
static H2ProtocolConfig.KeepAlivePolicy	disabled()	Returns a H2ProtocolConfig.KeepAlivePolicy that disables all keep alive behaviors.
static H2ProtocolConfig.KeepAlivePolicy	whenIdleFor(Duration idleDuration)	Returns a H2ProtocolConfig.KeepAlivePolicy that sends a ping if the channel is idle for the passed idleDuration.
static H2ProtocolConfig.KeepAlivePolicy	whenIdleFor(Duration idleDuration, Duration ackTimeout)	Returns a H2ProtocolConfig.KeepAlivePolicy that sends a ping if the channel is idle for the passed idleDuration and waits for ackTimeout for an ack for that ping.

Methods inherited from class java.lang.Object

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

Method Details

disabled

public static H2ProtocolConfig.KeepAlivePolicy disabled()

Returns a H2ProtocolConfig.KeepAlivePolicy that disables all keep alive behaviors.

Returns:

A H2ProtocolConfig.KeepAlivePolicy that disables all keep alive behaviors.

whenIdleFor

public static H2ProtocolConfig.KeepAlivePolicy whenIdleFor(Duration idleDuration)

Returns a H2ProtocolConfig.KeepAlivePolicy that sends a ping if the channel is idle for the passed idleDuration. Default values are used for other parameters of the returned H2ProtocolConfig.KeepAlivePolicy.

Parameters:

idleDuration - Duration of idleness on a connection after which a ping is sent.

Returns:

A H2ProtocolConfig.KeepAlivePolicy that sends a ping if the channel is idle for the passed idleDuration.

See Also:

• H2ProtocolConfig.KeepAlivePolicy.idleDuration()

whenIdleFor

public static H2ProtocolConfig.KeepAlivePolicy whenIdleFor(Duration idleDuration,
 Duration ackTimeout)

Returns a H2ProtocolConfig.KeepAlivePolicy that sends a ping if the channel is idle for the passed idleDuration and waits for ackTimeout for an ack for that ping. Default values are used for other parameters of the returned H2ProtocolConfig.KeepAlivePolicy.

Parameters:

idleDuration - Duration of idleness on a connection after which a ping is sent. This value is recommended to be greater than or equal to ackTimeout.

ackTimeout - Duration to wait for an acknowledgment of a previously sent ping. This value is recommended to be less than or equal to idleDuration.

Returns:

A H2ProtocolConfig.KeepAlivePolicy that sends a ping if the channel is idle for the passed idleDuration and waits for ackTimeout for an ack for that ping

See Also:

• H2ProtocolConfig.KeepAlivePolicy.idleDuration()
• H2ProtocolConfig.KeepAlivePolicy.ackTimeout()