flasn4nt
/
grpc-java
mirror of https://github.com/grpc/grpc-java.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

api: Add more Javadoc for NameResolver.Listener2 interface (#12220)

This commit is contained in:
Kannan J 2025-07-16 09:09:43 +00:00 committed by GitHub
parent 5a8326f1c7
commit d352540a02
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 14 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
api/src/main/java/io/grpc/NameResolver.java
View File

@ -239,6 +239,9 @@ public abstract class NameResolver {
* {@link ResolutionResult#getAddressesOrError()} is empty, {@link #onError(Status)} will be * {@link ResolutionResult#getAddressesOrError()} is empty, {@link #onError(Status)} will be
* called. * called.
* *
* <p>Newer NameResolver implementations should prefer calling onResult2. This method exists to
* facilitate older {@link Listener} implementations to migrate to {@link Listener2}.
*
* @param resolutionResult the resolved server addresses, attributes, and Service Config. * @param resolutionResult the resolved server addresses, attributes, and Service Config.
* @since 1.21.0 * @since 1.21.0
*/ */
@ -248,6 +251,10 @@ public abstract class NameResolver {
* Handles a name resolving error from the resolver. The listener is responsible for eventually * Handles a name resolving error from the resolver. The listener is responsible for eventually
* invoking {@link NameResolver#refresh()} to re-attempt resolution. * invoking {@link NameResolver#refresh()} to re-attempt resolution.
* *
* <p>New NameResolver implementations should prefer calling onResult2 which will have the
* address resolution error in {@link ResolutionResult}'s addressesOrError. This method exists
* to facilitate older implementations using {@link Listener} to migrate to {@link Listener2}.
*
* @param error a non-OK status * @param error a non-OK status
* @since 1.21.0 * @since 1.21.0
*/ */
@ -255,9 +262,14 @@ public abstract class NameResolver {
public abstract void onError(Status error); public abstract void onError(Status error);
/** /**
* Handles updates on resolved addresses and attributes. * Handles updates on resolved addresses and attributes. Must be called from the same
* {@link SynchronizationContext} available in {@link NameResolver.Args} that is passed
* from the channel.
* *
* @param resolutionResult the resolved server addresses, attributes, and Service Config. * @param resolutionResult the resolved server addresses or error in address resolution,
* attributes, and Service Config or error
* @return status indicating whether the resolutionResult was accepted by the listener,
* typically the result from a load balancer.
* @since 1.66 * @since 1.66
*/ */
public Status onResult2(ResolutionResult resolutionResult) { public Status onResult2(ResolutionResult resolutionResult) {