Returning Void in Async method from WEB API Controller

Question

I have this async method inside ASP.NET MVC 4 WEB API Controller that I got from this blog: http://www.strathweb.com/2012/04/html5-drag-and-drop-asynchronous-multi-file-upload-with-asp-net-webapi/

  public async Task<IList<RecivedFile>> Post()
    {
        List<RecivedFile> result = new List<RecivedFile>();
        if (Request.Content.IsMimeMultipartContent())
        {
            try
            {
                MultipartFormDataStreamProvider stream = new MultipartFormDataStreamProvider(HostingEnvironment.MapPath("~/USER-UPLOADS"));

                IEnumerable<HttpContent> bodyparts = await Request.Content.ReadAsMultipartAsync(stream);
                IDictionary<string, string> bodyPartFiles = stream.BodyPartFileNames;
                IList<string> newFiles = new List<string>();

                foreach (var item in bodyPartFiles)
                {
                    var newName = string.Empty;
                    var file = new FileInfo(item.Value);

                    if (item.Key.Contains("\""))
                        newName = Path.Combine(file.Directory.ToString(), item.Key.Substring(1, item.Key.Length - 2));
                    else
                        newName = Path.Combine(file.Directory.ToString(), item.Key);

                    File.Move(file.FullName, newName);
                    newFiles.Add(newName);
                }

                var uploadedFiles = newFiles.Select(i =>
                {
                    var fi = new FileInfo(i);
                    return new RecivedFile(fi.Name, fi.FullName, fi.Length);
                }).ToList();

                result.AddRange(uploadedFiles);
            }
            catch (Exception e)
            {
            }
        }
        return result;
    }

My question is why exactly does this method have a return type of Task? It is not clear "where to" or "to whom" it returns this task? It's like there is no one that waits for/receives the returned object.

I wonder what will be the implications if I return void like this:

EDIT:

I have tried the code below and it completely breaks the program. it's like the runtime looses the reference to the code, the code itself doesn't finish running.

    public async void Post()
    {
        List<RecivedFile> result = new List<RecivedFile>();
        if (Request.Content.IsMimeMultipartContent())
        {
            try
            {
                MultipartFormDataStreamProvider stream = new MultipartFormDataStreamProvider(HostingEnvironment.MapPath("~/USER-UPLOADS"));

                IEnumerable<HttpContent> bodyparts = await Request.Content.ReadAsMultipartAsync(stream);
                IDictionary<string, string> bodyPartFiles = stream.BodyPartFileNames;
                IList<string> newFiles = new List<string>();

                foreach (var item in bodyPartFiles)
                {
                    var newName = string.Empty;
                    var file = new FileInfo(item.Value);

                    if (item.Key.Contains("\""))
                        newName = Path.Combine(file.Directory.ToString(), item.Key.Substring(1, item.Key.Length - 2));
                    else
                        newName = Path.Combine(file.Directory.ToString(), item.Key);

                    File.Move(file.FullName, newName);
                    newFiles.Add(newName);
                }

            }
            catch (Exception e)
            {
            }
        }

    }

Stephen Cleary · Accepted Answer · 2012-08-11 15:24:21Z

7

The ASP.NET runtime waits for it. You may find this video useful.

Most examples for async assume a UI context. ASP.NET also provides a context, but it's a "request" context - one for each HTTP request. My async/await post gives an overview of this "context", and the async/await FAQ goes into much more detail.

answered Aug 11, 2012 at 15:24

Stephen Cleary

460k78 gold badges721 silver badges858 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

user1561202 Over a year ago

So the conclusion is to never return void in async methods when used in ASP.NET

Stephen Cleary Over a year ago

There are a handful of situations in ASP.NET 4.5 where you can use an async void method - the runtime will detect it and react appropriately. But as a general rule, it's best to use async Task unless you really have to do async void.

Filip W Over a year ago

since async void is essentially "fire and forget" there very rarely is a reason to do that. One example is the page_load in the new Web Forms - protected async void Page_Load(object sender, EventArgs e)

tugberk · Accepted Answer · 2012-08-11 15:44:18Z

1

If you return void, you will be returning 204 "No Content" Response message immediately regardless of the completion status of your asynchronous operation. This is done by the help of VoidResultConverter.

Note: On RC, you will see that it returns 200 "OK" response but with the RTM, it will return 204 "No Content" response.

edited Aug 11, 2012 at 15:44

answered Aug 11, 2012 at 15:33

tugberk

58.7k71 gold badges252 silver badges342 bronze badges

Comments

user1527329 · Accepted Answer · 2012-08-11 13:35:20Z

0

With return type void you don't wait for an object to return.. You wait for an operation to finish. You wait for your Task to finish.

answered Aug 11, 2012 at 13:35

user1527329

5294 silver badges8 bronze badges

1 Comment

user1561202 Over a year ago

Not sure to whom you refer by saying "you" ("you don't wait"). I don't want to wait for anything. The point here that it is used in WEB API and I can't understand what exactly do you want me to wait for?

Collectives™ on Stack Overflow

Returning Void in Async method from WEB API Controller

3 Answers 3

3 Comments

Comments

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

3 Comments

Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related