io.envoyproxy.controlplane.cache

Class Watch

java.lang.Object

io.envoyproxy.controlplane.cache.Watch

public class Watch
extends Object

Watch is a dedicated stream of configuration resources produced by the configuration cache and consumed by the xDS server.

Constructor Summary

Constructors

Constructor and Description
Watch(boolean ads, Discovery.DiscoveryRequest request, Consumer<Response> responseConsumer) Construct a watch.

Method Summary

Modifier and Type	Method and Description
boolean	ads() Returns boolean indicating whether or not the watch is for an ADS request.
void	cancel() Cancel the watch.
boolean	isCancelled() Returns boolean indicating whether or not the watch has been cancelled.
Discovery.DiscoveryRequest	request() Returns the original request for the watch.
void	respond(Response response) Sends the given response to the watch's response handler.
void	setStop(Runnable stop) Sets the callback method to be executed when the watch is cancelled.

Methods inherited from class java.lang.Object

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

Constructor Detail

Watch

public Watch(boolean ads,
             Discovery.DiscoveryRequest request,
             Consumer<Response> responseConsumer)

Construct a watch.

Parameters:

ads - is this watch for an ADS request?

request - the original request for the watch

responseConsumer - handler for outgoing response messages

Method Detail

ads

public boolean ads()

Returns boolean indicating whether or not the watch is for an ADS request.

cancel

public void cancel()

Cancel the watch. A watch must be cancelled in order to complete its resource stream and free resources. Cancel may be called multiple times, with each subsequent call being a no-op.

isCancelled

public boolean isCancelled()

Returns boolean indicating whether or not the watch has been cancelled.

request

public Discovery.DiscoveryRequest request()

Returns the original request for the watch.

respond

public void respond(Response response)
             throws WatchCancelledException

Sends the given response to the watch's response handler.

Parameters:

response - the response to be handled

Throws:

WatchCancelledException - if the watch has already been cancelled

setStop

public void setStop(Runnable stop)

Sets the callback method to be executed when the watch is cancelled. Even if cancel is executed multiple times, it ensures that this stop callback is only executed once.