Show / Hide Table of Contents

    Class BatchSettings

    The batch consuming settings.

    Inheritance
    object
    BatchSettings
    Implements
    IValidatableSettings
    IEquatable<BatchSettings>
    Inherited Members
    object.GetType()
    object.Equals(object, object)
    object.ReferenceEquals(object, object)
    Namespace: Silverback.Messaging.Sequences.Batch
    Assembly: Silverback.Integration.dll
    Syntax
    public sealed record BatchSettings : IValidatableSettings, IEquatable<BatchSettings>

    Constructors

    BatchSettings()

    The batch consuming settings.

    Declaration
    public BatchSettings()

    Properties

    MaxWaitTime

    Gets the maximum amount of time to wait for the batch to be filled. After this time the batch will be completed even if the specified Size is not reached.

    Declaration
    public TimeSpan? MaxWaitTime { get; init; }
    Property Value
    Type Description
    TimeSpan?

    Size

    Gets the number of messages to be processed in batch. Setting this property to a value greater than 1 enables batch consuming.

    Declaration
    public int Size { get; init; }
    Property Value
    Type Description
    int

    Methods

    Equals(BatchSettings?)

    The batch consuming settings.

    Declaration
    public bool Equals(BatchSettings? other)
    Parameters
    Type Name Description
    BatchSettings other
    Returns
    Type Description
    bool

    Equals(object?)

    The batch consuming settings.

    Declaration
    public override bool Equals(object? obj)
    Parameters
    Type Name Description
    object obj
    Returns
    Type Description
    bool
    Overrides
    object.Equals(object)

    GetHashCode()

    The batch consuming settings.

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    int
    Overrides
    object.GetHashCode()

    ToString()

    The batch consuming settings.

    Declaration
    public override string ToString()
    Returns
    Type Description
    string
    Overrides
    object.ToString()

    Validate()

    Throws a SilverbackConfigurationException if the configuration is not valid.

    Declaration
    public void Validate()

    Operators

    operator ==(BatchSettings?, BatchSettings?)

    The batch consuming settings.

    Declaration
    public static bool operator ==(BatchSettings? left, BatchSettings? right)
    Parameters
    Type Name Description
    BatchSettings left
    BatchSettings right
    Returns
    Type Description
    bool

    operator !=(BatchSettings?, BatchSettings?)

    The batch consuming settings.

    Declaration
    public static bool operator !=(BatchSettings? left, BatchSettings? right)
    Parameters
    Type Name Description
    BatchSettings left
    BatchSettings right
    Returns
    Type Description
    bool

    Implements

    IValidatableSettings
    IEquatable<T>
    GitHub E-Mail
    ↑ Back to top © 2026 Sergio Aquilini