Show / Hide Table of Contents

    Class ConsumersHealthCheckService

    Checks that all the consumers are connected.

    Inheritance
    object
    ConsumersHealthCheckService
    Implements
    IConsumersHealthCheckService
    Inherited Members
    object.GetType()
    object.MemberwiseClone()
    object.ToString()
    object.Equals(object)
    object.Equals(object, object)
    object.ReferenceEquals(object, object)
    object.GetHashCode()
    Namespace: Silverback.Messaging.HealthChecks
    Assembly: Silverback.Integration.dll
    Syntax
    public class ConsumersHealthCheckService : IConsumersHealthCheckService

    Constructors

    ConsumersHealthCheckService(IConsumerCollection, IHostApplicationLifetime)

    Initializes a new instance of the ConsumersHealthCheckService class.

    Declaration
    public ConsumersHealthCheckService(IConsumerCollection consumerCollection, IHostApplicationLifetime applicationLifetime)
    Parameters
    Type Name Description
    IConsumerCollection consumerCollection

    The collection holding a reference to all consumers.

    IHostApplicationLifetime applicationLifetime

    The IHostApplicationLifetime used to track the application shutdown.

    Methods

    GetDisconnectedConsumersAsync(ConsumerStatus, TimeSpan)

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

    Declaration
    public Task<IReadOnlyCollection<IConsumer>> GetDisconnectedConsumersAsync(ConsumerStatus minStatus, TimeSpan gracePeriod)
    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.

    Returns
    Type Description
    Task<IReadOnlyCollection<IConsumer>>

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

    Implements

    IConsumersHealthCheckService
    GitHub E-Mail
    ↑ Back to top © 2026 Sergio Aquilini