Async, Await Example
This page was last reviewed on Nov 21, 2023.
Dot Net Perls
Async, Await. In asynchronous programming, many control flows can exist at once. With the Async and Await keywords in VB.NET we have a standard, clear way to program this way.
Threading is supported. But with Async and Await, we do not need multiple threads. Some actions often are faster when done in an asynchronous way.
Tip Async and Await help with reading a file with StreamReader or downloading from the network.
And We use Task, a generic type, to Start and Wait for an asynchronous action (a task) to complete.
Let us begin. This example is somewhat complex. In Main we create a new Task—we must use AddressOf in VB.NET to reference a function for the Task.
Start In Main we invoke Start and Wait on the task. The program does not exit until ProcessDataAsync finishes.
Info The Async keyword is used at the function level. The ProcessDataAsync Sub is Async. It contains a usage of Await.
Finally The Await keyword, found in an Async Sub, causes the method to pause until the task (an argument to Await) is finished.
Imports System.IO Module Module1 Sub Main() ' Create a Task with AddressOf. Dim task = New Task(AddressOf ProcessDataAsync) ' Start and wait for task to end. task.Start() task.Wait() Console.ReadLine() End Sub Async Sub ProcessDataAsync() ' Create a task Of Integer. ' ... Use HandleFileAsync method with a large file. Dim task As Task(Of Integer) = HandleFileAsync("C:\enable1.txt") ' This statement runs while HandleFileAsync executes. Console.WriteLine("Please wait, processing") ' Use await to wait for task to complete. Dim result As Integer = Await task Console.WriteLine("Count: " + result.ToString()) End Sub Async Function HandleFileAsync(ByVal file As String) As Task(Of Integer) Console.WriteLine("HandleFile enter") ' Open the file. Dim count As Integer = 0 Using reader As StreamReader = New StreamReader(file) Dim value As String = Await reader.ReadToEndAsync() count += value.Length ' Do a slow computation on the file. For i = 0 To 10000 Step 1 Dim x = value.GetHashCode() If x = 0 Then count -= 1 End If Next End Using Console.WriteLine("HandleFile exit") Return count End Function End Module
HandleFile enter Please wait, processing
HandleFile enter Please wait, processing HandleFile exit Count: 1916146
Some notes, HandleFileAsync. Please look at HandleFileAsync. This uses a StreamReader to open and read (in an asynchronous way) the specified file.
Note The For-loop in HandleFileAsync is meant to take a long time. This demonstrates the benefit of Async and Await.
Some notes, task. When the Await keyword is encountered, control flow pauses until its Task finishes execution. So the "count" returned from HandleFileAsync is always ready to be printed.
A discussion. What is the benefit to Async and Await in the example program? The message "Please wait, processing" is displayed while the asynchronous task executes.
So Two control flows exist at once. In a real program, another important action could be taken instead of just printing a message.
Tip For the file "enable1.txt," you can substitute any large data file. This is a list of words that is about 2 megabytes.
A review. In the .NET Framework many types like StreamReader and HttpClient have asynchronous features. With Async and Await we exploit these features to improve program responsiveness.
Dot Net Perls is a collection of tested code examples. Pages are continually updated to stay current, with code correctness a top priority.
Sam Allen is passionate about computer languages. In the past, his work has been recommended by Apple and Microsoft and he has studied computers at a selective university in the United States.
This page was last updated on Nov 21, 2023 (edit).
© 2007-2024 Sam Allen.