Show / Hide Table of Contents

    Interface IOutboxWorker

    Processes the outbox and produces the messages to the target message broker endpoint.

    Namespace: Silverback.Messaging.Producing.TransactionalOutbox
    Assembly: Silverback.Integration.dll
    Syntax
    public interface IOutboxWorker

    Methods

    GetLengthAsync()

    Returns the total number of messages in the outbox.

    Declaration
    Task<int> GetLengthAsync()
    Returns
    Type Description
    Task<int>

    A Task<TResult> representing the asynchronous operation. The task result contains the number of messages in the outbox.

    ProcessOutboxAsync(CancellationToken)

    Processes the outbox relaying the stored messages.

    Declaration
    Task<bool> ProcessOutboxAsync(CancellationToken stoppingToken)
    Parameters
    Type Name Description
    CancellationToken stoppingToken

    A CancellationToken to observe while waiting for the task to complete.

    Returns
    Type Description
    Task<bool>

    A Task<TResult> representing the asynchronous operation. The task result contains a value indicating whether the outbox contained at least 1 message, and it was successfully processed. The caller should ideally keep invoking this method in a loop, until false is returned.

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