ProgressWithCompletion<T> Class

Definition

Namespace:

Microsoft.VisualStudio.Threading

Assembly:

Microsoft.VisualStudio.Threading.dll

Package:

Microsoft.VisualStudio.Threading v17.11.20

An incremental progress reporting mechanism that also allows asynchronous awaiting for all reports to be processed.

generic <typename T>
public ref class ProgressWithCompletion : IProgress<T>

public class ProgressWithCompletion<T> : IProgress<T>

type ProgressWithCompletion<'T> = class
    interface IProgress<'T>

Public Class ProgressWithCompletion(Of T)
Implements IProgress(Of T)

Type Parameters

T

The type of message sent in progress updates.

Inheritance

Object

ProgressWithCompletion<T>

Implements

IProgress<T>

Constructors

ProgressWithCompletion<T>(Action<T>, JoinableTaskFactory)	Initializes a new instance of the ProgressWithCompletion<T> class.
ProgressWithCompletion<T>(Action<T>)	Initializes a new instance of the ProgressWithCompletion<T> class.
ProgressWithCompletion<T>(Func<T,Task>, JoinableTaskFactory)	Initializes a new instance of the ProgressWithCompletion<T> class.
ProgressWithCompletion<T>(Func<T,Task>)	Initializes a new instance of the ProgressWithCompletion<T> class.

Methods

Report(T)	Receives a progress update.
WaitAsync()	Returns a task that completes when all reported progress has executed.
WaitAsync(CancellationToken)	Returns a task that completes when all reported progress has executed.

Explicit Interface Implementations

IProgress<T>.Report(T)

Receives a progress update.

Thread Safety

This type is thread-safe for all members.