Class TaskRegistry

Namespace

LfrlAnvil.Async

Assembly

LfrlAnvil.Core.dll

Represents an object useful for storing in-progress Task instances.

public sealed class TaskRegistry : IDisposable, IAsyncDisposable

Inheritance

object

TaskRegistry

Implements

IDisposable

IAsyncDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ObjectExtensions.Memoize<T1, T2>(T1, Func<T1, IEnumerable<T2>>)

ObjectExtensions.ToRef<T>(T)

ObjectExtensions.VisitManyWithSelf<T>(T, Func<T, IEnumerable<T>>)

ObjectExtensions.VisitManyWithSelf<T>(T, Func<T, IEnumerable<T>>, Func<T, bool>)

ObjectExtensions.VisitMany<T>(T, Func<T, IEnumerable<T>>)

ObjectExtensions.VisitMany<T>(T, Func<T, IEnumerable<T>>, Func<T, bool>)

ObjectExtensions.VisitWithSelf<T>(T?, Func<T, T?>)

ObjectExtensions.VisitWithSelf<T>(T, Func<T, T>, Func<T, bool>)

ObjectExtensions.Visit<T>(T?, Func<T, T?>)

ObjectExtensions.Visit<T>(T, Func<T, T>, Func<T, bool>)

Constructors

TaskRegistry()

Creates a new empty TaskRegistry instance.

public TaskRegistry()

Properties

Count

Returns the current amount of stored in-progress Task instances.

public int Count { get; }

Property Value

int

Methods

Add(Task)

Registers provided task in this registry and stores it until it gets completed. Does nothing when task is already completed.

public void Add(Task task)

Parameters

task Task

Task to register.

Remarks

Task continuation that is responsible for removing provided task from this registry once it gets completed is created with the ExecuteSynchronously option.

Exceptions

ObjectDisposedException

When this registry has been disposed.

ArgumentException

When TaskStatus of task is equal to Created.

Contains(Task)

Checks if the provided task is currently stored by this registry.

[Pure]
public bool Contains(Task task)

Parameters

task Task

Task to check for.

Returns

bool

true when task is currently stored by this registry, otherwise false.

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()

Remarks

Marks this registry as disposed and waits for all stored in-progress Task instances to complete.

DisposeAsync()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources asynchronously.

public ValueTask DisposeAsync()

Returns

ValueTask

A task that represents the asynchronous dispose operation.

Remarks

Marks this registry as disposed and returns a ValueTask that waits for all stored in-progress Task instances to complete.

WaitForAll()

Creates a new Task that allows to wait for completion of all currently stored tasks in this registry.

[Pure]
public Task WaitForAll()

Returns

Task

Task instance that allows to wait for completion of all currently stored tasks in this registry.

Remarks

Tasks added to this registry after this method invocation will not be dynamically appended to the returned task. See WhenAll(params Task[]) for more information.