web-dev-qa-db-ja.com

async / awaitを使用してWebサービスを呼び出すにはどうすればよいですか？

Yii （phpフレームワーク）で書かれた webservice があります。

C＃とVisual Studio 2012を使用して、WP8アプリケーションを開発します。プロジェクトにサービス参照を追加しました（サービス参照の追加）。そのため、Webサービス機能を使用できます。

   client = new YChatWebService.WebServiceControllerPortTypeClient();

   client.loginCompleted += client_loginCompleted;   // this.token = e.Result;
   client.loginAsync(this.username, this.password); 

   client.getTestCompleted += client_getTestCompleted;
   client.getTestAsync(this.token);

関数getTestAsyncおよびloginAsyncはvoidを返し、両方とも非同期です。関数がTask<T>を返すことは可能ですか？プログラムでasync/awaitキーワードを使用したいと思います。

回答：

ご協力ありがとうございました。

次のコードは動作しているようです。

    internal static class Extension
    {
        private static void TransferCompletion<T>(
            TaskCompletionSource<T> tcs, System.ComponentModel.AsyncCompletedEventArgs e, 
    Func<T> getResult)
        {
            if (e.Error != null)
            {
                tcs.TrySetException(e.Error);
            }
            else if (e.Cancelled)
            {
                tcs.TrySetCanceled();
            }
            else
            {
                tcs.TrySetResult(getResult());
            }
        }

        public static Task<loginCompletedEventArgs> LoginAsyncTask(this YChatWebService.WebServiceControllerPortTypeClient client, string userName, string password)
        {
            var tcs = new TaskCompletionSource<loginCompletedEventArgs>();
            client.loginCompleted += (s, e) => TransferCompletion(tcs, e, () => e);
            client.loginAsync(userName, password);
            return tcs.Task;
        }
    }

このように呼びます

        client = new YChatWebService.WebServiceControllerPortTypeClient();
        var login = await client.LoginAsyncTask(this.username, this.password);
c#soapwindows-phone-8wsdl
26
MPeli

LoginAsyncがvoidを返し、ログインが完了するとloginCmpletedイベントが発生すると仮定すると、これはイベントベースの非同期パターン、またはEAPと呼ばれます。

EAPをawait/asyncに変換するには、 タスクとイベントベースの非同期パターン を参照してください。特に、TaskCompletionSourceを使用して、イベントベースのモデルをタスクベースのモデルに変換する必要があります。タスクベースのモデルを取得したら、C＃5のセクシーな待機機能を使用できます。

以下に例を示します。

// Use LoginCompletedEventArgs, or whatever type you need out of the .loginCompleted event
// This is an extension method, and needs to be placed in a static class.
public static Task<LoginCompletedEventArgs> LoginAsyncTask(this YChatWebService.WebServiceControllerPortTypeClient client, string userName, string password) 
{ 
    var tcs = CreateSource<LoginCompletedEventArgs>(null); 
    client.loginCompleted += (sender, e) => TransferCompletion(tcs, e, () => e, null); 
    client.loginAsync(userName, password);
    return tcs.Task; 
}

private static TaskCompletionSource<T> CreateSource<T>(object state) 
{ 
    return new TaskCompletionSource<T>( 
        state, TaskCreationOptions.None); 
}

private static void TransferCompletion<T>( 
    TaskCompletionSource<T> tcs, AsyncCompletedEventArgs e, 
    Func<T> getResult, Action unregisterHandler) 
{ 
    if (e.UserState == tcs) 
    { 
        if (e.Cancelled) tcs.TrySetCanceled(); 
        else if (e.Error != null) tcs.TrySetException(e.Error); 
        else tcs.TrySetResult(getResult()); 
        if (unregisterHandler != null) unregisterHandler();
    } 
}

イベントベースの非同期プログラミングモデルをタスクベースの非同期プログラミングモデルに変換したので、awaitを使用できるようになりました。

var client = new YChatWebService.WebServiceControllerPortTypeClient();
var login = await client.LoginAsyncTask("myUserName", "myPassword");
32
Judah Gabriel Himango

サービス参照を追加するときに、必ずGenerate Task based operationsAdvancedセクション。これにより、LoginAsyncなどの待機可能なメソッドが作成され、Task<string>

7
I4V

私は昨年にわたってこれを数回行う必要があり、上記の@Judahのコードと 元の例 の両方を使用しましたが、次の問題に遭遇するたびに両方で：非同期呼び出しは機能しますが、は完了しません。ステップを踏むと、TransferCompletionメソッドに入るが、e.UserState == tcsは常にfalseになることがわかります。

OPのloginAsyncのようなWebサービスの非同期メソッドには2つのシグネチャがあります。 2番目はuserStateパラメーターを受け入れます。解決策は、作成したTaskCompletionSource<T>オブジェクトをこのパラメーターとして渡すことです。これにより、e.UserState == tcsはtrueを返します。

OPでは、e.UserState == tcsが削除され、理解しやすいコードが機能するようになりました-私も誘惑されました。しかし、私はこれが正しいイベントが完了することを保証するためにあると信じています。

完全なコードは次のとおりです。

public static Task<LoginCompletedEventArgs> RaiseInvoiceAsync(this Client client, string userName, string password)
{
    var tcs = CreateSource<LoginCompletedEventArgs>();
    LoginCompletedEventHandler handler = null;
    handler = (sender, e) => TransferCompletion(tcs, e, () => e, () => client.LoginCompleted -= handler);
    client.LoginCompleted += handler;

    try
    {
        client.LoginAsync(userName, password, tcs);
    }
    catch
    {
        client.LoginCompleted -= handler;
        tcs.TrySetCanceled();
        throw;
    }

    return tcs.Task;
}

あるいは、userStateを提供するtcs.Task.AsyncStateプロパティもあると思います。そのため、次のようなことができます。

if (e.UserState == taskCompletionSource || e.UserState == taskCompletionSource?.Task.AsyncState)
{
    if (e.Cancelled) taskCompletionSource.TrySetCanceled();
    else if (e.Error != null) taskCompletionSource.TrySetException(e.Error);
    else taskCompletionSource.TrySetResult(getResult());
    unregisterHandler();
}

これは私が最初に試したもので、より軽いアプローチに見え、完全なTaskCompletionSourceオブジェクトではなくGuidを渡すことができました。スティーブン・クリアリーには、興味があるなら AsyncStateの良い説明 があります。

5
Digbyswift