Package io.grpc.internal

Class KeepAliveEnforcer

java.lang.Object

io.grpc.internal.KeepAliveEnforcer

public final class KeepAliveEnforcer
extends Object

Monitors the client's PING usage to make sure the rate is permitted.

Field Summary

Fields

Modifier and Type	Field	Description
static final long	IMPLICIT_PERMIT_TIME_NANOS
static final int	MAX_PING_STRIKES

Constructor Summary

Constructors

Constructor	Description
KeepAliveEnforcer(boolean permitWithoutCalls, long minTime, TimeUnit unit)

Method Summary

Modifier and Type	Method	Description
void	onTransportActive()	There are outstanding RPCs on the transport.
void	onTransportIdle()	There are no outstanding RPCs on the transport.
boolean	pingAcceptable()	Returns false when client is misbehaving and should be disconnected.
void	resetCounters()	Reset any counters because PINGs are allowed in response to something sent.

Methods inherited from class java.lang.Object

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

Field Details

MAX_PING_STRIKES

public static final int MAX_PING_STRIKES

See Also:

• Constant Field Values

IMPLICIT_PERMIT_TIME_NANOS

public static final long IMPLICIT_PERMIT_TIME_NANOS

Constructor Details

KeepAliveEnforcer

public KeepAliveEnforcer(boolean permitWithoutCalls,
 long minTime,
 TimeUnit unit)

Method Details

pingAcceptable

@CheckReturnValue
public boolean pingAcceptable()

Returns false when client is misbehaving and should be disconnected.

resetCounters

public void resetCounters()

Reset any counters because PINGs are allowed in response to something sent. Typically called when sending HEADERS and DATA frames.

onTransportActive

public void onTransportActive()

There are outstanding RPCs on the transport.

onTransportIdle

public void onTransportIdle()

There are no outstanding RPCs on the transport.