com.google.cloud.bigtable.grpc.io

Class Watchdog

java.lang.Object

com.google.cloud.bigtable.grpc.io.Watchdog

All Implemented Interfaces:

Runnable

@InternalApi(value="For internal usage only")
public class Watchdog
extends Object
implements Runnable

Prevents the streams from hanging indefinitely. This middleware garbage collects idle streams in case the user forgot to close a ClientCall or if a connection is reset and GRPC does not get notified.

Periodically this class checks two thresholds:

• waitingTimeout: the amount of time to wait for a response (after the caller signaled demand) before forcefully closing the stream.
• idleTimeout: the amount of time to wait before assuming that the caller forgot to close the stream and forcefully closing the stream. This is measured from the last time the caller had no outstanding demand.

For internal use only - public for technical reasons.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Watchdog.State
static class	Watchdog.StreamWaitTimeoutException Marker exception to replace cancelled status with aborted to allow retries.

Constructor Summary

Constructors

Constructor and Description
Watchdog(com.google.api.client.util.Clock clock, long waitTimeoutMs)
Watchdog(com.google.api.client.util.Clock clock, long waitTimeoutMs, long idleTimeoutMs)

Method Summary

Modifier and Type	Method and Description
void	run()
void	start(ScheduledExecutorService executor)
void	stop()
<ReqT,RespT> io.grpc.ClientCall<ReqT,RespT>	watch(io.grpc.ClientCall<ReqT,RespT> innerCall)

Methods inherited from class java.lang.Object

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

Constructor Detail

Watchdog

public Watchdog(com.google.api.client.util.Clock clock,
                long waitTimeoutMs)

Watchdog

public Watchdog(com.google.api.client.util.Clock clock,
                long waitTimeoutMs,
                long idleTimeoutMs)

Method Detail

watch

public <ReqT,RespT> io.grpc.ClientCall<ReqT,RespT> watch(io.grpc.ClientCall<ReqT,RespT> innerCall)

run

public void run()

Specified by:

run in interface Runnable

start

public void start(ScheduledExecutorService executor)

stop

public void stop()