IAsyncResult.AsyncWaitHandle Właściwość

Definicja

Przestrzeń nazw:

System

Zestaw:

System.Runtime.dll

Zestaw:

mscorlib.dll

Zestaw:

netstandard.dll

Pobiera element WaitHandle służący do oczekiwania na zakończenie operacji asynchronicznej.

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

Wartość właściwości

WaitHandle

Element WaitHandle służący do oczekiwania na zakończenie operacji asynchronicznej.

Przykłady

W poniższym przykładzie pokazano, jak za pomocą AsyncWaitHandle właściwości uzyskać WaitHandleobiekt i jak czekać na asynchroniczne wywołanie delegata. Element WaitHandle jest sygnalizowany po zakończeniu wywołania asynchronicznego i można poczekać, wywołując metodę WaitOne .

Przykład składa się z dwóch klas: klasy, która zawiera metodę wywoływaną asynchronicznie, oraz klasę zawierającą Main metodę, która wykonuje wywołanie.

Aby uzyskać więcej informacji i więcej przykładów asynchronicznego wywoływania metod przy użyciu delegatów, zobacz Wywoływanie metod synchronicznych asynchronicznie.

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.".

Uwagi

Wartość zwracana umożliwia klientowi oczekiwanie na zakończenie operacji asynchronicznej zamiast sondowania IsCompleted do momentu zakończenia operacji. Wartość zwracana może służyć do wykonywania WaitOneoperacji , WaitAnylub WaitAll .

Środowisko uruchomieniowe języka wspólnego dostarcza wiele obiektów oczekujących, takich jak ManualResetEvent, AutoResetEventi Mutex, z których wszystkie są dublowaniem elementów pierwotnych synchronizacji Win32.

Uwagi dotyczące implementowania

Obiekt, który implementuje IAsyncResult , nie musi tworzyć WaitHandle obiektu , dopóki AsyncWaitHandle właściwość nie zostanie odczytany. Jest to wybór implementatora IAsyncResult . Jeśli jednak implementator tworzy AsyncWaitHandleelement , obowiązkiem implementatora jest sygnalizator WaitHandle , który zakończy oczekiwanie w odpowiednim czasie. Na przykład przerywa oczekiwanie w imieniu obiektu wywołującego, AsyncResult gdy metoda wywołana asynchronicznie zwraca. Po utworzeniu należy zachować przy życiu, AsyncWaitHandle dopóki użytkownik nie wywoła metody, która kończy operację asynchroniczną. W tym czasie obiekt znajdujący się za AsyncWaitHandle nim można odrzucić.

Uwagi dotyczące wywoływania

Klienci, którzy oczekują na zakończenie operacji (w przeciwieństwie do sondowania), używają tej właściwości do uzyskania obiektu synchronizacji do oczekiwania.

Uwaga: W przypadku użycia metody delegata BeginInvoke do asynchronicznego wywołania metody i uzyskania uchwytu oczekiwania z wynikowego IAsyncResultpolecenia zalecamy zamknięcie uchwytu oczekiwania, gdy tylko skończysz go używać, wywołując metodę Close() . Jeśli po prostu zwolnisz wszystkie odwołania do dojścia oczekiwania, zasoby systemowe zostaną zwolnione, gdy odzyskiwanie pamięci odzyskuje uchwyt oczekiwania, ale odzyskiwanie pamięci działa wydajniej, gdy jednorazowe obiekty są jawnie zamknięte lub usuwane. Aby uzyskać więcej informacji, zobacz AsyncWaitHandle właściwość .