IAsyncResult Интерфейс

Определение

Пространство имен:

System

Сборки:

netstandard.dll, System.Runtime.dll

Исходный код:

IAsyncResult.cs

Представляет состояние асинхронной операции.

public interface class IAsyncResult

public interface IAsyncResult

type IAsyncResult = interface

Public Interface IAsyncResult

Производный

System.IdentityModel.AsyncResult

System.IdentityModel.Selectors.SecurityTokenProvider.SecurityTokenAsyncResult

System.Runtime.Remoting.Messaging.AsyncResult

System.Threading.Tasks.Task

System.Transactions.CommittableTransaction

System.Web.Services.Protocols.WebClientAsyncResult

Примеры

В следующем примере показано, как использовать AsyncWaitHandle свойство для получения WaitHandleи ожидания асинхронного вызова делегата. Объект WaitHandle получает сигнал после завершения асинхронного вызова; его можно дождаться путем вызова метода WaitOne .

Пример состоит из двух классов: класса, содержащего метод, который вызывается асинхронно, и класс, содержащий Main метод, который выполняет вызов.

Дополнительные сведения и дополнительные примеры методов вызова асинхронно с помощью делегатов см. в статье " Асинхронные методы вызова".

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

Комментарии

Интерфейс IAsyncResult реализуется классами, содержащими методы, которые могут работать асинхронно. Это возвращаемый тип методов, инициирующих асинхронную операцию, например FileStream.BeginReadметоды, которые завершают асинхронную операцию, например FileStream.EndRead. IAsyncResult Объекты также передаются в методы, вызываемые AsyncCallback делегатами при завершении асинхронной операции.

Объект, поддерживающий IAsyncResult интерфейс, хранит сведения о состоянии для асинхронной операции и предоставляет объект синхронизации, позволяющий сигнализировать потокам после завершения операции.

Замечание

Класс AsyncResult представляет собой реализацию IAsyncResult , возвращаемую методом BeginInvoke при использовании делегата для асинхронного вызова метода.

Подробное описание использования IAsyncResult интерфейса см. в разделе " Асинхронные методы для вызова синхронных методов ".

Свойства

Имя	Описание
AsyncState	Возвращает определяемый пользователем объект, который квалифисирует или содержит сведения об асинхронной операции.
AsyncWaitHandle	Возвращает объект WaitHandle , который используется для ожидания завершения асинхронной операции.
CompletedSynchronously	Возвращает значение, указывающее, выполняется ли асинхронная операция синхронно.
IsCompleted	Возвращает значение, указывающее, завершена ли асинхронная операция.