org.apache.dubbo.rpc.protocol.tri.service

Class HealthStatusManager

java.lang.Object

org.apache.dubbo.rpc.protocol.tri.service.HealthStatusManager

public class HealthStatusManager
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_NAME_ALL_SERVICES The special "service name" that represent all services on a GRPC server.

Constructor Summary

Constructors

Constructor and Description
HealthStatusManager(TriHealthImpl healthService)

Method Summary

Modifier and Type	Method and Description
void	clearStatus(String service) Clears the health status record of a service.
void	enterTerminalState() enterTerminalState causes the health status manager to mark all services as not serving, and prevents future updates to services.
Health	getHealthService()
void	setStatus(String service, HealthCheckResponse.ServingStatus status) Updates the status of the server.

Methods inherited from class java.lang.Object

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

Field Detail

SERVICE_NAME_ALL_SERVICES

public static final String SERVICE_NAME_ALL_SERVICES

The special "service name" that represent all services on a GRPC server. It is an empty string.

See Also:

Constant Field Values

Constructor Detail

HealthStatusManager

public HealthStatusManager(TriHealthImpl healthService)

Method Detail

getHealthService

public Health getHealthService()

setStatus

public void setStatus(String service,
                      HealthCheckResponse.ServingStatus status)

Updates the status of the server.

Parameters:

service - the name of some aspect of the server that is associated with a health status. This name can have no relation with the gRPC services that the server is running with. It can also be an empty String "" per the gRPC specification.

status - is one of the values HealthCheckResponse.ServingStatus#SERVING, HealthCheckResponse.ServingStatus#NOT_SERVING and HealthCheckResponse.ServingStatus#UNKNOWN.

clearStatus

public void clearStatus(String service)

Clears the health status record of a service. The health service will respond with NOT_FOUND error on checking the status of a cleared service.

Parameters:

service - the name of some aspect of the server that is associated with a health status. This name can have no relation with the gRPC services that the server is running with. It can also be an empty String "" per the gRPC specification.

enterTerminalState

public void enterTerminalState()

enterTerminalState causes the health status manager to mark all services as not serving, and prevents future updates to services. This method is meant to be called prior to server shutdown as a way to indicate that clients should redirect their traffic elsewhere.