io.grpc.health.v1

Interface Health

All Known Implementing Classes:

DubboHealthTriple.HealthImplBase, DubboHealthTriple.HealthStub, TriHealthImpl

public interface Health

Field Summary

Fields

Modifier and Type	Field and Description
static String	JAVA_SERVICE_NAME
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method and Description
HealthCheckResponse	check(HealthCheckRequest request)
default void	check(HealthCheckRequest request, org.apache.dubbo.common.stream.StreamObserver<HealthCheckResponse> responseObserver) This server stream type unary method is only used for generated stub to support async unary method.
default CompletableFuture<HealthCheckResponse>	checkAsync(HealthCheckRequest request)
void	watch(HealthCheckRequest request, org.apache.dubbo.common.stream.StreamObserver<HealthCheckResponse> responseObserver) Performs a watch for the serving status of the requested service.

Field Detail

JAVA_SERVICE_NAME

static final String JAVA_SERVICE_NAME

See Also:

Constant Field Values

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

Method Detail

check

HealthCheckResponse check(HealthCheckRequest request)

checkAsync

default CompletableFuture<HealthCheckResponse> checkAsync(HealthCheckRequest request)

check

default void check(HealthCheckRequest request,
                   org.apache.dubbo.common.stream.StreamObserver<HealthCheckResponse> responseObserver)

This server stream type unary method is only used for generated stub to support async unary method. It will not be called if you are NOT using Dubbo3 generated triple stub and DO NOT implement this method.

watch

void watch(HealthCheckRequest request,
           org.apache.dubbo.common.stream.StreamObserver<HealthCheckResponse> responseObserver)

  Performs a watch for the serving status of the requested service.
  The server will immediately send back a message indicating the current
  serving status.  It will then subsequently send a new message whenever
  the service's serving status changes.
 
  If the requested service is unknown when the call is received, the
  server will send a message setting the serving status to
  SERVICE_UNKNOWN but will *not* terminate the call.  If at some
  future point, the serving status of the service becomes known, the
  server will send a new message with the service's serving status.
 
  If the call terminates with status UNIMPLEMENTED, then clients
  should assume this method is not supported and should not retry the
  call.  If the call terminates with any other status (including OK),
  clients should retry the call with appropriate exponential backoff.