Class ChunkSettings

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

Inheritance

object

ChunkSettings

Implements

IValidatableSettings

IEquatable<ChunkSettings>

Inherited Members

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Namespace: Silverback.Messaging.Sequences.Chunking

Assembly: Silverback.Integration.dll

Syntax

public sealed record ChunkSettings : IValidatableSettings, IEquatable<ChunkSettings>

Constructors

ChunkSettings()

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

Declaration

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).

Declaration

public bool AlwaysAddHeaders { get; init; }

Property Value

Type	Description
bool

Size

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

Declaration

public int Size { get; init; }

Property Value

Type	Description
int

Methods

Equals(ChunkSettings?)

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

Declaration

public bool Equals(ChunkSettings? other)

Parameters

Type	Name	Description
ChunkSettings	other

Returns

Type	Description
bool

Equals(object?)

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

Declaration

public override bool Equals(object? obj)

Parameters

Type	Name	Description
object	obj

Returns

Type	Description
bool

Overrides

object.Equals(object)

GetHashCode()

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

Declaration

public override int GetHashCode()

Returns

Type	Description
int

Overrides

object.GetHashCode()

ToString()

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

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 ==(ChunkSettings?, ChunkSettings?)

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

Declaration

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

Parameters

Type	Name	Description
ChunkSettings	left
ChunkSettings	right

Returns

Type	Description
bool

operator !=(ChunkSettings?, ChunkSettings?)

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

Declaration

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

Parameters

Type	Name	Description
ChunkSettings	left
ChunkSettings	right

Returns

Type	Description
bool

Implements

IValidatableSettings

IEquatable<T>