Condividi tramite


IAsyncResult.AsyncWaitHandle Proprietà

Definizione

Ottiene un oggetto WaitHandle che viene usato per attendere il completamento di un'operazione asincrona.

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

Valore della proprietà

WaitHandle

Oggetto WaitHandle che viene usato per attendere il completamento di un'operazione asincrona.

Esempio

Nell'esempio seguente viene illustrato come usare la AsyncWaitHandle proprietà per ottenere un WaitHandleoggetto e come attendere una chiamata asincrona su un delegato. L'oggetto WaitHandle viene segnalato al completamento della chiamata asincrona ed è possibile attenderlo chiamando il metodo WaitOne .

L'esempio è costituito da due classi: la classe che contiene il metodo chiamato in modo asincrono e la classe che contiene il Main metodo che effettua la chiamata.

Per altre informazioni e altri esempi di chiamata asincrona dei metodi tramite delegati, vedere Chiamata asincrona di metodi sincroni.

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

Commenti

Il valore restituito consente al client di attendere il completamento di un'operazione asincrona anziché il polling IsCompleted fino al termine dell'operazione. Il valore restituito può essere usato per eseguire un'operazione WaitOne, WaitAnyo WaitAll .

Common Language Runtime fornisce una serie di oggetti waitable, ad esempio ManualResetEvent, AutoResetEvente Mutex, tutti i quali esegue il mirroring delle primitive di sincronizzazione Win32.

Note per gli implementatori

L'oggetto che implementa IAsyncResult non deve creare finché WaitHandle la AsyncWaitHandle proprietà non viene letta. È la scelta dell'implementatore IAsyncResult . Tuttavia, se l'implementatore crea AsyncWaitHandle, è responsabilità dell'implementatore segnalare WaitHandle che terminerà l'attesa al momento appropriato. Ad esempio, AsyncResult termina l'attesa per conto del chiamante quando viene restituito un metodo richiamato in modo asincrono. Dopo la creazione, AsyncWaitHandle deve essere mantenuto attivo finché l'utente non chiama il metodo che conclude l'operazione asincrona. In quel momento l'oggetto sottostante AsyncWaitHandle può essere rimosso.

Note per i chiamanti

I client che attendono il completamento dell'operazione (anziché il polling) usano questa proprietà per ottenere un oggetto di sincronizzazione da attendere.

Nota: quando si usa il BeginInvoke metodo di un delegato per chiamare un metodo in modo asincrono e ottenere un handle di attesa dall'oggetto risultante IAsyncResult, è consigliabile chiudere l'handle di attesa al termine dell'utilizzo, chiamando il Close() metodo . Se si rilasciano semplicemente tutti i riferimenti all'handle di attesa, le risorse di sistema vengono liberate quando Garbage Collection recupera l'handle di attesa, ma Garbage Collection funziona in modo più efficiente quando gli oggetti eliminabili vengono chiusi o eliminati in modo esplicito. Per altre informazioni, vedere la proprietà AsyncWaitHandle.

Si applica a