Class BatchSequenceReader

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

Inheritance
object
SequenceReaderBase
BatchSequenceReader
Inherited Members
Namespace: Silverback.Messaging.Sequences.Batch
Assembly: Silverback.Integration.dll
Syntax
public sealed class BatchSequenceReader : SequenceReaderBase, ISequenceReader, ISorted

Properties

| Improve this doc View source

SortIndex

Gets the sort index.

Declaration
public int SortIndex { get; }
Property Value
Type Description
int

Methods

| Improve this doc View source

CanHandleAsync(ConsumerPipelineContext)

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

Declaration
public override Task<bool> CanHandleAsync(ConsumerPipelineContext context)
Parameters
Type Name Description
ConsumerPipelineContext context

The current ConsumerPipelineContext.
Returns
Type Description
Task<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
| Improve this doc View source

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
| Improve this doc View source

GetExistingSequenceAsync(ConsumerPipelineContext, string)

Retrieves the existing incomplete sequence from the store.

Declaration
protected override Task<ISequence?> GetExistingSequenceAsync(ConsumerPipelineContext context, string sequenceId)
Parameters
Type Name Description
ConsumerPipelineContext context

The current ConsumerPipelineContext.
string sequenceId

The sequence identifier.
Returns
Type Description
Task<ISequence>

The ISequence or null if not found.
Overrides
| Improve this doc View source

GetSequenceIdAsync(ConsumerPipelineContext)

Gets the sequence identifier extracted from the current envelope.

Declaration
protected override Task<string> GetSequenceIdAsync(ConsumerPipelineContext context)
Parameters
Type Name Description
ConsumerPipelineContext context

The current ConsumerPipelineContext.
Returns
Type Description
Task<string>

A Task<TResult> representing the asynchronous operation. The task result contains the recognized sequence identifier, or null.
Overrides
| Improve this doc View source

IsNewSequenceAsync(string, ConsumerPipelineContext)

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

Declaration
protected override Task<bool> IsNewSequenceAsync(string sequenceId, ConsumerPipelineContext context)
Parameters
Type Name Description
string sequenceId

The sequence identifier.
ConsumerPipelineContext context

The current ConsumerPipelineContext.
Returns
Type Description
Task<bool>

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

Implements