Calling async method synchronously
I have an async
method:
public async Task<string> GenerateCodeAsync()
{
string code = await GenerateCodeService.GenerateCodeAsync();
return code;
}
I need to call this method from a synchronous method.
How can I do this without having to duplicate the GenerateCodeAsync
method in order for this to work synchronously?
Update
Yet no reasonable solution found.
However, I see that HttpClient
already implements this pattern
using (HttpClient client = new HttpClient())
{
// async
HttpResponseMessage responseAsync = await client.GetAsync(url);
// sync
HttpResponseMessage responseSync = client.GetAsync(url).Result;
}
You can access the Result
property of the task, which will cause your thread to block until the result is available:
string code = GenerateCodeAsync().Result;
Note: In some cases, this might lead to a deadlock: Your call to Result
blocks the main thread, thereby preventing the remainder of the async code to execute. You have the following options to make sure that this doesn't happen:
-
Add
.ConfigureAwait(false)
to your library method or -
explicitly execute your async method in a thread pool thread and wait for it to finish:
string code = Task.Run(() => GenerateCodeAsync).Result;
This does not mean that you should just mindlessly add .ConfigureAwait(false)
after all your async calls! For a detailed analysis on why and when you should use .ConfigureAwait(false)
, see the following blog post:
- .NET Blog: ConfigureAwait FAQ
You should get the awaiter (GetAwaiter()
) and end the wait for the completion of the asynchronous task (GetResult()
).
string code = GenerateCodeAsync().GetAwaiter().GetResult();
You should be able to get this done using delegates, lambda expression
private void button2_Click(object sender, EventArgs e)
{
label1.Text = "waiting....";
Task<string> sCode = Task.Run(async () =>
{
string msg =await GenerateCodeAsync();
return msg;
});
label1.Text += sCode.Result;
}
private Task<string> GenerateCodeAsync()
{
return Task.Run<string>(() => GenerateCode());
}
private string GenerateCode()
{
Thread.Sleep(2000);
return "I m back" ;
}
I need to call this method from a synchronously method.
It's possible with GenerateCodeAsync().Result
or GenerateCodeAsync().Wait()
, as the other answer suggests. This would block the current thread until GenerateCodeAsync
has completed.
However, your question is tagged with asp.net, and you also left the comment:
I was hoping for a simpler solution, thinking that asp.net handled this much easier than writing so many lines of code
My point is, you should not be blocking on an asynchronous method in ASP.NET. This will reduce the scalability of your web app, and may create a deadlock (when an await
continuation inside GenerateCodeAsync
is posted to AspNetSynchronizationContext
). Using Task.Run(...).Result
to offload something to a pool thread and then block will hurt the scalability even more, as it incurs +1 more thread to process a given HTTP request.
ASP.NET has built-in support for asynchronous methods, either through asynchronous controllers (in ASP.NET MVC and Web API) or directly via AsyncManager
and PageAsyncTask
in classic ASP.NET. You should use it. For more details, check this answer.