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

Class HealthCheckedEndpointGroup

java.lang.Object

com.linecorp.armeria.common.util.AbstractListenable<List<Endpoint>>

com.linecorp.armeria.client.endpoint.DynamicEndpointGroup

com.linecorp.armeria.client.endpoint.healthcheck.HealthCheckedEndpointGroup

All Implemented Interfaces:

EndpointGroup, Listenable<List<Endpoint>>, SafeCloseable, AutoCloseable

Direct Known Subclasses:

HttpHealthCheckedEndpointGroup

public abstract class HealthCheckedEndpointGroup
extends DynamicEndpointGroup

An EndpointGroup decorator that only provides healthy Endpoints.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	HealthCheckedEndpointGroup.EndpointHealthChecker	Returns whether an Endpoint is healthy or not.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	HealthCheckedEndpointGroup(ClientFactory clientFactory, EndpointGroup delegate, Backoff retryBackoff)	Creates a new instance.
protected	HealthCheckedEndpointGroup(ClientFactory clientFactory, EndpointGroup delegate, Duration retryInterval)	Deprecated. Use HealthCheckedEndpointGroup(ClientFactory, EndpointGroup, Backoff).

Method Summary

Modifier and Type	Method	Description
protected ClientFactory	clientFactory()	Returns the ClientFactory that will process HealthCheckedEndpointGroup.EndpointHealthChecker's healthcheck requests.
void	close()
protected abstract HealthCheckedEndpointGroup.EndpointHealthChecker	createEndpointHealthChecker(Endpoint endpoint)	Creates a new HealthCheckedEndpointGroup.EndpointHealthChecker instance that will check endpoint healthiness.
protected void	init()	Update healthy servers and start to schedule healthcheck.
MeterBinder	newMeterBinder(MeterIdPrefix idPrefix)	Returns a newly-created MeterBinder which binds the stats about this HealthCheckedEndpointGroup.
MeterBinder	newMeterBinder(String groupName)	Returns a newly-created MeterBinder which binds the stats about this HealthCheckedEndpointGroup with the default meter names.
String	toString()

Methods inherited from class com.linecorp.armeria.client.endpoint.DynamicEndpointGroup

addEndpoint, awaitInitialEndpoints, awaitInitialEndpoints, endpoints, initialEndpointsFuture, removeEndpoint, setEndpoints

Methods inherited from class com.linecorp.armeria.common.util.AbstractListenable

addListener, notifyListeners, removeListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.linecorp.armeria.client.endpoint.EndpointGroup

addListener, orElse, removeListener

Constructor Detail

HealthCheckedEndpointGroup

@Deprecated
protected HealthCheckedEndpointGroup(ClientFactory clientFactory,
                                     EndpointGroup delegate,
                                     Duration retryInterval)

Deprecated.

Use HealthCheckedEndpointGroup(ClientFactory, EndpointGroup, Backoff).

Creates a new instance. A subclass being initialized with this constructor must call init() before start being used.

HealthCheckedEndpointGroup

protected HealthCheckedEndpointGroup(ClientFactory clientFactory,
                                     EndpointGroup delegate,
                                     Backoff retryBackoff)

Creates a new instance. A subclass being initialized with this constructor must call init() before start being used.

Method Detail

init

protected void init()

Update healthy servers and start to schedule healthcheck. A subclass being initialized with this constructor must call init() before start being used.

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface EndpointGroup

Specified by:

close in interface SafeCloseable

Overrides:

close in class DynamicEndpointGroup

clientFactory

protected final ClientFactory clientFactory()

Returns the ClientFactory that will process HealthCheckedEndpointGroup.EndpointHealthChecker's healthcheck requests.

createEndpointHealthChecker

protected abstract HealthCheckedEndpointGroup.EndpointHealthChecker createEndpointHealthChecker(Endpoint endpoint)

Creates a new HealthCheckedEndpointGroup.EndpointHealthChecker instance that will check endpoint healthiness.

newMeterBinder

public MeterBinder newMeterBinder(String groupName)

Returns a newly-created MeterBinder which binds the stats about this HealthCheckedEndpointGroup with the default meter names.

newMeterBinder

public MeterBinder newMeterBinder(MeterIdPrefix idPrefix)

Returns a newly-created MeterBinder which binds the stats about this HealthCheckedEndpointGroup.

toString

public String toString()

Overrides:

toString in class Object