Package io.grpc.xds

Class XdsClient

java.lang.Object

io.grpc.xds.XdsClient

@ExperimentalApi("https://github.com/grpc/grpc-java/issues/10862")
public abstract class XdsClient
extends java.lang.Object

An XdsClient instance encapsulates all of the logic for communicating with the xDS server. It may create multiple RPC streams (or a single ADS stream) for a series of xDS protocols (e.g., LDS, RDS, VHDS, CDS and EDS) over a single channel. Watch-based interfaces are provided for each set of data needed by gRPC.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	XdsClient.ResourceUpdate
static interface	XdsClient.ResourceWatcher<T extends XdsClient.ResourceUpdate>	Watcher interface for a single requested xDS resource.

Constructor Summary

Constructors

Constructor	Description
XdsClient()

Method Summary

Modifier and Type	Method	Description
<T extends XdsClient.ResourceUpdate> void	cancelXdsResourceWatch(XdsResourceType<T> type, java.lang.String resourceName, XdsClient.ResourceWatcher<T> watcher)	Unregisters the given resource watcher.
<T extends XdsClient.ResourceUpdate> void	watchXdsResource(XdsResourceType<T> type, java.lang.String resourceName, XdsClient.ResourceWatcher<T> watcher)
<T extends XdsClient.ResourceUpdate> void	watchXdsResource(XdsResourceType<T> type, java.lang.String resourceName, XdsClient.ResourceWatcher<T> watcher, java.util.concurrent.Executor executor)	Registers a data watcher for the given Xds resource.

Methods inherited from class java.lang.Object

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

Constructor Detail

XdsClient

public XdsClient()

Method Detail

watchXdsResource

public <T extends XdsClient.ResourceUpdate> void watchXdsResource(XdsResourceType<T> type,
                                                                  java.lang.String resourceName,
                                                                  XdsClient.ResourceWatcher<T> watcher,
                                                                  java.util.concurrent.Executor executor)

Registers a data watcher for the given Xds resource.

watchXdsResource

public <T extends XdsClient.ResourceUpdate> void watchXdsResource(XdsResourceType<T> type,
                                                                  java.lang.String resourceName,
                                                                  XdsClient.ResourceWatcher<T> watcher)

cancelXdsResourceWatch

public <T extends XdsClient.ResourceUpdate> void cancelXdsResourceWatch(XdsResourceType<T> type,
                                                                        java.lang.String resourceName,
                                                                        XdsClient.ResourceWatcher<T> watcher)

Unregisters the given resource watcher.