Class KeepAliveManager

java.lang.Object

io.grpc.internal.KeepAliveManager

public class KeepAliveManager
extends Object

Manages keepalive pings.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	KeepAliveManager.ClientKeepAlivePinger	Default client side KeepAliveManager.KeepAlivePinger.
static interface	KeepAliveManager.KeepAlivePinger

Constructor Summary

Constructors

Constructor	Description
KeepAliveManager(KeepAliveManager.KeepAlivePinger keepAlivePinger, ScheduledExecutorService scheduler, long keepAliveTimeInNanos, long keepAliveTimeoutInNanos, boolean keepAliveDuringTransportIdle)	Creates a KeepAliverManager.

Method Summary

Modifier and Type	Method	Description
static long	clampKeepAliveTimeInNanos(long keepAliveTimeInNanos)	Bumps keepalive time to 10 seconds if the specified value was smaller than that.
static long	clampKeepAliveTimeoutInNanos(long keepAliveTimeoutInNanos)	Bumps keepalive timeout to 10 milliseconds if the specified value was smaller than that.
void	onDataReceived()	Transport has received some data so that we can delay sending keepalives.
void	onTransportActive()	Transport has active streams.
void	onTransportIdle()	Transport has finished all streams.
void	onTransportStarted()	Start keepalive monitoring.
void	onTransportTermination()	Transport is being terminated.

Methods inherited from class Object

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

Constructor Details

KeepAliveManager

public KeepAliveManager(KeepAliveManager.KeepAlivePinger keepAlivePinger,
 ScheduledExecutorService scheduler,
 long keepAliveTimeInNanos,
 long keepAliveTimeoutInNanos,
 boolean keepAliveDuringTransportIdle)

Creates a KeepAliverManager.

Method Details

onTransportStarted

public void onTransportStarted()

Start keepalive monitoring.

onDataReceived

public void onDataReceived()

Transport has received some data so that we can delay sending keepalives.

onTransportActive

public void onTransportActive()

Transport has active streams. Start sending keepalives if necessary.

onTransportIdle

public void onTransportIdle()

Transport has finished all streams.

onTransportTermination

public void onTransportTermination()

Transport is being terminated. We no longer need to do keepalives.

clampKeepAliveTimeInNanos

public static long clampKeepAliveTimeInNanos(long keepAliveTimeInNanos)

Bumps keepalive time to 10 seconds if the specified value was smaller than that.

clampKeepAliveTimeoutInNanos

public static long clampKeepAliveTimeoutInNanos(long keepAliveTimeoutInNanos)

Bumps keepalive timeout to 10 milliseconds if the specified value was smaller than that.