io.grpc

Class NameResolver.Listener2

java.lang.Object

io.grpc.NameResolver.Listener2

All Implemented Interfaces:

NameResolver.Listener

Enclosing class:

NameResolver

@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/1770")
public abstract static class NameResolver.Listener2
extends Object
implements NameResolver.Listener

Receives address updates.

All methods are expected to return quickly.

This is a replacement API of Listener. However, we think this new API may change again, so we aren't yet encouraging mass-migration to it. It is fine to use and works.

Since:

1.21.0

Constructor Summary

Constructors

Constructor and Description
Listener2()

Method Summary

Modifier and Type	Method and Description
void	onAddresses(List<EquivalentAddressGroup> servers, Attributes attributes) Deprecated. This will be removed in 1.22.0
abstract void	onError(Status error) Handles a name resolving error from the resolver.
abstract void	onResult(NameResolver.ResolutionResult resolutionResult) Handles updates on resolved addresses and attributes.

Methods inherited from class java.lang.Object

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

Constructor Detail

Listener2

public Listener2()

Method Detail

onAddresses

@Deprecated
 @InlineMe(replacement="this.onResult(ResolutionResult.newBuilder().setAddresses(servers).setAttributes(attributes).build())",
          imports="io.grpc.NameResolver.ResolutionResult")
public final void onAddresses(List<EquivalentAddressGroup> servers,
                                                                                                                                                                                                                                    @NameResolver.ResolutionResultAttr
                                                                                                                                                                                                                                    Attributes attributes)

Deprecated. This will be removed in 1.22.0

Description copied from interface: NameResolver.Listener

Handles updates on resolved addresses and attributes.

Implementations will not modify the given servers.

Specified by:

onAddresses in interface NameResolver.Listener

Parameters:

servers - the resolved server addresses. An empty list will trigger NameResolver.Listener.onError(io.grpc.Status)

attributes - extra information from naming system.

onResult

public abstract void onResult(NameResolver.ResolutionResult resolutionResult)

Handles updates on resolved addresses and attributes. If NameResolver.ResolutionResult.getAddresses() is empty, onError(Status) will be called.

Parameters:

resolutionResult - the resolved server addresses, attributes, and Service Config.

Since:

1.21.0

onError

public abstract void onError(Status error)

Handles a name resolving error from the resolver. The listener is responsible for eventually invoking NameResolver.refresh() to re-attempt resolution.

Specified by:

onError in interface NameResolver.Listener

Parameters:

error - a non-OK status

Since:

1.21.0