Async (Visual Basic)

  • Artículo

El modificador Async indica que el método o la expresión lambda que modifica son asincrónicos. Estos métodos se conocen como métodos asincrónicos.

Un método asincrónico proporciona una manera cómoda de hacer el trabajo de larga duración sin bloquear el subproceso del llamador. El llamador de un método asincrónico puede reanudar el trabajo sin esperar a que el método asincrónico finalice.

Nota

Las palabras clave Async y Await se incluyeron en Visual Studio 2012. Para una introducción a la programación asincrónica, consulte Programación asincrónica con Async y Await.

En el siguiente ejemplo se muestra la estructura de un método asincrónico. Por convención, los nombres de método asincrónico acaban en “Async”.

Public Async Function ExampleMethodAsync() As Task(Of Integer)
    ' . . .

    ' At the Await expression, execution in this method is suspended and,
    ' if AwaitedProcessAsync has not already finished, control returns
    ' to the caller of ExampleMethodAsync. When the awaited task is
    ' completed, this method resumes execution.
    Dim exampleInt As Integer = Await AwaitedProcessAsync()

    ' . . .

    ' The return statement completes the task. Any method that is
    ' awaiting ExampleMethodAsync can now get the integer result.
    Return exampleInt
End Function

Por lo general, un método que la palabra clave Async modifica contiene al menos una instrucción o expresión Await. El método se ejecuta sincrónicamente hasta alcanzar el primer Await, punto en el que se suspende hasta que la tarea en espera se complete. Mientras tanto, se devuelve el control al llamador del método asincrónico. Si el método no contiene una instrucción o expresión Await, el método no se suspende y se ejecuta como un método sincrónico. Una advertencia del compilador alerta de cualquier método asincrónico que no contenga Await, porque esa situación podría indicar un error. Para más información, consulte el error del compilador.

La palabra clave Async no está reservada. Es una palabra clave cuando modifica un método o una expresión lambda. En todos los demás contextos, se interpreta como identificador.

Tipos de valor devuelto

Un método asincrónico es un procedimiento Sub o un procedimiento Function que tiene un tipo de valor devuelto de Task o Task<TResult>. El método no puede declarar ningún parámetro ByRef.

Se puede especificar Task(Of TResult) para el tipo de valor devuelto de un método asincrónico si la instrucción Return del método contiene un operando de tipo TResult. Utilice Task si no se devuelve ningún valor significativo al completarse el método. Es decir, una llamada al método devuelve Task, pero cuando se completa Task, ninguna instrucción Await que está en espera de Task no genera un valor de resultado.

Las subrutinas asincrónicas se utilizan principalmente para definir controladores de eventos donde se requiere un procedimiento Sub. El llamador de una subrutina asincrónica no puede esperar a que finalice y no puede detectar las excepciones que el método inicia.

Para más información y ejemplos, vea Tipos de valor devueltos asincrónicos.

Ejemplo

Los ejemplos siguientes muestran un controlador de eventos asincrónicos, una expresión lambda asincrónica y un método asincrónico. Para un ejemplo completo que usa estos elementos, consulte Tutorial: Acceso a la Web con Async y Await. Puede descargar el ejemplo desde el explorador de ejemplos de .NET. El código de ejemplo está en el proyecto SerialAsyncExample.

' An event handler must be a Sub procedure.
Async Sub button1_Click(sender As Object, e As RoutedEventArgs) Handles button1.Click
    textBox1.Clear()
    ' SumPageSizesAsync is a method that returns a Task.
    Await SumPageSizesAsync()
    textBox1.Text = vbCrLf & "Control returned to button1_Click."
End Sub

' The following async lambda expression creates an equivalent anonymous
' event handler.
AddHandler button1.Click, Async Sub(sender, e)
                              textBox1.Clear()
                              ' SumPageSizesAsync is a method that returns a Task.
                              Await SumPageSizesAsync()
                              textBox1.Text = vbCrLf & "Control returned to button1_Click."
                          End Sub

' The following async method returns a Task(Of T).
' A typical call awaits the Byte array result:
'      Dim result As Byte() = Await GetURLContents("https://msdn.com")
Private Async Function GetURLContentsAsync(url As String) As Task(Of Byte())

    ' The downloaded resource ends up in the variable named content.
    Dim content = New MemoryStream()

    ' Initialize an HttpWebRequest for the current URL.
    Dim webReq = CType(WebRequest.Create(url), HttpWebRequest)

    ' Send the request to the Internet resource and wait for
    ' the response.
    Using response As WebResponse = Await webReq.GetResponseAsync()
        ' Get the data stream that is associated with the specified URL.
        Using responseStream As Stream = response.GetResponseStream()
            ' Read the bytes in responseStream and copy them to content.
            ' CopyToAsync returns a Task, not a Task<T>.
            Await responseStream.CopyToAsync(content)
        End Using
    End Using

    ' Return the result as a byte array.
    Return content.ToArray()
End Function

Consulte también