IAsyncResult.AsyncWaitHandle Vlastnost

Definice

Obor názvů:

System

Sestavení:

System.Runtime.dll

Sestavení:

mscorlib.dll

Sestavení:

netstandard.dll

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 použít AsyncWaitHandle vlastnost získat WaitHandlea jak počkat na asynchronní volání delegáta. Signalizují WaitHandle se, 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řídy, která obsahuje metodu, která se volá asynchronně, a třídy, která obsahuje metodu Main , která volání provádí.

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

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

Poznámky

Vrácená hodnota umožňuje klientovi počkat na dokončení asynchronní operace, a ne IsCompleted dotazování, 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ů, jako ManualResetEventjsou například , AutoResetEventa Mutexvšechny z nichž zrcadlí primitivy synchronizace Win32.

Poznámky pro implementátory

Objekt, který implementuje IAsyncResult , nemusí vytvořit WaitHandle , dokud se AsyncWaitHandle vlastnost nepřečte. Je to volba implementátoru IAsyncResult . Pokud však implementátor vytvoří AsyncWaitHandle, je zodpovědností implementátora, aby signalizoval WaitHandle , že se ukončí čekání v příslušné době. Například ukončí čekání jménem volajícího, AsyncResult když se asynchronně vyvoláná metoda vrátí. Po vytvoření by se měl udržovat naživu, AsyncWaitHandle dokud uživatel nevolá metodu, která dokončí asynchronní operaci. V té době lze objekt za AsyncWaitHandle sebou zahodit.

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í synchronizačního objektu, na který bude č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 Close() dokončíte, zavoláním 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í úchyt čekání, ale uvolňování paměti funguje efektivněji, když jsou jednorázové objekty explicitně uzavřeny nebo odstraněny. Další informace najdete v AsyncWaitHandle této vlastnosti.