C#非同步委託的用法

查看原文

 

每個委託都有三個方法：Invoke、BeginInvoke、EndInvoke。第一個方法是委託指定函數的同步調用，另外兩個是非同步呼叫。

        BeginInvoke方法，調用後立即返回，不等待調用結果。EndInvoke方法，用於檢索調用結果。調用BeginInvoke後可隨時調用 EndInvoke 方法；如果非同步呼叫未完成，EndInvoke 將一直阻塞到非同步呼叫完成。EndInvoke 的參數包括您需要非同步執行的方法的 out 和 ref 參數（在 Visual Basic 中為 <Out> ByRef 和 ByRef）以及由 BeginInvoke 返回的 IAsyncResult

        BeginInvoke 非同步方法呼叫簽名的規則是：

• 包括所有 IN 參數。
• 包括所有 OUT 參數。
• 包括所有 IN/OUT 參數。
• 包括所有 ByRef 參數。
• 將 AsyncCallback 和 AsyncState（可通過 IAsyncResult 介面的 AsyncState 屬性獲得）作為最後兩個參數。
• 返回 IAsyncResult。

        EndInvoke 非同步方法呼叫簽名的規則是：

• 包括所有 IN/OUT 參數。
• 包括所有 OUT 參數。
• 包括所有 ByRef 參數。
• 將 IAsyncResult 作為最後一個參數。
• 從原始方法簽名返回原始傳回型別。

        結果對象 (IAsyncResult) 是從開始操作返回的，並且可用於擷取有關非同步開始操作是否已完成的狀態。結果對象被傳遞到結束操作，該操作返回調用的最終傳回值。在開始操作中可以提供可選的回調。如果提供回調，在調用結束後，將調用該回調；並且回調中的代碼可以調用結束操作。

AsyncCallback 委託

        AsyncCallback 委託用於指定在開始操作完成後應被調用的方法。下面是該委託的簽名，AsyncCallback 委託被作為開始操作上的第二個到最後一個參數傳遞：

        public delegate void AsyncCallback(IAsyncResult ar);

IAsyncResult 介面

        IAsyncResult 介面用於監視和管理非同步作業。該介面是從開始操作返回的並被傳遞到結束操作，以將開始操作和結束操作相關聯。如果回調被指定為開始操作的一部分，則 AsyncResult 被傳遞到回調。以下代碼闡釋有關 IAsyncResult 介面的屬性，該介面可用於監視非同步作業的狀態並擷取還可被傳遞到開始操作中的非同步狀態物件：

public interface IAsyncResult

{

  Object AsyncState { get; }                       //該屬性為BeginInvoke參數中的最後一個參數對象

  WaitHandle AsyncWaitHandle { get; }

  bool CompletedSynchronously { get; }

  bool IsCompleted { get; }                         //該屬性判斷非同步呼叫是否結束

}

• AsyncState

        返回在開始操作方法調用中作為最後一個參數提供的對象。

• AsyncWaitHandle

        AsyncWaitHandle 屬性返回 WaitHandle，後者可用於執行 WaitHandle.WaitOne、WaitAny 或 WaitAll。

        注意   直到 AsyncWaitHandle 屬性被讀取時，實現 IAsyncResult 的對象才需要建立 WaitHandle；執行時間由實施者決定。如果實施者建立了 WaitHandle，則實施者需要負責在適當的時候發出 WaitHandle 訊號終止等待。例如，當非同步呼叫的方法返回時，AsyncResult 將代表調用方終止等待。建立後，WaitHandle 應保持活動狀態，直到使用者調用結束非同步作業的方法。此時，可以丟棄 AsyncWaitHandle 後的對象。

• CompletedSynchronously

        如果開始操作調用已同步完成，則 CompletedSynchronously 屬性將被設定為 true。

• IsCompleted

        在伺服器已處理完調用後，IsCompleted 屬性將被設定為 true。

        調用了 BeginInvoke 後，可以：

• 進行某些操作，然後調用 EndInvoke 一直阻塞到調用完成。
• 使用 IAsyncResult.AsyncWaitHandle 擷取 WaitHandle，使用它的 WaitOne 方法將執行一直阻塞到發出 WaitHandle 訊號，然後調用 EndInvoke。
• 輪詢由 BeginInvoke 返回的 IAsyncResult，確定非同步呼叫何時完成，然後調用 EndInvoke。
• 將用於回調方法的委託傳遞給 BeginInvoke。該方法在非同步呼叫完成後在 ThreadPool 線程上執行，它可以調用 EndInvoke。

        註： 始終在非同步呼叫完成後調用 EndInvoke。

        以下是關於非同步委託的測試代碼：

using System;

using System.Threading;

 

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 = AppDomain.GetCurrentThreadId();

        return "MyCallTime was " + callDuration.ToString();

    }

}

 

// The delegate must have the same signature as the method

// you want to call asynchronously.

public delegate string AsyncDelegate(int callDuration, out int threadId);

 

public class AsyncMain {

    static void Main(string[] args) {

        // The asynchronous method puts the thread id here.

        int threadId;

 

        // Create an instance of the test class.

        AsyncDemo ad = new AsyncDemo();

 

        // Create the delegate.

        AsyncDelegate dlgt = new AsyncDelegate(ad.TestMethod);

  

        // Initiate the asychronous call.

        IAsyncResult ar = dlgt.BeginInvoke(3000,

            out threadId, null, null);

 

        Thread.Sleep(0);

        Console.WriteLine("Main thread {0} does some work.",

            AppDomain.GetCurrentThreadId());

 

        // Wait for the WaitHandle to become signaled.

        ar.AsyncWaitHandle.WaitOne();

/*              
這個是輪詢非同步執行狀態

        // Poll while simulating work.

        while(ar.IsCompleted == false)

        {

            Thread.Sleep(10);

        }

*/

        // Call EndInvoke to Wait for the asynchronous call to complete,

        // and to retrieve the results.

        string ret = dlgt.EndInvoke(out threadId, ar);

 

        Console.WriteLine("The call executed on thread {0}, with return value /"{1}/".", threadId, ret);

    }

}

 

        以下代碼是用回呼函數執行EndInvoke方法

public class AsyncMain {

    // Asynchronous method puts the thread id here.

    private static int threadId;

 

    static void Main(string[] args) {

        // Create an instance of the test class.

        AsyncDemo ad = new AsyncDemo();

 

        // Create the delegate.

        AsyncDelegate dlgt = new AsyncDelegate(ad.TestMethod);

  

        // Initiate the asychronous call.  Include an AsyncCallback

        // delegate representing the callback method, and the data

        // needed to call EndInvoke.

        IAsyncResult ar = dlgt.BeginInvoke(3000,

            out threadId,

            new AsyncCallback(CallbackMethod),

            dlgt );

 

        Console.WriteLine("Press Enter to close application.");

        Console.ReadLine();

    }

   

        

    // Callback method must have the same signature as the

    // AsyncCallback delegate.

    static void CallbackMethod(IAsyncResult ar) {

        // Retrieve the delegate.

        AsyncDelegate dlgt = (AsyncDelegate) ar.AsyncState;

 

        // Call EndInvoke to retrieve the results.

        string ret = dlgt.EndInvoke(out threadId, ar);

 

        Console.WriteLine("The call executed on thread {0}, with return value /"{1}/".", threadId, ret);

    }

}

 

這裡值得順帶一提的是有關Control.Invoke（）和Delegate.Invoke（）等一系列方法的區別：

 

                                         Return          Work Thread

Control.Invoke                  完成工作         強制於 UI Thread
Control.BeginInvoke             立即            強制於 UI Thread
[delegate].Invoke               完成工作        Call Invoke 的 Thread
[delegate].BeginInvoke          立即           新的背景 Thread