Package com.linecorp.armeria.xds

Class ListenerRoot

java.lang.Object

com.linecorp.armeria.xds.ListenerRoot

All Implemented Interfaces:

SafeCloseable, SnapshotWatcher<ListenerSnapshot>, AutoCloseable

@UnstableApi
public final class ListenerRoot
extends Object

A root node representing a Listener. Users may query the latest value of this resource or add a watcher to be notified of changes. Note that it is important to close this resource to avoid leaking connections to the control plane server.

Method Summary

Modifier and Type	Method	Description
void	addSnapshotWatcher(SnapshotWatcher<? super ListenerSnapshot> watcher)	Adds a watcher which waits for a snapshot update.
void	close()
void	onError(XdsType type, io.grpc.Status status)	Invoked when an unexpected error occurs while processing a resource.
void	onMissing(XdsType type, String resourceName)	Invoked when a resource is deemed not to exist.
void	removeSnapshotWatcher(SnapshotWatcher<? super ListenerSnapshot> watcher)	Removes a watcher which waits for a snapshot update.
void	snapshotUpdated(ListenerSnapshot newSnapshot)	Invoked when a full snapshot is updated.

Methods inherited from class java.lang.Object

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

Method Details

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface SafeCloseable

addSnapshotWatcher

public void addSnapshotWatcher(SnapshotWatcher<? super ListenerSnapshot> watcher)

Adds a watcher which waits for a snapshot update.

removeSnapshotWatcher

public void removeSnapshotWatcher(SnapshotWatcher<? super ListenerSnapshot> watcher)

Removes a watcher which waits for a snapshot update.

snapshotUpdated

public void snapshotUpdated(ListenerSnapshot newSnapshot)

Description copied from interface: SnapshotWatcher

Invoked when a full snapshot is updated.

Specified by:

snapshotUpdated in interface SnapshotWatcher<T extends Snapshot<? extends XdsResource>>

onMissing

public void onMissing(XdsType type,
 String resourceName)

Description copied from interface: SnapshotWatcher

Invoked when a resource is deemed not to exist. This can either be due to a timeout on a watch, or the xDS control plane explicitly signalling a resource is missing.

Specified by:

onMissing in interface SnapshotWatcher<T extends Snapshot<? extends XdsResource>>

onError

public void onError(XdsType type,
 io.grpc.Status status)

Description copied from interface: SnapshotWatcher

Invoked when an unexpected error occurs while processing a resource.

Specified by:

onError in interface SnapshotWatcher<T extends Snapshot<? extends XdsResource>>