Class BatchSequenceReader

Enables the batch processing creating a BatchSequence containing the configured number of messages.

Inheritance

object

SequenceReaderBase

BatchSequenceReader

Implements

ISequenceReader

ISorted

Inherited Members

SequenceReaderBase.GetSequenceAsync(ConsumerPipelineContext)

SequenceReaderBase.HandlesRawMessages

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Silverback.Messaging.Sequences.Batch

Assembly: Silverback.Integration.dll

Syntax

public sealed class BatchSequenceReader : SequenceReaderBase, ISequenceReader, ISorted

Constructors

BatchSequenceReader()

Enables the batch processing creating a BatchSequence containing the configured number of messages.

Declaration

public BatchSequenceReader()

Properties

SortIndex

Gets the sort index.

Declaration

public int SortIndex { get; }

Property Value

Type	Description
int

Methods

CanHandleAsync(ConsumerPipelineContext)

Checks whether this reader can and must handle the message being processed in the specified context.

Declaration

public override ValueTask<bool> CanHandleAsync(ConsumerPipelineContext context)

Parameters

Type	Name	Description
ConsumerPipelineContext	context	The current ConsumerPipelineContext.

Returns

Type	Description
ValueTask<bool>	A Task<TResult> representing the asynchronous operation. The task result contains a value indicating whether this reader can and must handle the message.

Overrides

SequenceReaderBase.CanHandleAsync(ConsumerPipelineContext)

CreateNewSequenceCore(string, ConsumerPipelineContext)

Creates the new sequence object.

Declaration

protected override ISequence CreateNewSequenceCore(string sequenceId, ConsumerPipelineContext context)

Parameters

Type	Name	Description
string	sequenceId	The sequence identifier.
ConsumerPipelineContext	context	The current ConsumerPipelineContext.

Returns

Type	Description
ISequence	The new sequence.

Overrides

SequenceReaderBase.CreateNewSequenceCore(string, ConsumerPipelineContext)

GetExistingSequenceAsync(ConsumerPipelineContext, string)

Retrieves the existing incomplete sequence from the store.

Declaration

protected override ValueTask<ISequence?> GetExistingSequenceAsync(ConsumerPipelineContext context, string sequenceId)

Parameters

Type	Name	Description
ConsumerPipelineContext	context	The current ConsumerPipelineContext.
string	sequenceId	The sequence identifier.

Returns

Type	Description
ValueTask<ISequence>	The ISequence or null if not found.

Overrides

SequenceReaderBase.GetExistingSequenceAsync(ConsumerPipelineContext, string)

GetSequenceIdAsync(ConsumerPipelineContext)

Gets the sequence identifier extracted from the current envelope.

Declaration

protected override ValueTask<string> GetSequenceIdAsync(ConsumerPipelineContext context)

Parameters

Type	Name	Description
ConsumerPipelineContext	context	The current ConsumerPipelineContext.

Returns

Type	Description
ValueTask<string>	A Task<TResult> representing the asynchronous operation. The task result contains the recognized sequence identifier, or null.

Overrides

SequenceReaderBase.GetSequenceIdAsync(ConsumerPipelineContext)

IsNewSequenceAsync(string, ConsumerPipelineContext)

Determines if the current message corresponds with the beginning of a new sequence.

Declaration

protected override ValueTask<bool> IsNewSequenceAsync(string sequenceId, ConsumerPipelineContext context)

Parameters

Type	Name	Description
string	sequenceId	The sequence identifier.
ConsumerPipelineContext	context	The current ConsumerPipelineContext.

Returns

Type	Description
ValueTask<bool>	A Task<TResult> representing the asynchronous operation. The task result contains true if a new sequence is starting; otherwise false.

Overrides

SequenceReaderBase.IsNewSequenceAsync(string, ConsumerPipelineContext)

Implements

ISequenceReader

ISorted