Click here to Skip to main content
13,558,426 members
Click here to Skip to main content
Add your own
alternative version

Tagged as

Stats

26K views
98 downloads
59 bookmarked
Posted 10 Feb 2018
Licenced CPOL

Addressing a Simple Yet Common C# Async/Await Misconception

, 19 Feb 2018
Rate this:
Please Sign up or sign in to vote.
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.

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':

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.
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)

Share

About the Author

BenHall_io
Software Developer (Senior)
United Kingdom United Kingdom
Left an enjoyable career teaching Computer Science & programming in 2016 and started out in software development.

Have an unhealthy obsession with .NET / C# internals.

Currently a Senior Software Engineer, based in Somerset, UK, working with:

C# / ASP.NET
NServiceBus
SQL Server
JavaScript, jQuery etc…
PowerShell + DSC

You may also be interested in...

Pro

Comments and Discussions

 
QuestionI don't understand Pin
tbayart2-Apr-18 22:30
membertbayart2-Apr-18 22:30 
QuestionWPF Example of Async method usage with (custom) TaskScheduler Pin
Dirk Bahle27-Mar-18 21:08
mvpDirk Bahle27-Mar-18 21:08 
GeneralMy vote of 5 Pin
KGustafson20-Feb-18 9:01
professionalKGustafson20-Feb-18 9:01 
QuestionCould I Suggest Using a Single Thread Synchronization Context for the Demo? Pin
George Swan19-Feb-18 11:41
memberGeorge Swan19-Feb-18 11:41 
QuestionDisgusting article. Pin
Member 1171790117-Feb-18 0:58
memberMember 1171790117-Feb-18 0:58 
GeneralRe: Pin
BenHall_io17-Feb-18 5:49
professionalBenHall_io17-Feb-18 5:49 
GeneralRe: Pin
CHill6020-Mar-18 6:30
protectorCHill6020-Mar-18 6:30 
QuestionDon't forget to start the task... Pin
Bernhard Hiller16-Feb-18 2:45
memberBernhard Hiller16-Feb-18 2:45 
AnswerRe: Don't forget to start the task... Pin
BenHall_io16-Feb-18 5:24
professionalBenHall_io16-Feb-18 5:24 
AnswerRe: Don't forget to start the task... Pin
ipavlu23-Mar-18 8:29
professionalipavlu23-Mar-18 8:29 
PraiseReally helpful thank you Pin
Olly Carter14-Feb-18 23:22
memberOlly Carter14-Feb-18 23:22 
SuggestionWinform example? Pin
KLPounds14-Feb-18 11:46
memberKLPounds14-Feb-18 11:46 
AnswerRe: Winform example? Pin
BenHall_io19-Feb-18 9:46
professionalBenHall_io19-Feb-18 9:46 
SuggestionDisappointed... Pin
mldisibio14-Feb-18 9:49
membermldisibio14-Feb-18 9:49 
GeneralRe: Disappointed... Pin
BenHall_io14-Feb-18 23:15
professionalBenHall_io14-Feb-18 23:15 
GeneralRe: Less Disappointed Now... :-) Pin
mldisibio15-Feb-18 5:30
membermldisibio15-Feb-18 5:30 
QuestionStill confused Pin
Steve Grattan14-Feb-18 2:58
memberSteve Grattan14-Feb-18 2:58 
AnswerRe: Still confused Pin
BenHall_io14-Feb-18 5:58
professionalBenHall_io14-Feb-18 5:58 
GeneralRe: Still confused Pin
Steve Grattan14-Feb-18 12:49
memberSteve Grattan14-Feb-18 12:49 
AnswerRe: Still confused Pin
tolsen6414-Feb-18 10:20
membertolsen6414-Feb-18 10:20 
GeneralRe: Still confused Pin
Steve Grattan14-Feb-18 12:45
memberSteve Grattan14-Feb-18 12:45 
GeneralRe: Still confused Pin
tolsen6414-Feb-18 12:59
membertolsen6414-Feb-18 12:59 
Questionchanging 1 line changes the outcome Pin
williams200014-Feb-18 2:35
professionalwilliams200014-Feb-18 2:35 
AnswerRe: changing 1 line changes the outcome Pin
BenHall_io14-Feb-18 5:43
professionalBenHall_io14-Feb-18 5:43 
GeneralRe: changing 1 line changes the outcome Pin
williams200014-Feb-18 6:37
professionalwilliams200014-Feb-18 6:37 

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.

Permalink | Advertise | Privacy | Terms of Use | Mobile
Web03 | 2.8.180515.1 | Last Updated 19 Feb 2018
Article Copyright 2018 by BenHall_io
Everything else Copyright © CodeProject, 1999-2018
Layout: fixed | fluid