How to wait for async method to complete?

by

The most important thing to know about async and await is that await doesn’t wait for the associated call to complete. What await does is to return the result of the operation immediately and synchronously if the operation has already completed or, if it hasn’t, to schedule a continuation to execute the remainder of the async method and then to return control to the caller. When the asynchronous operation completes, the scheduled completion will then execute.

The answer to the specific question in your question’s title is to block on an async method’s return value (which should be of type Task or Task<T>) by calling an appropriate Wait method:

public static async Task<Foo> GetFooAsync()
{
    // Start asynchronous operation(s) and return associated task.
    ...
}

public static Foo CallGetFooAsyncAndWaitOnResult()
{
    var task = GetFooAsync();
    task.Wait(); // Blocks current thread until GetFooAsync task completes
                 // For pedagogical use only: in general, don't do this!
    var result = task.Result;
    return result;
}

In this code snippet, CallGetFooAsyncAndWaitOnResult is a synchronous wrapper around asynchronous method GetFooAsync. However, this pattern is to be avoided for the most part since it will block a whole thread pool thread for the duration of the asynchronous operation. This an inefficient use of the various asynchronous mechanisms exposed by APIs that go to great efforts to provide them.

The answer at “await” doesn’t wait for the completion of call has several, more detailed, explanations of these keywords.

Meanwhile, @Stephen Cleary’s guidance about async void holds. Other nice explanations for why can be found at http://www.tonicodes.net/blog/why-you-should-almost-never-write-void-asynchronous-methods/ and https://jaylee.org/archive/2012/07/08/c-sharp-async-tips-and-tricks-part-2-async-void.html

More Related Contents:

  1. How and when to use ‘async’ and ‘await’
  2. How would I run an async Task method synchronously?
  3. When correctly use Task.Run and when just async-await
  4. If async-await doesn’t create any additional threads, then how does it make applications responsive?
  5. Await on a completed task same as task.Result?
  6. await Task.Run vs await
  7. How do yield and await implement flow of control in .NET?
  8. Async/await with/without awaiting (fire and forget)
  9. When should I use Async Controllers in ASP.NET MVC?
  10. Enforce an async method to be called once
  11. Why use Async/await all the way down
  12. async/await different thread ID
  13. awaitable Task based queue
  14. Different forms of the WCF service contract interface
  15. Named Mutex with await
  16. Is async HttpClient from .Net 4.5 a bad choice for intensive load applications?
  17. How does async works in C#?
  18. How could the new async feature in c# 5.0 be implemented with call/cc?
  19. Why was “SwitchTo” removed from Async CTP / Release?
  20. Should I worry about “This async method lacks ‘await’ operators and will run synchronously” warning
  21. Is .GetAwaiter().GetResult(); safe for general use?
  22. What is the correct way to cancel an async operation that doesn’t accept a CancellationToken?
  23. Async ShowDialog
  24. Async thread body loop, It just works, but how?
  25. Synchronous implementation of interface that returns Task
  26. How do you implement an async action delegate method?
  27. call async method without await #2
  28. Using async / await with DataReader ? ( without middle buffers!)
  29. Await and SynchronizationContext in a managed component hosted by an unmanaged app
  30. Timeout pattern on task-based asynchronous method in C#

Leave a Comment