• Home
  • Blog
  • Docs
  • GitHub
Show / Hide Table of Contents

Interface IAsyncJobQueue<T>

A queue for long-existing System.Collections.Generic.IAsyncEnumerable<T> that represent a collection of long running resumable jobs.

Inherited Members
IAsyncJobQueue<IAsyncEnumerable<T>, T>.GetCurrent(Guid)
IAsyncJobQueue<IAsyncEnumerable<T>, T>.GetNext(Guid)
IAsyncJobQueue<IAsyncEnumerable<T>, T>.AsEnumerable(Guid)
IAsyncJobQueue<IAsyncEnumerable<T>, T>.GetSource(Guid)
IAsyncJobQueue<IAsyncEnumerable<T>, T>.TryRemoveSource(Guid, IAsyncEnumerable<T>)
IAsyncJobQueue<IAsyncEnumerable<T>, T>.QueueJob(IAsyncEnumerable<T>)
IAsyncJobQueue<IAsyncEnumerable<T>, T>.QueueJob(IAsyncEnumerable<T>, Guid)
IAsyncJobQueue.HasJob(Guid)
IAsyncJobQueue.GetActiveJobs()
IAsyncJobQueue.GetQueuedJobs()
IAsyncJobQueue.GetZombieJobs()
IAsyncJobQueue.RequestCancellation(Guid)
Namespace: Snowflake.Extensibility.Queueing
Assembly: Snowflake.Framework.Primitives.dll
Syntax
public interface IAsyncJobQueue<T> : IAsyncJobQueue<IAsyncEnumerable<T>, T>, IAsyncJobQueue
Type Parameters
Name Description
T

The type of elements in the enumerable.

Methods

TryRemoveSource(Guid, out IAsyncEnumerable<T>)

Tries to remove the System.Collections.Generic.IAsyncEnumerable<T> as it was added to the job queue. This will only succeed if there are no active jobs for the enumerable in the queue.

Declaration
bool TryRemoveSource(Guid jobId, out IAsyncEnumerable<T> asyncEnumerable)
Parameters
Type Name Description
System.Guid jobId

The jobId

System.Collections.Generic.IAsyncEnumerable<T> asyncEnumerable

The async enumerable that is removed, or the empty enumerable if the result is false. This is unlike TryRemoveSource(Guid, out TAsyncEnumerable), which will return null instead of a enumerable.

Returns
Type Description
System.Boolean

If the enumerable was successfully removed.

Built with ❤️ by @chyyran. Text content licensed under CC-BY-SA 4.0.