Package com.linecorp.armeria.client.endpoint.healthcheck

Interface HealthCheckerContext

public interface HealthCheckerContext

Provides the properties and operations required for sending health check requests.

Method Summary

Modifier and Type	Method	Description
ClientOptions	clientOptions()	Returns the ClientOptions of the Client that sends health check requests.
Endpoint	endpoint()	Returns the Endpoint to send health check requests to.
ScheduledExecutorService	executor()	Returns the ScheduledExecutorService which is used for scheduling the tasks related with sending health check requests.
long	nextDelayMillis()	Returns the delay for the next health check request in milliseconds.
SessionProtocol	protocol()	Returns the SessionProtocol to be used when sending health check requests.
void	updateHealth(double health)	Deprecated. Use updateHealth(double, ClientRequestContext, ResponseHeaders, Throwable).
default void	updateHealth(double health, ClientRequestContext ctx, @Nullable ResponseHeaders headers, @Nullable Throwable cause)	Updates the health of the Endpoint being checked.

Method Details

endpoint

Endpoint endpoint()

Returns the Endpoint to send health check requests to.

protocol

SessionProtocol protocol()

Returns the SessionProtocol to be used when sending health check requests.

clientOptions

ClientOptions clientOptions()

Returns the ClientOptions of the Client that sends health check requests.

executor

ScheduledExecutorService executor()

Returns the ScheduledExecutorService which is used for scheduling the tasks related with sending health check requests. Note that the ScheduledExecutorService returned by this method cannot be shut down; calling ExecutorService.shutdown() or ExecutorService.shutdownNow() will trigger an UnsupportedOperationException.

nextDelayMillis

long nextDelayMillis()

Returns the delay for the next health check request in milliseconds.

updateHealth

@Deprecated
void updateHealth(double health)

Deprecated.

Use updateHealth(double, ClientRequestContext, ResponseHeaders, Throwable).

Updates the health of the Endpoint being checked.

Parameters:

health - 0.0 indicates the Endpoint is not able to handle any requests. A positive value indicates the Endpoint is able to handle requests. A value greater than 1.0 will be set equal to 1.0.

updateHealth

default void updateHealth(double health,
 ClientRequestContext ctx,
 @Nullable
 @Nullable ResponseHeaders headers,
 @Nullable
 @Nullable Throwable cause)

Updates the health of the Endpoint being checked.

Parameters:

health - 0.0 indicates the Endpoint is not able to handle any requests. A positive value indicates the Endpoint is able to handle requests. A value greater than 1.0 will be set equal to 1.0.

ctx - the ClientRequestContext of the health check request.

headers - the ResponseHeaders of the health check request. null if the request is failed with the cause.

cause - the cause of the failed health check request. null if the health checked request received the headers.