Class GatewayCircuitBreakerHealthCheck

Namespace

Virtufin.Api.HealthChecks

Assembly

Virtufin.Api.dll

Health check that reports the gateway circuit breaker's state.

public sealed class GatewayCircuitBreakerHealthCheck : IHealthCheck

Inheritance

object

GatewayCircuitBreakerHealthCheck

Implements

IHealthCheck

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

GatewayCircuitBreakerHealthCheck(GatewayResiliencePipeline)

public GatewayCircuitBreakerHealthCheck(GatewayResiliencePipeline resilience)

Parameters

resilience GatewayResiliencePipeline

Methods

CheckHealthAsync(HealthCheckContext, CancellationToken)

Runs the health check, returning the status of the component being checked.

public Task<HealthCheckResult> CheckHealthAsync(HealthCheckContext context, CancellationToken cancellationToken = default)

Parameters

context HealthCheckContext

A context object associated with the current execution.

cancellationToken CancellationToken

A CancellationToken that can be used to cancel the health check.

Returns

Task<HealthCheckResult>

A Task<TResult> that completes when the health check has finished, yielding the status of the component being checked.