Interface ISequenceStore

The temporary store for the sequences being consumed.

Inherited Members

IReadOnlyCollection<ISequence>.Count

IEnumerable<ISequence>.GetEnumerator()

IAsyncDisposable.DisposeAsync()

IDisposable.Dispose()

Namespace: Silverback.Messaging.Sequences

Assembly: Silverback.Integration.dll

Syntax

public interface ISequenceStore : IReadOnlyCollection<ISequence>, IEnumerable<ISequence>, IEnumerable, IAsyncDisposable, IDisposable

Properties

IsDisposed

Gets a value indicating whether the store has been disposed.

Declaration

bool IsDisposed { get; }

Property Value

Type	Description
bool

Methods

AddAsync<TSequence>(TSequence)

Adds the specified sequence to the store.

Declaration

ValueTask<TSequence> AddAsync<TSequence>(TSequence sequence) where TSequence : class, ISequence

Parameters

Type	Name	Description
TSequence	sequence	The sequence to be added.

Returns

Type	Description
ValueTask<TSequence>	A Task<TResult> representing the asynchronous operation. The task result contains the ISequence instance.

Type Parameters

Name	Description
TSequence	The type of the sequence to be added.

GetAsync<TSequence>(string, bool)

Gets the sequence with the specified id.

Declaration

ValueTask<TSequence?> GetAsync<TSequence>(string sequenceId, bool matchPrefix = false) where TSequence : class, ISequence

Parameters

Type	Name	Description
string	sequenceId	The sequence identifier.
bool	matchPrefix	Enables sequence id prefix matching (String.StartsWith).

Returns

Type	Description
ValueTask<TSequence>	A Task<TResult> representing the asynchronous operation. The task result contains the ISequence instance.

Type Parameters

Name	Description
TSequence	The type of the sequence to be retrieved.

GetPendingSequences(bool, bool)

Returns the pending sequences currently in the store.

Declaration

IReadOnlyCollection<ISequence> GetPendingSequences(bool includeUnbounded = false, bool includeChildren = false)

Parameters

Type	Name	Description
bool	includeUnbounded	A value indicating whether the Silverback.Messaging.Sequences.Unbounded.UnboundedSequence instances have to be returned as well.
bool	includeChildren	A value indicating whether the child sequences have to be returned as well (e.g., a chunk sequence inside a batch sequence).

Returns

Type	Description
IReadOnlyCollection<ISequence>	The collection of sequences.

RemoveAsync(string)

Removes the sequence with the specified id.

Declaration

ValueTask RemoveAsync(string sequenceId)

Parameters

Type	Name	Description
string	sequenceId	The sequence identifier.

Returns

Type	Description
ValueTask	A Task representing the asynchronous operation.