Interface IDestinationHealthUpdater

Updates destinations' health states when it's requested by a health check policy while taking into account not only the new evaluated value but also the overall current cluster's health state.

Namespace: Yarp.ReverseProxy.Health
Assembly: Yarp.ReverseProxy.dll
Syntax
public interface IDestinationHealthUpdater

Methods

| Improve this Doc View Source

SetActive(ClusterState, IEnumerable<NewActiveDestinationHealth>)

Sets the active health values on the given destinations.

Declaration
void SetActive(ClusterState cluster, IEnumerable<NewActiveDestinationHealth> newHealthStates)
Parameters
Type Name Description
ClusterState cluster

Cluster.
IEnumerable<NewActiveDestinationHealth> newHealthStates

New active health states.
| Improve this Doc View Source

SetPassive(ClusterState, DestinationState, DestinationHealth, TimeSpan)

Sets the passive health on the given destination.

Declaration
void SetPassive(ClusterState cluster, DestinationState destination, DestinationHealth newHealth, TimeSpan reactivationPeriod)
Parameters
Type Name Description
ClusterState cluster

Cluster.
DestinationState destination

Destination.
DestinationHealth newHealth

New passive health value.
TimeSpan reactivationPeriod

If newHealth is Unhealthy, this parameter specifies a reactivation period after which the destination's Passive value will be reset to Unknown. Otherwise, it's not used.