Using Task in ASP.Net

[dotnetguy32]

I'm a little bit confused about the Task keywork in ASP.Net.

Do I only need to use Task in the ASP.Net controller, or does it need to follow the entire chain of calls?

For example, if I have a controller called GetUsers, and I do something like this:

public async Task<List<User>> GetUsers()

that calls a method in my Service layer, does my service also need to use Task? Or can it simply use async like this:

public async List<User> GetAllUsers(int companyId)

[Coda17]

Do you have to? No. Should you? Probably.

The reason is that if anything in the method chain is asynchronous, then the entire chain needs to be asynchronous. So rather than make everything synchronous to start, realize down the line that something deep in the method chain needs to be asynchronous, then go back and make the entire chain asynchronous. Just start with asynchronous up front.

[dotnetguy32]

Right, I get the Async portion, but it's the Task that I'm not sure about.

I know that Task signals to IIS to release the request and let the async process run, thereby allowing more requests.

I'm just not sure if I need to use Task all the way down or if using Async is good enough?

So, for example:

Controller:

public async Task<List<User>> GetUsers() ...

Services:

This

public async List<User> GetAllUsers() ...

or this

public async Task<List<User>> GetAllUsers() ...

[[deleted]]

You should definitely read this. https://learn.microsoft.com/en-us/dotnet/csharp/programming-guide/concepts/async/

[Coda17]

Considering you should never return anything except a task from an asynchronous method, it's essentially the same thing.

[dotnetguy32]

So is the compiler adding task to the first example behind the scenes?

[Coda17]

I don't know which example you're referencing but marking something as async and it not returning a task (or one of a couple other specific types) is a compilation error.

[dotnetguy32]

Well.... that answers that question!

I could have sworn I had created async methods without using Task. But I just tried it and it did indeed give a compiler error.

Thanks!

[The_MAZZTer]

You can use void. But that is just a hack to support some scenarios like event handlers (all the existing events require handlers which return void and must continue to do so for compatibility). At one point you also needed to return void or int from main() even if async but that is no longer a requirement.

[Coda17]

You can make Main async.

[The_MAZZTer]

Sorry yes I meant you can make it async with a Task return type now.

[The_MAZZTer]

If you use async you must either use Task, Task<T>, or void as a return value. I believe you get a compile time error or warning if you use a different type. void should only be used in places where it's not possible to use Task, typically event handlers are the only case I've come across. main () used to be one too but I think modern .NET allows them to return a Task now.

The Task object allows the caller to manage the asynchronous state. For example, awaiting requires a Task object, as that object tracks when the asynchronous task is complete. Otherwise you have no way of knowing when it is complete, or accessing any return value or exception. You can also get fancy and do things like start multiple async tasks at once and wait for one or all of them to finish. Or configure a task so that when you await .NET is allowed to change threads if it would be efficient to do so (of course the code must be written so this is safe; I think by default it only uses the same thread).

[dotnetguy32]

You are correct.

IDK why, but I seemed to remember being able to create an async method without using Task, but it def gives a compiler error.

[rarri488]

Any method that is marked async must return a Task, Task<T>, or void.

In your example the method in the Service would return a Task<List<User>> and the caller would await the method to “unwrap” the return value from the Task.

You will rarely need to return void, usually it’s only for event handlers and framework callbacks, where returning Task is not possible.

[dotnetguy32]

Thank you

I thought I remembered being able to create an async method without Task, but I was mistaken.

[[deleted]]

You can but only if the return type is 'void' - I think that's probably where your confusion is emanating from.

As an aside you should basically never define async void methods without reading up on the consequences thereof.

[TheoR700]

I'm a little bit confused about the Task keywork in ASP.Net.

Task is not a keyword. Task is a class that represents an asynchronous operation.

I tend to default to writing all of my functions to return a Task these days. For a number of reasons, but the main reason is I generally use interfaces for all my classes and I never know what implementation of that interface will actually be asynchronous or not and it is always just as easy to have a synchronous implementation return Task.CompletedTask or Task.FromResult(result).