Package io.grpc.internal

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
private static enum	KeepAliveManager.State

Field Summary

Fields

Modifier and Type	Field	Description
private final boolean	keepAliveDuringTransportIdle
private final KeepAliveManager.KeepAlivePinger	keepAlivePinger
private final long	keepAliveTimeInNanos
private final long	keepAliveTimeoutInNanos
private static final long	MIN_KEEPALIVE_TIME_NANOS
private static final long	MIN_KEEPALIVE_TIMEOUT_NANOS
private ScheduledFuture<?>	pingFuture
private final ScheduledExecutorService	scheduler
private final Runnable	sendPing
private final Runnable	shutdown
private ScheduledFuture<?>	shutdownFuture
private KeepAliveManager.State	state
private final com.google.common.base.Stopwatch	stopwatch

Constructor Summary

Constructors

Constructor	Description
KeepAliveManager(KeepAliveManager.KeepAlivePinger keepAlivePinger, ScheduledExecutorService scheduler, long keepAliveTimeInNanos, long keepAliveTimeoutInNanos, boolean keepAliveDuringTransportIdle)	Creates a KeepAliverManager.
KeepAliveManager(KeepAliveManager.KeepAlivePinger keepAlivePinger, ScheduledExecutorService scheduler, com.google.common.base.Stopwatch stopwatch, long keepAliveTimeInNanos, long keepAliveTimeoutInNanos, boolean keepAliveDuringTransportIdle)

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 java.lang.Object

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

Field Details

MIN_KEEPALIVE_TIME_NANOS

private static final long MIN_KEEPALIVE_TIME_NANOS

MIN_KEEPALIVE_TIMEOUT_NANOS

private static final long MIN_KEEPALIVE_TIMEOUT_NANOS

scheduler

private final ScheduledExecutorService scheduler

stopwatch

private final com.google.common.base.Stopwatch stopwatch

keepAlivePinger

private final KeepAliveManager.KeepAlivePinger keepAlivePinger

keepAliveDuringTransportIdle

private final boolean keepAliveDuringTransportIdle

state

private KeepAliveManager.State state

shutdownFuture

private ScheduledFuture<?> shutdownFuture

pingFuture

private ScheduledFuture<?> pingFuture

shutdown

private final Runnable shutdown

sendPing

private final Runnable sendPing

keepAliveTimeInNanos

private final long keepAliveTimeInNanos

keepAliveTimeoutInNanos

private final long keepAliveTimeoutInNanos

Constructor Details

KeepAliveManager

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

Creates a KeepAliverManager.

KeepAliveManager

KeepAliveManager(KeepAliveManager.KeepAlivePinger keepAlivePinger,
 ScheduledExecutorService scheduler,
 com.google.common.base.Stopwatch stopwatch,
 long keepAliveTimeInNanos,
 long keepAliveTimeoutInNanos,
 boolean keepAliveDuringTransportIdle)

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.