DotNext.Threading by .NET Foundation and Contributors

<PackageReference Include="DotNext.Threading" Version="5.17.2" />

.NET API 246,088 bytes

 TaskCompletionPipe<T>

public class TaskCompletionPipe<T> : IAsyncEnumerable<T>, IResettable where T : Task
Represents a pipe to process asynchronous tasks as they complete.
public Task Completion { get; }

Gets a task that turns into completed state when all submitted tasks are completed.

public bool IsCompletionTaskSupported { get; set; }

Gets or sets a value indicating that this pipe supports Completion property.

public TaskCompletionPipe()

Initializes a new pipe.

public void Add(T task)

Adds the task to this pipe.

public void Add(T task, object userData)

Adds the task to this pipe.

public void Add(ReadOnlySpan<T> tasks, bool complete = false, object userData = null)

Submits a group of tasks and mark this pipe as completed.

public void Complete()

Marks the pipe as being complete, meaning no more items will be added to it.

public IAsyncEnumerator<T> GetAsyncEnumerator(CancellationToken token)

Gets the enumerator to get the completed tasks.

public void Reset()

Reuses the pipe.

public bool TryRead(out T task)

Attempts to read the completed task synchronously.

public bool TryRead(out T task, out object userData)

Attempts to read the completed task synchronously.

public ValueTask<bool> WaitToReadAsync(TimeSpan timeout, CancellationToken token = default)

Waits for the first completed task.

public ValueTask<bool> WaitToReadAsync(CancellationToken token = default)

Waits for the first completed task.