参考
TaskCompletionSource とは
TaskCompletionSource<TResult> は、「手動で完了させる Task」を作るためのクラスである。
主なメンバー
-
Task: タスクを戻すプロパティ -
SetResult(result): タスクを成功として完了する -
SetException(ex): タスクを失敗として完了する -
SetCanceled(): タスクをキャンセルする
使い方の例
コールバックをラップする
完了時にコールバックを実行する API を、タスクを戻す形に変換する
public Task<string> ExecuteLegacyProcedureAsync()
{
var tcs = new TaskCompletionSource<string>();
// 完了時にコールバックを実行する API
LegacyProcedure.Execute(
onSuccess: text => tcs.TrySetResult(text), // 成功時のコールバック
onError: ex => tcs.TrySetException(ex) // 例外発生時のコールバック
);
return tcs.Task; // コールバックで完了する Task を戻す
}
イベントを待つ
「接続完了イベント」を待つタスクを作る
public Task WaitForConnectedAsync(Client client)
{
var tcs = new TaskCompletionSource();
// 「接続完了イベント」にハンドラーを登録する
client.Connected += OnConnected;
return tcs.Task; // ハンドラーで完了する Task を戻す
// 「接続完了イベント」のハンドラー
void OnConnected()
{
client.Connected -= OnConnected;
tcs.TrySetResult(); // ここで Task 完了
}
}
付記
TaskCompletionSource<TResult>は、Visual StudioのCopilotチャットに作業を指示した際、作業結果に使われていたもので、言わば「AIに教えてもらった」機能です。
また、この記事は、AIが下書きしてもらったものを、私が編集して、作成しました。