Interface ISequenceStore

The temporary store for the sequences being consumed.

Inherited Members

System.Collections.Generic.IReadOnlyCollection<Silverback.Messaging.Sequences.ISequence>.Count

System.Collections.Generic.IEnumerable<Silverback.Messaging.Sequences.ISequence>.GetEnumerator()

System.IAsyncDisposable.DisposeAsync()

System.IDisposable.Dispose()

Namespace: Silverback.Messaging.Sequences

Assembly: Silverback.Integration.dll

Syntax

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

Methods

AddAsync<TSequence>(TSequence)

Adds the specified sequence to the store.

Declaration

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

Parameters

Type	Name	Description
TSequence	sequence	The sequence to be added.

Returns

Type	Description
System.Threading.Tasks.Task<TSequence>	A System.Threading.Tasks.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, Boolean)

Gets the sequence with the specified id.

Declaration

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

Parameters

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

Returns

Type	Description
System.Threading.Tasks.Task<TSequence>	A System.Threading.Tasks.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(Boolean)

Returns the pending sequences currently in the store.

Declaration

IReadOnlyCollection<ISequence> GetPendingSequences(bool includeUnbounded = false)

Parameters

Type	Name	Description
System.Boolean	includeUnbounded	A value indicating whether the Silverback.Messaging.Sequences.Unbounded.UnboundedSequence instances have to be returned as well.

Returns

Type	Description
System.Collections.Generic.IReadOnlyCollection<ISequence>	The collection of sequences.

RemoveAsync(String)

Removes the sequence with the specified id.

Declaration

Task RemoveAsync(string sequenceId)

Parameters

Type	Name	Description
System.String	sequenceId	The sequence identifier.

Returns

Type	Description
System.Threading.Tasks.Task	A System.Threading.Tasks.Task representing the asynchronous operation.