Interface IConsumersHealthCheckService

Checks that all the consumers are connected.

Namespace: Silverback.Messaging.HealthChecks

Assembly: Silverback.Integration.dll

Syntax

public interface IConsumersHealthCheckService

Methods

GetDisconnectedConsumersAsync(ConsumerStatus, TimeSpan, Func<IConsumerEndpoint, bool>?)

Checks the status of all the consumers and returns a collection containing the consumer instances that don't appear to be fully connected (Status >= Ready).

Declaration

Task<IReadOnlyCollection<IConsumer>> GetDisconnectedConsumersAsync(ConsumerStatus minStatus, TimeSpan gracePeriod, Func<IConsumerEndpoint, bool>? endpointsFilter)

Parameters

Type	Name	Description
ConsumerStatus	minStatus	The minimum ConsumerStatus a consumer must have to be considered fully connected.
TimeSpan	gracePeriod	The grace period to observe after each status change before a consumer is considered unhealthy.
Func<IConsumerEndpoint, bool>	endpointsFilter	An optional filter to be applied to the endpoints to be tested.

Returns

Type	Description
Task<IReadOnlyCollection<IConsumer>>	A Task<TResult> representing the asynchronous operation. The task result contains the consumers that aren't fully connected.