IAsyncResult.AsyncWaitHandle Vlastnost

Definice

Obor názvů:

System

Sestavení:

netstandard.dll, System.Runtime.dll

Zdroj:

IAsyncResult.cs

WaitHandle Získá, který se používá k čekání na dokončení asynchronní operace.

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

Hodnota vlastnosti

WaitHandle

Slouží WaitHandle k čekání na dokončení asynchronní operace.

Příklady

Následující příklad ukazuje, jak pomocí AsyncWaitHandle vlastnosti získat WaitHandlea jak čekat na asynchronní volání delegáta. Signál WaitHandle je signalován, když se asynchronní volání dokončí a můžete na něj počkat voláním WaitOne metody.

Příklad se skládá ze dvou tříd: třída, která obsahuje metodu, která je volána asynchronně, a třída, která obsahuje metodu Main , která provádí volání.

Další informace a další příklady volání metod asynchronně pomocí delegátů naleznete v tématu Volání synchronních metod asynchronně.

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

Poznámky

Návratová hodnota umožňuje klientovi čekat na dokončení asynchronní operace místo dotazování IsCompleted , dokud operace nekončí. Návratovou hodnotu lze použít k provedení WaitOneoperace , WaitAnynebo WaitAll operace.

Modul CLR (Common Language Runtime) poskytuje řadu čekaných objektů, například ManualResetEvent, AutoResetEventa Mutex, z nichž všechny zrcadlí primitiv synchronizace Win32.

Poznámky pro implementátory

Objekt, který implementuje IAsyncResult , nemusí vytvořit WaitHandle , dokud AsyncWaitHandle se vlastnost nečte. Je to volba implementátoru IAsyncResult . Pokud však implementátor vytvoří AsyncWaitHandle, je odpovědností implementátora signalizovat WaitHandle , že ukončí čekání v příslušné době. Například AsyncResult ukončí čekání jménem volajícího, když asynchronně vyvolaná metoda vrátí. Po vytvoření by se mělo udržovat naživu, AsyncWaitHandle dokud uživatel nevolá metodu, která ukončí asynchronní operaci. V té době může být objekt zahozen AsyncWaitHandle .

Poznámky pro volající

Klienti, kteří čekají na dokončení operace (na rozdíl od dotazování), používají tuto vlastnost k získání objektu synchronizace, na který má čekat.

Poznámka: Pokud použijete BeginInvoke metodu delegáta k asynchronnímu volání metody a získání popisovače čekání z výsledného IAsyncResult, doporučujeme zavřít popisovač čekání, jakmile ho dokončíte, voláním Close() metody. Pokud jednoduše uvolníte všechny odkazy na popisovač čekání, systémové prostředky se uvolní, když uvolňování paměti uvolní čekací úchyt, ale uvolňování paměti funguje efektivněji, když jsou uvolnitelné objekty explicitně uzavřeny nebo uvolněny. Další informace najdete ve vlastnosti AsyncWaitHandle.