Package com.linecorp.armeria.server.grpc

Class GrpcHealthCheckService

java.lang.Object

io.grpc.health.v1.HealthGrpc.HealthImplBase

com.linecorp.armeria.server.grpc.GrpcHealthCheckService

All Implemented Interfaces:

io.grpc.BindableService, io.grpc.health.v1.HealthGrpc.AsyncService

@UnstableApi
public final class GrpcHealthCheckService
extends io.grpc.health.v1.HealthGrpc.HealthImplBase

An implementation of HealthImplBase that determines the healthiness of a Server and the healthiness of each gRPC service.

This class is implemented based on gRPC Health Checking Protocol. If a service name is specified in the health check request, the service health updated by gRPC Service HealthCheckers is returned. If an empty service name is specified, the server health is returned. Note: The suggested format of service name is package_names.ServiceName If a server is healthy, returns ServingStatus.SERVING is returned. For more details, please refer to the following URL.

See Also:

• GRPC Health Checking Protocol
• GrpcHealthCheckServiceBuilder

Method Summary

Modifier and Type	Method	Description
static GrpcHealthCheckServiceBuilder	builder()	Returns a new builder which builds a new GrpcHealthCheckService.
void	check(io.grpc.health.v1.HealthCheckRequest request, io.grpc.stub.StreamObserver<io.grpc.health.v1.HealthCheckResponse> responseObserver)
static GrpcHealthCheckService	of(ListenableHealthChecker... healthCheckers)	Returns a newly created GrpcHealthCheckService with the specified ListenableHealthCheckers.
static GrpcHealthCheckService	of(Iterable<? extends ListenableHealthChecker> healthCheckers)	Returns a newly created GrpcHealthCheckService with the specified ListenableHealthCheckers.
void	watch(io.grpc.health.v1.HealthCheckRequest request, io.grpc.stub.StreamObserver<io.grpc.health.v1.HealthCheckResponse> responseObserver)

Methods inherited from class io.grpc.health.v1.HealthGrpc.HealthImplBase

bindService

Methods inherited from class java.lang.Object

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

Method Details

of

public static GrpcHealthCheckService of(ListenableHealthChecker... healthCheckers)

Returns a newly created GrpcHealthCheckService with the specified ListenableHealthCheckers.

of

public static GrpcHealthCheckService of(Iterable<? extends ListenableHealthChecker> healthCheckers)

Returns a newly created GrpcHealthCheckService with the specified ListenableHealthCheckers.

builder

public static GrpcHealthCheckServiceBuilder builder()

Returns a new builder which builds a new GrpcHealthCheckService.

check

public void check(io.grpc.health.v1.HealthCheckRequest request,
 io.grpc.stub.StreamObserver<io.grpc.health.v1.HealthCheckResponse> responseObserver)

watch

public void watch(io.grpc.health.v1.HealthCheckRequest request,
 io.grpc.stub.StreamObserver<io.grpc.health.v1.HealthCheckResponse> responseObserver)