C# async/await Progress event on Task object

by

The recommended approach is described in the Task-based Asynchronous Pattern documentation, which gives each asynchronous method its own IProgress<T>:

public async Task PerformScanAsync(IProgress<MyScanProgress> progress)
{
  ...
  if (progress != null)
    progress.Report(new MyScanProgress(...));
}

Usage:

var progress = new Progress<MyScanProgress>();
progress.ProgressChanged += ...
PerformScanAsync(progress);

Notes:

  1. By convention, the progress parameter may be null if the caller doesn’t need progress reports, so be sure to check for this in your async method.
  2. Progress reporting is itself asynchronous, so you should create a new instance of your arguments each time you call (even better, just use immutable types for your event args). You should not mutate and then re-use the same arguments object for multiple calls to Progress.
  3. The Progress<T> type will capture the current context (e.g., UI context) on construction and will raise its ProgressChanged event in that context. So you don’t have to worry about marshaling back to the UI thread before calling Report.

More Related Contents:

  1. What is the purpose of “return await” in C#?
  2. Is it possible to await an event instead of another async method?
  3. Should I avoid ‘async void’ event handlers?
  4. Throttling asynchronous tasks
  5. Why does the EF 6 tutorial use asynchronous calls?
  6. Using async/await for multiple tasks
  7. Fire and forget async method in asp.net mvc
  8. Why File.ReadAllLinesAsync() blocks the UI thread?
  9. Using ‘async’ in a console application in C# [duplicate]
  10. How to write an async method with out parameter?
  11. How can I call an async method in Main?
  12. Is there anything like asynchronous BlockingCollection?
  13. How to protect resources that may be used in a multi-threaded or async environment?
  14. Cancelling a pending task synchronously on the UI thread
  15. Async Void, ASP.Net, and Count of Outstanding Operations
  16. Why the default SynchronizationContext is not captured in a Console App?
  17. How Async and Await works
  18. Async await vs GetAwaiter().GetResult() and callback
  19. How to ‘await’ raising an EventHandler event
  20. How does async works in C#?
  21. GetResponseAsync does not accept cancellationToken
  22. What’s the new C# await feature do? [closed]
  23. What is the correct way to cancel an async operation that doesn’t accept a CancellationToken?
  24. Async ShowDialog
  25. Program exits upon calling await
  26. Horrible performance using SqlCommand Async methods with large data
  27. Converting a WebClient method to async / await
  28. How to throttle multiple asynchronous tasks?
  29. How do I get a return value from Task.WaitAll() in a console app?
  30. call async method without await #2

Leave a Comment