Why would I bother to use Task.ConfigureAwait(continueOnCapturedContext: false);

by

Stephen Cleary has a really good series on this you can find here, I quoted the piece specific to your question:

Most of the time, you don’t need to sync back to the “main” context. Most async methods will be designed with composition in mind: they await other operations, and each one represents an asynchronous operation itself (which can be composed by others). In this case, you want to tell the awaiter to not capture the current context by calling ConfigureAwait and passing false, e.g.:

private async Task DownloadFileAsync(string fileName)
{
  // Use HttpClient or whatever to download the file contents.
  var fileContents = await DownloadFileContentsAsync(fileName).ConfigureAwait(false);

  // Note that because of the ConfigureAwait(false), we are not on the original context here.
  // Instead, we're running on the thread pool.

  // Write the file contents out to a disk file.
  await WriteToDiskAsync(fileName, fileContents).ConfigureAwait(false);

  // The second call to ConfigureAwait(false) is not *required*, but it is Good Practice.
}

// WinForms example (it works exactly the same for WPF).
private async void DownloadFileButton_Click(object sender, EventArgs e)
{
  // Since we asynchronously wait, the UI thread is not blocked by the file download.
  await DownloadFileAsync(fileNameTextBox.Text);

  // Since we resume on the UI context, we can directly access UI elements.
  resultTextBox.Text = "File downloaded!";
}

The important thing to note with this example is that each “level” of async method calls has its own context. DownloadFileButton_Click started in the UI context, and called DownloadFileAsync. DownloadFileAsync also started in the UI context, but then stepped out of its context by calling ConfigureAwait(false). The rest of DownloadFileAsync runs in the thread pool context. However, when DownloadFileAsync completes and DownloadFileButton_Click resumes, it does resume in the UI context.

A good rule of thumb is to use ConfigureAwait(false) unless you know you do need the context.

More Related Contents:

  1. Why the default SynchronizationContext is not captured in a Console App?
  2. What is the purpose of “return await” in C#?
  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. The ‘await’ operator can only be used within an async lambda expression
  17. How can I prevent synchronous continuations on a Task?
  18. FromBluetoothAddressAsync IAsyncOperation does not contain a definition for ‘GetAwaiter’ error
  19. C# GUI refresh and async serial port communication
  20. Correct way to get the CoreDispatcher in a Windows Store app
  21. Async action filter in MVC 4
  22. SynchronizationContext.Current is null in Continuation on the main UI thread
  23. Is it ok to use “async” with a ThreadStart method?
  24. Async provider in .NET Core DI
  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. Using async / await with DataReader ? ( without middle buffers!)
  30. Timeout pattern on task-based asynchronous method in C#

Leave a Comment