非同期処理の途中で中断する方法について

Question

例えば以下のようにawait / asyncで時間のかかる処理を非同期に動かしている途中で、
キャンセルボタン等によって動作を中断して終わらせるにはどうのようにしたら良いでしょうか

private async void button_Click(object sender, EventArgs e)
{
  int intValue = await GetintValue.ToString();
}
private async Task<int> GetintValue()
{
  await //何か重い処理
  return 1;
}

重い処理は内部が隠蔽されているクラスライブラリを想定しています。

Answer 1

こんにちは。

async/await、Taskで「正しく」非同期キャンセルをやるなら、CancellationTokenを使います。
GetintValueメソッドに引数としてCancellationTokenを受け取るようにして、メソッド内部でIsCancellationRequestedプロパティかThrowIfCancellationRequested()メソッドを用いて途中キャンセル時のフローを構築します。
await //何か重い処理の重い処理の内部で中断するには、重い処理にも再帰的にCancellationTokenを引き渡していきます。一般的な非同期ライブラリのAPIであれば、時間を要する可能性がある処理には大抵CancellationTokenを受け入れるオーバーロードが存在しています。

private async void button_Click(object sender, EventArgs e)
{
  int intValue = await GetintValue(どこかのCancellationToken).ToString();
}

private async Task<int> GetintValue(CancellationToken token)
{
  await 何か重い処理(token); // 重い処理にもtokenを渡す

  if (token.IsCancellationRequested)
    return -1; // キャンセル状態か判定して何かしたり

  token.ThrowIfCancellationRequested(); // キャンセル状態だったらいきなり例外をぶっ放して止めたり

  return 1;
}

それぞれの非同期メソッドに渡すCancellationTokenは基本的にCancellationTokenSourceから生成します。そして、CancellationTokenSourceのCancel()メソッドを呼ぶことでtokenがCanceled状態になります。

// 仮にフィールドに置く
private readonly CancellationTokenSource cts;

// ...
{
  await GetintValue(this.cts.Token); // ctsからtokenを取り出して渡す
}

// ...キャンセルボタンとか
{
  this.cts.Canel(); // どこかでCancel()メソッドを呼ぶと非同期に走っているGetintValueメソッドがキャンセルされる
}

あと、ThrowIfCancellationRequested()メソッドを用いてキャンセルする場合、非同期メソッドのTaskの状態がRunningでもCompletedでもなくCanceled状態になるため、キャンセルされたということが明確になるためオススメです。

---

追記

TaskではなくIAsyncActionの非同期キャンセルということだったので追記します、おそらくTaskより簡単に処理できます。(UWP関係はほぼ触ったことないので間違ってるかもしれません)

IAsyncActionインターフェースはそれ自体がCancel()メソッドを持っており、かつAwaitableになっているものです。
awaitを使って非同期メソッドのフローに組み込む前に、それ自身のキャンセル機構を呼び出せるように設計するだけで良いです。

private IAsyncInfo _asyncTask; // とりあえず非同期処理そのものを監視するための変数

{
    var scan = _adapter.ScanAsync(); // まずawaitをつけないで実行し、IAsyncActionを取得
    this._asyncTask = scan; // 先にフィールドとか外部に渡す
    await scan; // その後await
}

// ...Cancelボタン
{
    this._asyncTask?.Cancel(); // IAsyncInfoのCancel()メソッドを呼ぶだけ
}

さらに別の方法をとして、通常のTaskのように、CancellationTokenを使ったキャンセル機構に一元化したい場合に、CancellationToken.Register()メソッドを利用することもできます。
以下はもっと良い方法を教えていただいたので末尾に追記してます。

async Task GetintValue(CancellationToken token)
{
    var scan = _adapter.ScanAsync(); // まずawaitをつけないで実行
    token.Register(() => scan.Cancel()); // tokenがCancel状態になったときにScanAsyncをキャンセルするように登録
    await scan; // その後await
}

// ...Cancelボタン
{
    this.cts.Cancel(); // 普通のTaskのようにCancellationTokenSourceのCancel()メソッドを呼んでキャンセルできる
}

---

さらに追記
IAsyncActionをTaskとして取り扱える拡張メソッドが存在することを教えていただきました。(asmさんありがとうございます)
これを利用するとCancellationTokenを利用するキャンセル処理を自然に実装できます。async/awaitやTaskと組み合わせる場合では、これが一番良い方法だと思います。

async Task GetintValue(CancellationToken token) // 引数で受け取って
{
    await _adapter.ScanAsync().AsTask(token); // AsTaskメソッドにtokenを渡して、awaitするだけ
}

// ...Cancelボタン
{
    this.cts.Cancel(); // 普通のTaskのようにCancellationTokenSourceのCancel()メソッドを呼んでキャンセルできる
}

Comments

[ibuki]

ご回答ありがとうございます。
私が使いたいと思っているのがWindows.Devices.WiFiにあるWiFiAdapterのScanAsyncなのですが、CancellationTokenに該当するものが見つけられませんでした。
キャンセルボタンを追加してCancellationTokenSourceのCanelを走らせてみましたが、処理自体が現時点でそんなに遅くないためか完了修正したのかキャンセルされたのかよくわかりませんでした。
Taskの状態というのはデバッグモードで見れるプロパティでしょうか

[tamoto]

IAsyncActionの非同期処理でしたか。こちらはTaskとはちょっと毛色が違うものです。
回答に追記しましたのでご確認ください。

Taskの状態というのは、TaskのStatusプロパティの設定値になります。Taskの継続処理を扱う場合に見分けがつくようになります。

CancellationTokenのキャンセル処理を目視で確認してみたいのであれば、await Task.Delay(とても大きい数値, cancellationToken);
を処理に挿入してみて、Cancel()メソッドを呼ぶと素早くキャンセルされることを確認できると思います。

[asm]

await ScanAsync().AsTask(cancellationToken);
これも、できるかも

[tamoto]

AsTask拡張メソッドあるんだ〜〜〜！！
どう考えてもそれを使うべきですね！

[ibuki]

お二人ともありがとうございました。
private readonly CancellationTokenSource cts;
で宣言しているctsが、実行時にnullですと言われて少し戸惑いましたが、
private CancellationTokenSource cts;
としたうえで
cts = new CancellationTokenSource();
を挟むことによってうまくキャンセルさせられたと思います。
この運用でも大丈夫でしたでしょうか

[tamoto]

この回答のctsは、既にフィールドにセットしてあると仮定したものなので、実運用では初期化構文を使ってもコンストラクタで宣言でも、フィールドを使わずローカル変数で取り扱っても構いません。キャンセルしたいときにちゃんと参照が辿れるようになっていれば問題ないです。

Answer 2

こんにちは。

私は、terminatedフラグを用意します。初期値はfalseで中断させたい時にtrueを設定します。そして、「何か重い処理」の中で時々それをチェックし、trueだったら中断させます。

なお、terminatedフラグをtrueにした後、安易にGatintValue()の終了を待つと確実にデッドロックするので要注意です。
ケースバイケースで対処してます。なかなか一般的な解が見つかっていませんが、私はSynchronizationContextを使うことが多いです。