IAsyncResult.AsyncWaitHandle Eigenschaft

Referenz

Definition

Namespace:: System

Assembly:: System.Runtime.dll

Assembly:: mscorlib.dll

Assembly:: netstandard.dll

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Ruft einen WaitHandle ab, der verwendet wird, um auf den Abschluss eines asynchronen Vorgangs zu warten.

public:
 property System::Threading::WaitHandle ^ AsyncWaitHandle { System::Threading::WaitHandle ^ get(); };

public System.Threading.WaitHandle AsyncWaitHandle { get; }

member this.AsyncWaitHandle : System.Threading.WaitHandle

Public ReadOnly Property AsyncWaitHandle As WaitHandle

Eigenschaftswert

WaitHandle

Ein WaitHandle, der verwendet wird, um auf den Abschluss eines asynchronen Vorgangs zu warten.

Beispiele

Im folgenden Beispiel wird veranschaulicht, wie sie die AsyncWaitHandle Eigenschaft zum Abrufen einer WaitHandleStellvertretung und zum Warten auf einen asynchronen Aufruf einer Stellvertretung verwenden. Das WaitHandle wird bei Beendigung des asynchronen Aufrufs signalisiert, und durch Aufrufen der WaitOne -Methode kann darauf gewartet werden.

Das Beispiel besteht aus zwei Klassen: die Klasse, die die Methode enthält, die asynchron aufgerufen wird, und die Klasse, die die Main Methode enthält, die den Aufruf vornimmt.

Weitere Informationen und weitere Beispiele für Aufrufmethoden asynchron mithilfe von Stellvertretungen finden Sie unter asynchrones Aufrufen synchroner Methoden.

using namespace System;
using namespace System::Threading;
using namespace System::Runtime::InteropServices; 

namespace Examples {
namespace AdvancedProgramming {
namespace AsynchronousOperations
{
    public ref class AsyncDemo 
    {
    public:
        // The method to be executed asynchronously.
        String^ TestMethod(int callDuration, [OutAttribute] int% threadId) 
        {
            Console::WriteLine("Test method begins.");
            Thread::Sleep(callDuration);
            threadId = Thread::CurrentThread->ManagedThreadId;
            return String::Format("My call time was {0}.", callDuration);
        }
    };

    // The delegate must have the same signature as the method
    // it will call asynchronously.
    public delegate String^ AsyncMethodCaller(int callDuration, [OutAttribute] int% threadId);
}}}

using System;
using System.Threading;

namespace Examples.AdvancedProgramming.AsynchronousOperations
{
    public class AsyncDemo
    {
        // The method to be executed asynchronously.
        public string TestMethod(int callDuration, out int threadId)
        {
            Console.WriteLine("Test method begins.");
            Thread.Sleep(callDuration);
            threadId = Thread.CurrentThread.ManagedThreadId;
            return String.Format("My call time was {0}.", callDuration.ToString());
        }
    }
    // The delegate must have the same signature as the method
    // it will call asynchronously.
    public delegate string AsyncMethodCaller(int callDuration, out int threadId);
}

Imports System.Threading
Imports System.Runtime.InteropServices 

Namespace Examples.AdvancedProgramming.AsynchronousOperations
    Public Class AsyncDemo 
        ' The method to be executed asynchronously.
        Public Function TestMethod(ByVal callDuration As Integer, _
                <Out> ByRef threadId As Integer) As String
            Console.WriteLine("Test method begins.")
            Thread.Sleep(callDuration)
            threadId = Thread.CurrentThread.ManagedThreadId()
            return String.Format("My call time was {0}.", callDuration.ToString())
        End Function
    End Class

    ' The delegate must have the same signature as the method
    ' it will call asynchronously.
    Public Delegate Function AsyncMethodCaller(ByVal callDuration As Integer, _
        <Out> ByRef threadId As Integer) As String
End Namespace

#using <TestMethod.dll>

using namespace System;
using namespace System::Threading;
using namespace Examples::AdvancedProgramming::AsynchronousOperations;

void main() 
{
    // The asynchronous method puts the thread id here.
    int threadId;

    // Create an instance of the test class.
    AsyncDemo^ ad = gcnew AsyncDemo();

    // Create the delegate.
    AsyncMethodCaller^ caller = gcnew AsyncMethodCaller(ad, &AsyncDemo::TestMethod);
       
    // Initiate the asychronous call.
    IAsyncResult^ result = caller->BeginInvoke(3000, 
        threadId, nullptr, nullptr);

    Thread::Sleep(0);
    Console::WriteLine("Main thread {0} does some work.",
        Thread::CurrentThread->ManagedThreadId);

    // Wait for the WaitHandle to become signaled.
    result->AsyncWaitHandle->WaitOne();

    // Perform additional processing here.
    // Call EndInvoke to retrieve the results.
    String^ returnValue = caller->EndInvoke(threadId, result);

    // Close the wait handle.
    result->AsyncWaitHandle->Close();

    Console::WriteLine("The call executed on thread {0}, with return value \"{1}\".",
        threadId, returnValue);
}

/* This example produces output similar to the following:

Main thread 1 does some work.
Test method begins.
The call executed on thread 3, with return value "My call time was 3000.".
 */

using System;
using System.Threading;

namespace Examples.AdvancedProgramming.AsynchronousOperations
{
    public class AsyncMain
    {
        static void Main()
        {
            // The asynchronous method puts the thread id here.
            int threadId;

            // Create an instance of the test class.
            AsyncDemo ad = new AsyncDemo();

            // Create the delegate.
            AsyncMethodCaller caller = new AsyncMethodCaller(ad.TestMethod);

            // Initiate the asychronous call.
            IAsyncResult result = caller.BeginInvoke(3000,
                out threadId, null, null);

            Thread.Sleep(0);
            Console.WriteLine("Main thread {0} does some work.",
                Thread.CurrentThread.ManagedThreadId);

            // Wait for the WaitHandle to become signaled.
            result.AsyncWaitHandle.WaitOne();

            // Perform additional processing here.
            // Call EndInvoke to retrieve the results.
            string returnValue = caller.EndInvoke(out threadId, result);

            // Close the wait handle.
            result.AsyncWaitHandle.Close();

            Console.WriteLine("The call executed on thread {0}, with return value \"{1}\".",
                threadId, returnValue);
        }
    }
}

/* This example produces output similar to the following:

Main thread 1 does some work.
Test method begins.
The call executed on thread 3, with return value "My call time was 3000.".
 */

Imports System.Threading
Imports System.Runtime.InteropServices 

Namespace Examples.AdvancedProgramming.AsynchronousOperations

    Public Class AsyncMain 
        Shared Sub Main() 
            ' The asynchronous method puts the thread id here.
            Dim threadId As Integer

            ' Create an instance of the test class.
            Dim ad As New AsyncDemo()

            ' Create the delegate.
            Dim caller As New AsyncMethodCaller(AddressOf ad.TestMethod)
       
            ' Initiate the asynchronous call.
            Dim result As IAsyncResult = caller.BeginInvoke(3000, _
                threadId, Nothing, Nothing)

            Thread.Sleep(0)
            Console.WriteLine("Main thread {0} does some work.", _
                Thread.CurrentThread.ManagedThreadId)
            ' Perform additional processing here and then
            ' wait for the WaitHandle to be signaled.
            result.AsyncWaitHandle.WaitOne()

            ' Call EndInvoke to retrieve the results.
            Dim returnValue As String = caller.EndInvoke(threadId, result)

            ' Close the wait handle.
            result.AsyncWaitHandle.Close()

            Console.WriteLine("The call executed on thread {0}, with return value ""{1}"".", _
                threadId, returnValue)
        End Sub
    End Class
End Namespace

'This example produces output similar to the following:
'
'Main thread 1 does some work.
'Test method begins.
'The call executed on thread 3, with return value "My call time was 3000.".

Hinweise

Mit dem Rückgabewert kann der Client warten, bis ein asynchroner Vorgang abgeschlossen wird, anstatt abfragen zu können IsCompleted , bis der Vorgang beendet wird. Der Rückgabewert kann verwendet werden, um einen , oder WaitAll einen WaitOne WaitAnyVorgang auszuführen.

Die allgemeine Sprachlaufzeit liefert eine Reihe von abwartbaren Objekten, z ManualResetEvent. B. , AutoResetEventund Mutexalle, die Win32-Synchronisierungsgrundtypen spiegeln.

Hinweise für Ausführende

Das implementierte IAsyncResult Objekt muss erst erstellt WaitHandle werden, wenn die AsyncWaitHandle Eigenschaft gelesen wird. Es ist die Wahl des IAsyncResult Implementierungers. Wenn der Implementierunger jedoch erstellt AsyncWaitHandle, ist es die Verantwortung des Implementierungers, dies zu signalisieren WaitHandle , dass die Wartezeit zu dem entsprechenden Zeitpunkt beendet wird. Beendet beispielsweise die Wartezeit im Namen des Aufrufers, AsyncResult wenn eine asynchron aufgerufene Methode zurückgegeben wird. Sobald sie erstellt wurde, sollte lebendig gehalten werden, bis der Benutzer die Methode aufruft, AsyncWaitHandle die den asynchronen Vorgang beendet. Zu diesem Zeitpunkt kann das Objektbehind AsyncWaitHandle verworfen werden.

Hinweise für Aufrufer

Clients, die warten, bis der Vorgang abgeschlossen ist (im Gegensatz zur Abfrage), verwenden diese Eigenschaft, um ein Synchronisierungsobjekt abzurufen, auf das gewartet wird.

Hinweis: Wenn Sie die BeginInvoke Methode eines Delegaten verwenden, um eine Methode asynchron aufzurufen und einen Wartepunkt aus dem resultierenden IAsyncResultAbzurufen, empfehlen wir, den Wartepunkt zu schließen, sobald Sie mit der Verwendung fertig sind, indem Sie die Close() Methode aufrufen. Wenn Sie einfach alle Verweise auf den Wartepunkt freigeben, werden Systemressourcen freigegeben, wenn die Garbage Collection den Wartepunkt zurückgibt, die Garbage Collection jedoch effizienter funktioniert, wenn einwegbare Objekte explizit geschlossen oder verworfen werden. Weitere Informationen finden Sie in den Ausführungen zur AsyncWaitHandle-Eigenschaft.

Gilt für