IAsyncResult IAsyncResult IAsyncResult IAsyncResult Interface

定義

非同期操作のステータスを表します。Represents the status of an asynchronous operation.

public interface class IAsyncResult
[System.Runtime.InteropServices.ComVisible(true)]
public interface IAsyncResult
type IAsyncResult = interface
Public Interface IAsyncResult
派生
属性

次の例は、 AsyncWaitHandleプロパティを使用してをWaitHandle取得する方法と、デリゲートに対する非同期呼び出しを待機する方法を示しています。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. WaitHandle は非同期呼び出しが完了すると通知され、 WaitOne メソッドを呼び出すことによってこれを待機できます。The WaitHandle is signaled when the asynchronous call completes, and you can wait for it by calling the WaitOne method.

この例は、2つのクラス (非同期に呼び出されるメソッドを含むクラスと、呼び出しを行うMainメソッドを含むクラス) で構成されています。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.

デリゲートを使用した非同期メソッドの呼び出しの詳細と例については、「同期メソッドの非同期呼び出し」を参照してください。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
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
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.".

注釈

インターフェイスIAsyncResultは、非同期的に動作できるメソッドを含むクラスによって実装されます。The IAsyncResult interface is implemented by classes containing methods that can operate asynchronously. これはFileStream.BeginRead、などの非同期操作を開始するメソッドの戻り値の型でFileStream.EndReadあり、などの非同期操作を終了するメソッドに渡されます。It is the return type of methods that initiate an asynchronous operation, such as FileStream.BeginRead, and it is passed to methods that conclude an asynchronous operation, such as FileStream.EndRead. IAsyncResultオブジェクトは、非同期操作の完了時AsyncCallbackにデリゲートによって呼び出されたメソッドにも渡されます。IAsyncResult objects are also passed to methods invoked by AsyncCallback delegates when an asynchronous operation completes.

IAsyncResultインターフェイスをサポートするオブジェクトは、非同期操作の状態情報を格納し、同期オブジェクトを提供して、操作の完了時にスレッドが通知されるようにします。An object that supports the IAsyncResult interface stores state information for an asynchronous operation and provides a synchronization object to allow threads to be signaled when the operation completes.

注意

クラスは、デリゲートを使用IAsyncResultしてメソッドを非同期BeginInvoke的に呼び出すときに、メソッドによって返されるの実装です。 AsyncResultThe AsyncResult class is the implementation of IAsyncResult that is returned by the BeginInvoke method when you use a delegate to call a method asynchronously.

IAsyncResultインターフェイスの使用方法の詳細については、「同期メソッドの非同期呼び出し」を参照してください。For a detailed description of how the IAsyncResult interface is used, see the Calling Synchronous Methods Asynchronously topic.

プロパティ

AsyncState AsyncState AsyncState AsyncState

非同期操作についての情報を限定または格納するユーザー定義のオブジェクトを取得します。Gets a user-defined object that qualifies or contains information about an asynchronous operation.

AsyncWaitHandle AsyncWaitHandle AsyncWaitHandle AsyncWaitHandle

非同期操作が完了するまで待機するために使用する WaitHandle を取得します。Gets a WaitHandle that is used to wait for an asynchronous operation to complete.

CompletedSynchronously CompletedSynchronously CompletedSynchronously CompletedSynchronously

非同期操作が同期的に完了したかどうかを示す値を取得します。Gets a value that indicates whether the asynchronous operation completed synchronously.

IsCompleted IsCompleted IsCompleted IsCompleted

非同期操作が完了したかどうかを示す値を取得します。Gets a value that indicates whether the asynchronous operation has completed.

適用対象