方法 : コールバック手法を使用して非同期 Web サービスクライアントを実装する

[アーティクル]
02/24/2011

このトピックの対象は、レガシテクノロジに特定されています。XML Web サービスと XML Web サービスクライアントは以下を使用して作成してください。 Windows Communication Foundation.

コールバック手法は、Web サービスメソッドが同期アクセスを目的として作成されている場合でも、Web サービスメソッドと非同期通信を行う Web サービスクライアントを実装する方法の 1 つです。この手法については、トピック「XML Web サービスとの非同期通信」を参照してください。

次の例は、Factorize メソッドを持つ PrimeFactorizer Web サービスクラスに基づいています。これに対して、Wsdl.exe ツールによって 2 つの非同期クライアントプロキシメソッド (BeginFactorize および EndFactorize) が生成されています。

コールバック手法を実装するには

AsyncCallback デリゲートを実装するコールバック関数を定義します。

public static void FactorizeCallback(IAsyncResult ar)

Public Shared Sub FactorizeCallback(ar As IAsyncResult)

AsyncCallback デリゲートをインスタンス化します。

AsyncCallback cb = new AsyncCallback(TestCallback.FactorizeCallback);

Dim cb as AsyncCallback 
cb = new AsyncCallback(AddressOf TestCallback.FactorizeCallback)

Begin メソッドを呼び出します。2 番目の引数としてコールバック関数を渡し、3 番目の引数として状態を提供するオブジェクト (この例ではクライアント実装の PrimeFactorizer) を渡します。
```
IAsyncResult ar = pf.BeginFactorize(factorizableNum, cb, pf);
```
```
Dim ar As IAsyncResult = pf.BeginFactorize(factorizableNum, _
                                                     cb, pf)
```
Begin メソッドによって返された IAsyncResult の IsCompleted プロパティを確認します。この値は、クライアントがサーバーから応答を受信すると、true に設定されます。
コールバック関数内で、状態オブジェクトにアクセスします。IAsyncState パラメーターの AsyncState プロパティには、Begin メソッドに 3 番目のパラメーターとして渡されたオブジェクトが含まれています。
```
PrimeFactorizer pf = (PrimeFactorizer) ar.AsyncState;
```
```
Dim pf As PrimeFactorizer = ar.AsyncState
```
コールバック関数内で、前の手順で取得した状態オブジェクト上で End メソッドを呼び出します。
```
long[] results = pf.EndFactorize(ar);
```
```
Dim results() as Long
results = pf.EndFactorize(ar)
```

例

using System;
using System.Runtime.Remoting.Messaging;
using MyFactorize;

class TestCallback
 {           
      public static void Main(){
            long factorizableNum = 12345;
            PrimeFactorizer pf = new PrimeFactorizer();

            //Instantiate an AsyncCallback delegate to use as a parameter
            //in the BeginFactorize method.
            AsyncCallback cb = new AsyncCallback(TestCallback.FactorizeCallback);

          // Begin the Async call to Factorize, passing in our
          // AsyncCalback delegate and a reference
          // to our instance of PrimeFactorizer.
            IAsyncResult ar = pf.BeginFactorize(factorizableNum, cb, pf);
            
            // Keep track of the time it takes to complete the async call
            // as the call proceeds.
         int start = DateTime.Now.Second;
         int currentSecond = start;
         while (!ar.IsCompleted){
            if (currentSecond < DateTime.Now.Second) {
                  currentSecond = DateTime.Now.Second;
                  Console.WriteLine("Seconds Elapsed..." + (currentSecond - start).ToString() );
            }
         }
         // Once the call has completed, you need a method to ensure the
         // thread executing this Main function 
         // doesn't complete prior to the call-back function completing.
         Console.Write("Press Enter to quit");
         int quitchar = Console.Read();
      }
      // Set up a call-back function that is invoked by the proxy class
      // when the asynchronous operation completes.
      public static void FactorizeCallback(IAsyncResult ar)
      {
          // You passed in our instance of PrimeFactorizer in the third
          // parameter to BeginFactorize, which is accessible in the
          // AsyncState property.
          PrimeFactorizer pf = (PrimeFactorizer) ar.AsyncState;
          long[] results;

          // Get the completed results.
            results = pf.EndFactorize(ar);
          
          //Output the results.
            Console.Write("12345 factors into: ");
            int j;
            for (j = 0; j<results.Length;j++){
                  if (j == results.Length - 1)
                      Console.WriteLine(results[j]);
                  else 
                      Console.Write(results[j] + ", ");
            }
      }
}

Imports System
Imports System.Runtime.Remoting.Messaging
Imports MyFactorize

Public Class TestCallback
    Public Shared Sub Main()
       Dim factorizableNum As Long = 12345
       Dim pf As PrimeFactorizer = new PrimeFactorizer()

       'Instantiate an AsyncCallback delegate to use as a 
       'parameter
       ' in the BeginFactorize method.
       Dim cb as AsyncCallback 
       cb = new AsyncCallback(AddressOf TestCallback.FactorizeCallback)

     ' Begin the Async call to Factorize, passing in the
     ' AsyncCallback delegate and a reference to our instance
     ' of PrimeFactorizer.
       Dim ar As IAsyncResult = pf.BeginFactorize(factorizableNum, _
                                                     cb, pf)
            
     ' Keep track of the time it takes to complete the async call as
     ' the call proceeds.
       Dim start As Integer = DateTime.Now.Second
       Dim currentSecond As Integer = start
       Do while (ar.IsCompleted = false)
          If (currentSecond < DateTime.Now.Second) Then
                currentSecond = DateTime.Now.Second
                Console.WriteLine("Seconds Elapsed..." + 
                      (currentSecond - start).ToString() )
          End If
       Loop

      ' Once the call has completed, you need a method to ensure the
      ' thread executing this Main function 
      ' doesn't complete prior to the callback function completing.
       Console.Write("Press Enter to quit")
       Dim quitchar As Integer = Console.Read()
    End Sub

    ' Set up the call-back function that is invoked by the proxy 
    ' class when the asynchronous operation completes.
    Public Shared Sub FactorizeCallback(ar As IAsyncResult)
    
       ' You passed in the instance of PrimeFactorizer in the third
       ' parameter to BeginFactorize, which is accessible in the
       ' AsyncState property.
         Dim pf As PrimeFactorizer = ar.AsyncState
         Dim results() as Long

       ' Get the completed results.
         results = pf.EndFactorize(ar)
        
       'Output the results.
         Console.Write("12345 factors into: ")
         Dim j as Integer
         For j = 0 To results.Length - 1
              If  j = (results.Length - 1) Then
                   Console.WriteLine(results(j) )
              Else 
                   Console.Write(results(j).ToString + ", ")
              End If
        Next j         
     End Sub      
End Class

参照

方法 : コールバック手法を使用して非同期 Web サービス クライアントを実装する

コールバック手法を実装するには

例

参照

処理手順

概念

その他のリソース

その他のリソース

方法 : コールバック手法を使用して非同期 Web サービスクライアントを実装する