What does an async Web API method return?

Question

What is actually returned by a Web API method with the following signature?

    [HttpPost]
    public async Task<IHttpActionResult> Post([FromBody] ReviewViewModel review)
    {
        using (var context = new BooksContext())
        {
            var book = await context.Books.FirstOrDefaultAsync(b => b.Id == review.BookId);
            if (book == null)
            {
                return NotFound();
            }

            var newReview = context.Reviews.Add(new Review
            {
                BookId = book.Id,
                Description = review.Description,
                Rating = review.Rating
            });

            await context.SaveChangesAsync();
            return Ok(new ReviewViewModel(newReview));
        }
    }

Method taken from: http://www.developerhandbook.com/c-sharp/create-restful-api-authentication-using-web-api-jwt/

I'm considering that it is either:

1) The framework does not return a response to the calling client until .IsCompleted is true, or 2) The framework does return to the client but the client must handle the situation gracefully, or 3) Something else entirely.

Once you understand the state machine behind the async syntatic sugar it is somewhat easier to realize what is really happening. — Otávio Décio, Jan 30 '17 at 20:49
I thought I understood the state machine, but this would be the Web API providing extra functionality on top of that, yes? — Matt W, Jan 30 '17 at 20:52
Possible duplicate of [How does await async work in C#](http://stackoverflow.com/questions/17488677/how-does-await-async-work-in-c-sharp) — Igor, Jan 30 '17 at 20:53

score 5 · Answer 1 · answered Jan 30 '17 at 20:48

5

async actions are an implementation detail.

The framework will wait for the Task to resolve; the client won't notice any difference.

answered Jan 30 '17 at 20:48

SLaks

868,454
176
1,908
1,964

score 2 · Accepted Answer · answered Jan 30 '17 at 20:49

From the link you provided:

Writing asynchronous code in this manner allows the thread to be released whilst data (Books and Reviews) is being retrieved from the database and converted to objects to be consumed by our code. When the asynchronous operation is complete, the code picks up where it was up to and continues executing. (By which, we mean the hydrated data objects are passed to the underlying framework and converted to JSON/XML and returned to the client).

What does an async Web API method return?

2 Answers2