CODEWITHSUNDEEP
c#asp.netwebformsasync-await
atoMerz
atoMerz

Reputation: 7672

Is it safe to use async/await in ASP.NET event handlers?

I was doing some coding in ASP.NET when I came across this: 

protected async void someButtonClickHandler(...)
{
    if(await blah)
        doSomething();
    else
        doSomethingElse();
}

After asking this question I got a better understanding of how async/await works. But then it struck me is it safe to use async/await in the manner shown above?
I mean after calling await blah the caller continues execution. Which means it might render the response back to client before await blah completes. Is this right? And if this is the case what happens to doSomething()/doSomethingElse(). Will they ever be executed? If they're executed does the user see the effects of their changes?
In my case these methods change some data displayed to the user, but I'd also like to know what would happen in the general case.

Upvotes: 17

Views: 6232

Answers (2)

andrew pate
andrew pate

Reputation: 4297

I agree with Stephens answer (in short the ASP.NET SynchronisationContext keeps watch on how many tasks are running), but because it is a (best avoided) async void you might want to log any exceptions that would otherwise go un-noticed:

protected async void someButtonClickHandler(...)
{
    try{
        await someButtonClickHandlerInner(...)
    }
    catch (AggregateException ex)
    {
        logger.log(ex.flatten());
    }
    catch(Exception e){
        logger.log(e);  
    }
}

private async Task someButtonClickHandlerInner(...){
    if(await blah)
        doSomething();
    else
        doSomethingElse();
}

Upvotes: 0

Stephen Cleary
Stephen Cleary

Reputation: 457302

Yes it is safe, but not really recommended. The recommended way to do this is via RegisterAsyncTask. However, ASP.NET (Web Forms) will correctly handle async void event handlers.

The response is not rendered to the client when the handler awaits; the await only yields to the ASP.NET runtime, not to the client. The ASP.NET runtime is aware that the event handler has not completed, so it knows not to send the response. When the event handler completes, the ASP.NET runtime responds by sending the response at that time.

I have an MSDN article on async ASP.NET that you may find helpful. If you're curious about how the ASP.NET runtime is aware that the async handler has not completed, I cover that in an earlier MSDN article.

Upvotes: 28

Related Questions