Click here to Skip to main content
15,891,674 members
Articles / Programming Languages / C#

Addressing a Simple Yet Common C# Async/Await Misconception

Rate me:
Please Sign up or sign in to vote.
4.72/5 (41 votes)
19 Feb 2018CPOL2 min read 71K   181   65   54
I regularly come across developers who hold the misconception that code in a method will continue to be executed, in parallel to code in an awaited method call. So I'm going to demonstrate the behaviour we should expect in this article.

Async/await has been part of C# since C# 5.0 yet many developers have yet to explore how it works under the covers, which I would recommend for any syntactic sugar in C#. I won’t be going into that level of detail now, nor will I explore the subtleties of IO and CPU bound operations.

The Common Misconception

That awaited code executes in parallel to the code that follows.

i.e. in the following code, LongOperation() is called and awaited, then while this is executing and before it has completed, the code ‘do other things’ will start being executed.

C++
void DemoAsyncAwait()
{
    WithAwaitAtCallAsync().Wait();
}

async Task WithAwaitAtCallAsync()
{
    await LongOperation();

    // do other things
}

This is not how it behaves.

In the above code, what actually happens is that the await operator causes WithAwaitAtCallAsync() to suspend at that line and returns control back to DemoAsyncAwait() until the awaited task, LongOperation(), is complete.

When LongOperation() completes, then ‘do other things’ will be executed.

And If We Don't Await When We Call?

Then you do get that behaviour some developers innocently expect from awaiting the call, where LongOperation() is left to complete in the background while continuing on with WithoutAwaitAtCallAsync() in parallel, 'doing other things':

C#
void DemoAsyncAwait()
{
    WithoutAwaitAtCallAsync().Wait(); 
} 

async Task WithoutAwaitAtCallAsync() 
{ 
    Task task = LongOperation(); 

    // doing other things 
   
    await task;

    // more things to do
}

However, if LongOperation() is not complete when we reach the awaited Task it returned, then it yields control back to DemoAsyncAwait(), as above. It does not continue to complete 'more things to do' - not until the awaited task is complete.

Complete Console Application Example

Some notes about this code:

  • Always use await over Task.Wait() to retrieve the result of a background task (outside of this demo) to avoid blocking. I've used Task.Wait() in my demonstrations to force blocking and prevent the two separate demo results overlapping in time (I know in hindsight, Winforms would have been a better demo).
  • I have intentionally not used Task.Run() as I don't want to confuse things with new threads. Let's just assume LongOperation() is IO-bound.
  • I used Task.Delay() to simulate the long operation. Thread.Sleep() would block the thread.
C#
private static void Main(string[] args)
{
    // Demo 1
    Console.WriteLine(" Demo 1: Awaiting call to long operation:");
    Task withAwaitAtCallTask = WithAwaitAtCallAsync();
    withAwaitAtCallTask.Wait();

    // Demo 2
    Console.WriteLine(" Demo 2: NOT awaiting call to long operation:");
    Task withoutAwaitAtCallTask = WithoutAwaitAtCallAsync();
    withoutAwaitAtCallTask.Wait();

    Console.ReadKey();
}

private static async Task WithAwaitAtCallAsync()
{   
    Console.WriteLine(" WithAwaitAtCallAsync() entered.");

    Console.WriteLine(" Awaiting when I call LongOperation().");
    await LongOperation();

    Console.WriteLine(" Pretending to do other work in WithAwaitAtCallAsync().");
}

private static async Task WithoutAwaitAtCallAsync()
{
    Console.WriteLine(" WithoutAwaitAtCallAsync() entered.");

    Console.WriteLine(" Call made to LongOperation() with NO await.");
    Task task = LongOperation();

    Console.WriteLine(" Do some other work in WithoutAwaitAtCallAsync() after calling LongOperation().");

    await task;
}

private static async Task LongOperation()
{
     Console.WriteLine(" LongOperation() entered.");

     Console.WriteLine(" Starting the long (3 second) process in LongOperation()...");
     await Task.Delay(4000);
     Console.WriteLine(" Completed the long (3 second) process in LongOperation()...");
}

This is what happens when the code is executed (with colouring):

GiF of example

Summary

If you use the await keyword when calling an async method (from inside an async method), execution of the calling method is suspended to avoid blocking the thread and control is passed (or yielded) back up the method chain. If, on its journey up the chain, it reaches a call that was not awaited, then code in that method is able to continue in parallel to the remaining processing in the chain of awaited methods until it runs out of work to do, and then needs to await the result, which is inside the Task object returned by LongOperation().

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)


Written By
Software Developer (Senior)
United Kingdom United Kingdom
Ben is the Principal Developer at a gov.uk and .NET Foundation foundation member. He previously worked for over 9 years as a school teacher, teaching programming and Computer Science. He enjoys making complex topics accessible and practical for busy developers.


Comments and Discussions

 
GeneralRe: changing 1 line changes the outcome Pin
williams200014-Feb-18 6:37
professionalwilliams200014-Feb-18 6:37 
QuestionDoes it really work in a multi-threaded ASP.NET application? Pin
Hmmkk14-Feb-18 1:56
Hmmkk14-Feb-18 1:56 
AnswerRe: Does it really work in a multi-threaded ASP.NET application? Pin
George Swan14-Feb-18 3:39
mveGeorge Swan14-Feb-18 3:39 
GeneralRe: Does it really work in a multi-threaded ASP.NET application? Pin
Hmmkk14-Feb-18 5:05
Hmmkk14-Feb-18 5:05 
GeneralRe: Does it really work in a multi-threaded ASP.NET application? Pin
George Swan16-Feb-18 21:06
mveGeorge Swan16-Feb-18 21:06 
GeneralRe: Does it really work in a multi-threaded ASP.NET application? Pin
Hmmkk19-Feb-18 0:44
Hmmkk19-Feb-18 0:44 
GeneralRe: Does it really work in a multi-threaded ASP.NET application? Pin
George Swan19-Feb-18 5:01
mveGeorge Swan19-Feb-18 5:01 
GeneralRe: Does it really work in a multi-threaded ASP.NET application? Pin
Hmmkk23-Mar-18 12:06
Hmmkk23-Mar-18 12:06 
Sorry for late reply on this, but yes, pretty much at least. In my main method pretty much everything is surrounded with try/catch and I still don't see why my database method wouldn't return null because I check with something like
if(responseObject == null)
{
 return error;
}

Why would it only throw exception or time out when I don't check for null in the main method?

The only exception that is thrown is object not initialized (null) if I for example omit the null check in the main method and directly start using the objects properties. Let's say I have a string in the object, and I do something like:
var responseObject = await getObject(id);
responseObject.MyString = responseObject.MyString.Replace("a", "b"); // Throws null error if MyString is null

If I however do something like this:
var responseObject = await getObject(id);
if(responseObject == null)
{
 return error;
}
responseObject.MyString = responseObject.MyString.Replace("a", "b");

I don't get null exception.

Since I have encountered this behavior a few times I have been doing null checks pretty much all the time to avoid any issues that may or may not happen, so it was a while ago I really looked into this, but the main issue when debugging it, is that it is more of a problem in production on a real server, than in my development environment. Of course, that could suggest that database could time out or something, but I'm not requesting anything that big and it still doesn't explain why a null check makes it not time out.
I believe in science, not believes.
-Hmmkk


modified 23-Mar-18 18:22pm.

AnswerRe: Does it really work in a multi-threaded ASP.NET application? Pin
ipavlu23-Mar-18 8:39
ipavlu23-Mar-18 8:39 
GeneralRe: Does it really work in a multi-threaded ASP.NET application? Pin
Hmmkk23-Mar-18 12:15
Hmmkk23-Mar-18 12:15 
GeneralRe: Does it really work in a multi-threaded ASP.NET application? Pin
ipavlu23-Mar-18 13:20
ipavlu23-Mar-18 13:20 
GeneralMy vote of 4 Pin
KGustafson13-Feb-18 8:27
professionalKGustafson13-Feb-18 8:27 
GeneralRe: My vote of 4 Pin
Ben Hall (failingfast.io)14-Feb-18 6:02
professionalBen Hall (failingfast.io)14-Feb-18 6:02 
QuestionWill this work with a UI Thread? Pin
George Swan12-Feb-18 5:43
mveGeorge Swan12-Feb-18 5:43 
AnswerRe: Will this work with a UI Thread? Pin
Ben Hall (failingfast.io)12-Feb-18 6:20
professionalBen Hall (failingfast.io)12-Feb-18 6:20 
GeneralRe: Will this work with a UI Thread? Pin
George Swan12-Feb-18 7:12
mveGeorge Swan12-Feb-18 7:12 
GeneralRe: Will this work with a UI Thread? Pin
Member 1302925212-Feb-18 22:02
Member 1302925212-Feb-18 22:02 
GeneralRe: Will this work with a UI Thread? Pin
George Swan13-Feb-18 7:47
mveGeorge Swan13-Feb-18 7:47 
GeneralRe: Will this work with a UI Thread? Pin
Stephen Russell AAI MCT14-Feb-18 1:35
professionalStephen Russell AAI MCT14-Feb-18 1:35 
GeneralRe: Will this work with a UI Thread? Pin
George Swan14-Feb-18 3:06
mveGeorge Swan14-Feb-18 3:06 
QuestionOK couple of things Pin
Sacha Barber11-Feb-18 10:43
Sacha Barber11-Feb-18 10:43 
AnswerRe: OK couple of things Pin
Ben Hall (failingfast.io)12-Feb-18 1:46
professionalBen Hall (failingfast.io)12-Feb-18 1:46 
GeneralRe: OK couple of things Pin
wkempf13-Feb-18 3:50
wkempf13-Feb-18 3:50 
GeneralRe: OK couple of things Pin
Ben Hall (failingfast.io)13-Feb-18 6:36
professionalBen Hall (failingfast.io)13-Feb-18 6:36 
QuestionGood Tip Pin
Dirk Bahle11-Feb-18 7:14
Dirk Bahle11-Feb-18 7:14 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Praise Praise    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.