IAsyncResult.AsyncWaitHandle Egenskap

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

Egenskapsvärde

En WaitHandle som används för att vänta tills en asynkron åtgärd har slutförts.

Exempel

I följande exempel visas hur du använder AsyncWaitHandle egenskapen för att få ett WaitHandle, och hur du väntar på ett asynkront anrop på ett ombud. WaitHandle Signaleras när det asynkrona anropet slutförs och du kan vänta på det genom att anropa WaitOne metoden.

Exemplet består av två klasser: klassen som innehåller metoden som kallas asynkront och klassen som innehåller metoden Main som gör anropet.

Mer information och fler exempel på att anropa metoder asynkront med hjälp av ombud finns i Anropa synkrona metoder asynkront.

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

Kommentarer

Med returvärdet kan klienten vänta tills en asynkron åtgärd har slutförts i stället för att avsökas IsCompleted tills åtgärden har slutförts. Returvärdet kan användas för att utföra en WaitOneåtgärd , WaitAnyeller WaitAll .

Den vanliga språkkörningen tillhandahåller ett antal väntebara objekt, till exempel ManualResetEvent, AutoResetEventoch Mutex, som alla speglar Win32-synkroniseringsprimärer.

Anteckningar till implementerare

Objektet som implementerar IAsyncResult behöver inte skapa WaitHandle förrän egenskapen AsyncWaitHandle har lästs. Det är implementatorns IAsyncResult val. Men om implementeraren skapar AsyncWaitHandleär det implementerarens ansvar att signalera WaitHandle att väntetiden avslutas vid lämplig tidpunkt. Till AsyncResult exempel avslutar väntan för anroparen när en asynkront anropad metod returnerar. När den har skapats AsyncWaitHandle bör den hållas vid liv tills användaren anropar metoden som avslutar den asynkrona åtgärden. Då kan objektet bakom AsyncWaitHandle ignoreras.

Anteckningar till anropare

Klienter som väntar på att åtgärden ska slutföras (i stället för avsökning) använder den här egenskapen för att hämta ett synkroniseringsobjekt att vänta på.

Obs! När du använder BeginInvoke metoden för ett ombud för att anropa en metod asynkront och hämta ett väntehandtag från den resulterande IAsyncResultrekommenderar vi att du stänger väntehandtaget så snart du är klar med den genom att anropa Close() metoden. Om du helt enkelt släpper alla referenser till väntehandtaget frigörs systemresurser när skräpinsamlingen återtar väntehandtaget, men skräpinsamlingen fungerar effektivare när engångsobjekt uttryckligen stängs eller tas bort. För mer information, se egenskapen AsyncWaitHandle.