AsyncStateMachineAttribute Klasse

Definition

Namespace:

System.Runtime.CompilerServices

Assembly:

System.Runtime.dll

Quelle:

AsyncStateMachineAttribute.cs

Gibt an, ob eine Methode entweder mit dem Async- oder dem async-Modifizierer gekennzeichnet ist.

public ref class AsyncStateMachineAttribute sealed : System::Runtime::CompilerServices::StateMachineAttribute

[System.AttributeUsage(System.AttributeTargets.Method, AllowMultiple=false, Inherited=false)]
public sealed class AsyncStateMachineAttribute : System.Runtime.CompilerServices.StateMachineAttribute

[<System.AttributeUsage(System.AttributeTargets.Method, AllowMultiple=false, Inherited=false)>]
type AsyncStateMachineAttribute = class
    inherit StateMachineAttribute

Public NotInheritable Class AsyncStateMachineAttribute
Inherits StateMachineAttribute

Vererbung

Object

Attribute

StateMachineAttribute

AsyncStateMachineAttribute

Attribute

AttributeUsageAttribute

Beispiele

Wie im folgenden Beispiel gezeigt, können Sie bestimmen, ob eine Methode mit Async - oder async-Modifizierern gekennzeichnet ist. Führen Sie im Beispiel IsAsyncMethod die folgenden Schritte aus:

• Ruft mithilfe von Type.GetMethodein MethodInfo -Objekt für den Methodennamen ab.

• Ruft mithilfe des GetType-Operators oder des Typs typeof ein Type -Objekt für das Attribut ab.

• Ruft mithilfe von MethodInfo.GetCustomAttributeein Attributobjekt für die Methode und den Attributtyp ab. Wenn GetCustomAttribute (Visual Basic) oder null (C#) zurückgegeben wird Nothing , enthält die -Methode das -Attribut nicht.

using System;
using System.Collections.Generic;
using System.Reflection;
using System.Threading.Tasks;
using System.Runtime.CompilerServices;

namespace ConsoleApplication1
{

    // This class is used by the code below to discover method attributes.
    public class TheClass
    {
        public async Task<int> AsyncMethod()
        {
            await Task.Delay(5);
            return 1;
        }

        public int RegularMethod()
        {
            return 0;
        }
    }

    class Program
    {
        private static bool IsAsyncMethod(Type classType, string methodName)
        {
            // Obtain the method with the specified name.
            MethodInfo method = classType.GetMethod(methodName);

            Type attType = typeof(AsyncStateMachineAttribute);

            // Obtain the custom attribute for the method.
            // The value returned contains the StateMachineType property.
            // Null is returned if the attribute isn't present for the method.
            var attrib = (AsyncStateMachineAttribute)method.GetCustomAttribute(attType);

            return (attrib != null);
        }

        private static void ShowResult(Type classType, string methodName)
        {
            Console.Write((methodName + ": ").PadRight(16));

            if (IsAsyncMethod(classType, methodName))
                Console.WriteLine("Async method");
            else
                Console.WriteLine("Regular method");
        }

        static void Main(string[] args)
        {
            ShowResult(classType: typeof(TheClass), methodName: "AsyncMethod");
            ShowResult(classType: typeof(TheClass), methodName: "RegularMethod");

            // Note: The IteratorStateMachineAttribute applies to Visual Basic methods
            // but not C# methods.

            Console.ReadKey();
        }

        // Output:
        //   AsyncMethod:    Async method
        //   RegularMethod:  Regular method
    }
}

Imports System.Collections.Generic
Imports System.Reflection
Imports System.Threading.Tasks
Imports System.Runtime.CompilerServices


Module Module1

    ' This class is used by the code below to discover method attributes.
    Public Class TheClass
        Public Async Function AsyncMethod() As Task(Of Integer)
            Await Task.Delay(5)
            Return 1
        End Function

        Public Iterator Function IteratorMethod() As IEnumerable(Of Integer)
            Yield 1
            Yield 2
        End Function

        Public Function RegularMethod() As Integer
            Return 0
        End Function
    End Class


    Private Function IsAsyncMethod(classType As Type, methodName As String)
        ' Obtain the method with the specified name.
        Dim method As MethodInfo = classType.GetMethod(methodName)

        Dim attType As Type = GetType(AsyncStateMachineAttribute)

        Dim attrib = CType(method.GetCustomAttribute(attType), AsyncStateMachineAttribute)
        ' The above variable contains the StateMachineType property.

        Return (attrib IsNot Nothing)
    End Function

    Private Function IsIteratorMethod(classType As Type, methodName As String)
        ' Obtain the method with the specified name.
        Dim method As MethodInfo = classType.GetMethod(methodName)

        Dim attType As Type = GetType(IteratorStateMachineAttribute)

        ' Obtain the custom attribute for the method.
        ' The value returned contains the StateMachineType property.
        ' Nothing is returned if the attribute isn't present for the method.
        Dim attrib = CType(method.GetCustomAttribute(attType), IteratorStateMachineAttribute)

        Return (attrib IsNot Nothing)
    End Function

    Private Sub ShowResult(classType As Type, methodName As String)
        Console.Write((methodName & ": ").PadRight(16))

        If IsAsyncMethod(classType, methodName) Then
            Console.WriteLine("Async method")
        ElseIf IsIteratorMethod(classType, methodName) Then
            Console.WriteLine("Iterator method")
        Else
            Console.WriteLine("Regular method")
        End If

        ' Note: The IteratorStateMachineAttribute applies to Visual Basic methods
        ' but not C# methods.
    End Sub

    Sub Main()
        ShowResult(GetType(TheClass), "AsyncMethod")
        ShowResult(GetType(TheClass), "IteratorMethod")
        ShowResult(GetType(TheClass), "RegularMethod")

        Console.ReadKey()
    End Sub

    '   AsyncMethod:    Async method
    '   IteratorMethod: Iterator method
    '   RegularMethod:  Regular method

End Module

Hinweise

Sie sollten das AsyncStateMachine Attribut nicht auf Methoden im Code anwenden. Für Methoden, die über den asynchronen Modifizierer verfügen, wendet der Compiler das AsyncStateMachine Attribut in der IL an, das der Compiler ausgibt.

Wenn eine Methode (MethodName) über den Async- oder async-Modifizierer verfügt, gibt der Compiler eine IL aus, die eine Zustandscomputerstruktur enthält. Diese Struktur enthält den Code in der -Methode. Diese IL enthält auch eine Stubmethode (MethodName), die den Zustandscomputer aufruft. Der Compiler fügt das AsyncStateMachine Attribut der Stubmethode hinzu, damit Tools den entsprechenden Zustandscomputer identifizieren können. Details zur ausgegebenen IL können sich in zukünftigen Versionen der Compiler ändern.

Informationen zum Async-Feature finden Sie unter Asynchrone Programmierung (C#) oder Asynchrone Programmierung mit Async und Await (Visual Basic).

Konstruktoren

AsyncStateMachineAttribute(Type)

Initialisiert eine neue Instanz der AsyncStateMachineAttribute-Klasse.

Eigenschaften

StateMachineType	Gibt das Typobjekt für den zugrunde liegenden Zustandsautomaten zurück, der vom Compiler generiert wurde, um die Zustandsautomat-Methode zu implementieren. (Geerbt von StateMachineAttribute)
TypeId	Ruft bei Implementierung in einer abgeleiteten Klasse einen eindeutigen Bezeichner für dieses Attribute ab. (Geerbt von Attribute)

Methoden

Equals(Object)	Gibt einen Wert zurück, der angibt, ob diese Instanz gleich einem angegebenen Objekt ist. (Geerbt von Attribute)
GetHashCode()	Gibt den Hashcode für diese Instanz zurück. (Geerbt von Attribute)
GetType()	Ruft den Type der aktuellen Instanz ab. (Geerbt von Object)
IsDefaultAttribute()	Gibt beim Überschreiben in einer abgeleiteten Klasse an, ob der Wert der Instanz der Standardwert für die abgeleitete Klasse ist. (Geerbt von Attribute)
Match(Object)	Beim Überschreiben in einer abgeleiteten Klasse wird ein Wert zurückgegeben, der angibt, ob diese Instanz einem bestimmten Objekt entspricht. (Geerbt von Attribute)
MemberwiseClone()	Erstellt eine flache Kopie des aktuellen Object. (Geerbt von Object)
ToString()	Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Geerbt von Object)

Weitere Informationen

• IteratorStateMachineAttribute
• StateMachineType