Show / Hide Table of Contents

    Interface IConsumerTransactionManager

    Handles the consumer transaction.

    Namespace: Silverback.Messaging.Consuming.Transaction
    Assembly: Silverback.Integration.dll
    Syntax
    public interface IConsumerTransactionManager

    Properties

    Aborted

    Gets the AsyncEvent<TArg> that is after the consumer is aborted.

    Declaration
    AsyncEvent<ConsumerPipelineContext> Aborted { get; }
    Property Value
    Type Description
    AsyncEvent<ConsumerPipelineContext>

    Aborting

    Gets the AsyncEvent<TArg> that is before the consumer is aborted.

    Declaration
    AsyncEvent<ConsumerPipelineContext> Aborting { get; }
    Property Value
    Type Description
    AsyncEvent<ConsumerPipelineContext>

    Committed

    Gets the AsyncEvent<TArg> that is after the consumer is committed.

    Declaration
    AsyncEvent<ConsumerPipelineContext> Committed { get; }
    Property Value
    Type Description
    AsyncEvent<ConsumerPipelineContext>

    Committing

    Gets the AsyncEvent<TArg> that is fired before the consumer is committed.

    Declaration
    AsyncEvent<ConsumerPipelineContext> Committing { get; }
    Property Value
    Type Description
    AsyncEvent<ConsumerPipelineContext>

    Methods

    CommitAsync()

    Commits the transaction.

    Declaration
    Task CommitAsync()
    Returns
    Type Description
    Task

    A Task representing the asynchronous operation.

    RollbackAsync(Exception?, bool, bool, bool)

    Aborts the transaction and causes the uncommitted changes to be rolled back.

    Declaration
    Task<bool> RollbackAsync(Exception? exception, bool commitConsumer = false, bool throwIfAlreadyCommitted = true, bool stopConsuming = true)
    Parameters
    Type Name Description
    Exception exception

    The exception that caused the rollback.

    bool commitConsumer

    A value indicating whether the consumer have to be committed anyway. This depends on the error policy being applied.

    bool throwIfAlreadyCommitted

    A value indicating whether an exception must be thrown if the transaction was already committed.

    bool stopConsuming

    A value indicating whether the consumer must be stopped.

    Returns
    Type Description
    Task<bool>

    A Task<TResult> representing the asynchronous operation. The task result contains a value indicating whether the rollback was performed.

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