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 and Description
Function<? super ClientOptionsBuilder,ClientOptionsBuilder>	clientConfigurator() Returns the Function that customizes a Client that sends health check requests.
ClientFactory	clientFactory() Returns the ClientFactory which is used for sending 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) Updates the health of the Endpoint being checked.

Method Detail

endpoint

Endpoint endpoint()

Returns the Endpoint to send health check requests to.

clientFactory

ClientFactory clientFactory()

Returns the ClientFactory which is used for sending health check requests.

protocol

SessionProtocol protocol()

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

clientConfigurator

Function<? super ClientOptionsBuilder,ClientOptionsBuilder> clientConfigurator()

Returns the Function that customizes a 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

void updateHealth(double health)

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.