IAsyncResult.AsyncWaitHandle Właściwość

Definicja

Pobiera WaitHandle , który jest używany do oczekiwania na zakończenie operacji asynchronicznej.Gets a WaitHandle that is used to wait for an asynchronous operation to complete.

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

WaitHandle, Który jest używany do oczekiwania na zakończenie operacji asynchronicznej.A WaitHandle that is used to wait for an asynchronous operation to complete.

Przykłady

W poniższym przykładzie pokazano, jak użyć AsyncWaitHandle właściwości w celu uzyskania WaitHandle i jak czekać na wywołanie asynchroniczne na delegatze.The following example demonstrates how to use the AsyncWaitHandle property to get a WaitHandle, and how to wait for an asynchronous call on a delegate. WaitHandleJest sygnalizowane sygnałem, gdy wywołanie asynchroniczne zostanie zakończone, i można go oczekiwać przez wywołanie WaitOne metody.The WaitHandle is signaled when the asynchronous call completes, and you can wait for it by calling the WaitOne method.

Przykład składa się z dwóch klas: klasy zawierającej metodę, która jest wywoływana asynchronicznie, oraz klasy zawierającej Main metodę, która wywołuje wywołanie.The example consists of two classes: the class that contains the method that is called asynchronously, and the class that contains the Main method that makes the call.

Aby uzyskać więcej informacji i więcej przykładów wywoływania metod asynchronicznie za pomocą delegatów, zobacz Asynchroniczne wywoływanie metod synchronicznych.For more information and more examples of calling methods asynchronously by using delegates, see Calling Synchronous Methods Asynchronously.

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.The return value allows the client to wait for an asynchronous operation to complete instead of polling IsCompleted until the operation concludes. Wartość zwracana może służyć do wykonywania WaitOne WaitAny operacji, lub WaitAll .The return value can be used to perform a WaitOne, WaitAny, or WaitAll operation.

Środowisko uruchomieniowe języka wspólnego udostępnia wiele obiektów oczekujących, takich jak ManualResetEvent , AutoResetEvent , i Mutex wszystkich duplikatów elementów pierwotnych synchronizacji Win32.The common language runtime supplies a number of waitable objects, such as ManualResetEvent, AutoResetEvent, and Mutex, all of which mirror Win32 synchronization primitives.

Uwagi dotyczące implementowania

Obiekt, który implementuje, nie IAsyncResult musi tworzyć do WaitHandle momentu AsyncWaitHandle odczytania właściwości.The object that implements IAsyncResult does not need to create the WaitHandle until the AsyncWaitHandle property is read. Jest to wybór IAsyncResult implementujący.It is the choice of the IAsyncResult implementer. Jeśli jednak program implementujący tworzy AsyncWaitHandle , jest odpowiedzialny za program implementujący, WaitHandle który zakończy oczekiwanie w odpowiednim czasie.However, if the implementer creates AsyncWaitHandle, it is the responsibility of the implementer to signal the WaitHandle that will terminate the wait at the appropriate time. Na przykład AsyncResult kończy oczekiwanie na rzecz obiektu wywołującego, gdy wywoływana asynchronicznie Metoda zwraca.For example, AsyncResult terminates the wait on behalf of the caller when an asynchronously invoked method returns. Po utworzeniu AsyncWaitHandle należy zachować aktywność, dopóki użytkownik nie wywoła metody kończącej operację asynchroniczną.Once created, AsyncWaitHandle should be kept alive until the user calls the method that concludes the asynchronous operation. W tym czasie obiekt za AsyncWaitHandle można odrzucić.At that time the object behind AsyncWaitHandle can be discarded.

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, aby uzyskać obiekt synchronizacji, aby oczekiwać.Clients that wait for the operation to complete (as opposed to polling) use this property to obtain a synchronization object to wait on.


W przypadku użycia BeginInvoke metody delegata do wywołania metody asynchronicznie i uzyskania dojścia oczekiwania od wyniku IAsyncResult , zalecamy zamknięcie dojścia oczekiwania zaraz po zakończeniu korzystania z niego, wywołując Close() metodę.When you use the BeginInvoke method of a delegate to call a method asynchronously and obtain a wait handle from the resulting IAsyncResult, we recommend that you close the wait handle as soon as you are finished using it, by calling the Close() method. Po prostu zwolnij wszystkie odwołania do dojścia oczekiwania, zasoby systemowe są zwalniane, gdy odzyskiwanie pamięci zostanie odzyskane dla dojścia oczekiwania, ale odzyskiwanie pamięci działa wydajniej, gdy bezpośrednie zamknięcia lub usunięcia obiektów do pobrania.If you simply release all references to the wait handle, system resources are freed when garbage collection reclaims the wait handle, but garbage collection works more efficiently when disposable objects are explicitly closed or disposed. Aby uzyskać więcej informacji, zobacz AsyncWaitHandle Właściwość.For more information, see the AsyncWaitHandle property.

Dotyczy