Class ChunkSettings

Namespace

Silverback.Messaging.Sequences.Chunking

Assembly

Silverback.Integration.dll

The chunking settings. To enable chunking just set the Size property to the desired (maximum) chunk size.

public sealed record ChunkSettings : IValidatableSettings, IEquatable<ChunkSettings>

Inheritance

object

ChunkSettings

Implements

IValidatableSettings

IEquatable<ChunkSettings>

Inherited Members

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

ChunkSettings()

public ChunkSettings()

Properties

AlwaysAddHeaders

Gets a value indicating whether the x-chunk-index and related headers have to be added to the produced message in any case, even if its size doesn't exceed the single chunk size. The default is true. This setting is ignored if chunking is disabled (Size is not set).

public bool AlwaysAddHeaders { get; init; }

Property Value

bool

Size

Gets the size in bytes of each chunk. The default is MaxValue, meaning that chunking is disabled.

public int Size { get; init; }

Property Value

int

Methods

Equals(ChunkSettings?)

public bool Equals(ChunkSettings? other)

Parameters

other ChunkSettings

Returns

bool

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

ToString()

public override string ToString()

Returns

string

Validate()

Throws a SilverbackConfigurationException if the configuration is not valid.

public void Validate()

Operators

operator ==(ChunkSettings?, ChunkSettings?)

public static bool operator ==(ChunkSettings? left, ChunkSettings? right)

Parameters

left ChunkSettings

right ChunkSettings

Returns

bool

operator !=(ChunkSettings?, ChunkSettings?)

public static bool operator !=(ChunkSettings? left, ChunkSettings? right)

Parameters

left ChunkSettings

right ChunkSettings

Returns

bool