com.google.api.gax.rpc

Class Watchdog

java.lang.Object

com.google.api.gax.rpc.Watchdog

All Implemented Interfaces:

Runnable

@InternalApi
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 ServerStream or if a connection is reset and GRPC does not get notified.

For every checkInterval, 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. Duration.ZERO disables the timeout.
• 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. Duration.ZERO disables the timeout.

Constructor Summary

Constructors

Constructor and Description
Watchdog(com.google.api.core.ApiClock clock)

Method Summary

Modifier and Type	Method and Description
void	run()
<ResponseT> ResponseObserver<ResponseT>	watch(ResponseObserver<ResponseT> innerObserver, org.threeten.bp.Duration waitTimeout, org.threeten.bp.Duration idleTimeout) Wraps the target observer with timing constraints.

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.core.ApiClock clock)

Method Detail

watch

public <ResponseT> ResponseObserver<ResponseT> watch(ResponseObserver<ResponseT> innerObserver,
                                                     @Nonnull
                                                     org.threeten.bp.Duration waitTimeout,
                                                     @Nonnull
                                                     org.threeten.bp.Duration idleTimeout)

Wraps the target observer with timing constraints.

run

public void run()

Specified by:

run in interface Runnable