Show / Hide Table of Contents

    Interface IOutboxHealthCheckService

    Checks that the outbox is being processed at a sustainable pace.

    Namespace: Silverback.Messaging.HealthChecks
    Assembly: Silverback.Integration.dll
    Syntax
    public interface IOutboxHealthCheckService

    Methods

    CheckIsHealthyAsync(TimeSpan, int?)

    Checks the age of the messages stored in the transactional outbox and optionally the queue length.

    Declaration
    Task<bool> CheckIsHealthyAsync(TimeSpan maxAge, int? maxQueueLength = null)
    Parameters
    Type Name Description
    TimeSpan maxAge

    The maximum message age, the check will fail when a message exceeds this age.

    int? maxQueueLength

    The maximum amount of messages in the queue. The default is null, meaning unrestricted.

    Returns
    Type Description
    Task<bool>

    A Task<TResult> representing the asynchronous operation. The task result contains a boolean value indicating whether the check is successful.

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