メソッド内で生成される値を、別のメソッドで非同期で受け取りたい

Question

前提・実現したいこと

以下のソースコードにおいて、
メソッドHogehoge内で生成される値barを、Btn_Click内の処理で随時取得したく、
メソッドGetValueAsyncを作成したのですが、
GetValueAsync内のwhileループでCPU使用率がとても高くなってしまいます。

該当のソースコード

private string _foo;

private async task Hogehoge()
{
    while(条件式)
    {
        ...
        this._foo = bar; // barはこのHogehoge内で生成される値
    }
    ...
}

private async Task<string> GetValueAsync()
{
    var value = await Task.Run(() =>
    {
        while (true)
        {
            if (this._foo != null)
                return this._foo;
        }
    });

    this._foo = null;

    return value;
}

public async void Btn_Click(object sender, RoutedEventArgs e)
{
    while(true)
    {
        Debug.WriteLine(await GetValueAsync());
    }
}

試したこと

以下のように、Task.Delay(1)を入れるとCPU使用率が上がることがなくなったのですが、
こんな解決策でよいのか（そもそもなぜこれで解決するのか）、またもっと他に良い方法がないかと思っています。

詳しい方おられましたら、ご教授お願いいたします。

private async Task<string> GetValueAsync()
{
    var value = await Task.Run(async () =>
    {
        while (true)
        {
            await Task.Delay(1); // これを追加
            if (this._foo != null)
                return this._foo;
        }
    });

    this._foo = null;

    return value;
}

補足（実現したいこと）

barの値の取得に関してですが、
Btn_Click内でGetValueAsyncが呼ばれたタイミングのbarの値が取得できればそれでいいです。
Btn_Click内でGetValueAsyncが呼ばれたタイミングのbarの値（ただし、barが更新されていなければ、更新されるまで待つ）を取得したいです。

解決策？

いただいた回答に基づいて、コードを改良してみました。

private readonly AutoResetEvent condition = new AutoResetEvent(false);

private async Task<string> GetValueAsync()
{
    await Task.Run(() =>
    {
        condition.WaitOne();
    });            
    return this._originaltext;
}

Hogehogeメソッドのとこには、
this._foo = bar;の下に、condition.Set();を記述。

Comments

[退会済みユーザー]

ループを回している間は、該当スレッドがループを回すという仕事をし続けているのでCPUを使用します。SleepやDelayはOSに処理を返すためCPUを占有しません。

[test189]

なるほど、そうなんですね。ありがとうございます。
ちなみに、スレッドがブロックされるのを回避するために「特に待つ必要はないけれどもwhileループの中にawait Task.Delayを入れ込む」というような書き方は、そもそもプログラムの書き方がやはりおかしいのでしょうか。

Answer 1

whileループで待つようなことはせず、
AutoResetEvent などの同期イベントを使いましょう

AutoResetEvent クラス (System.Threading) | Microsoft Docs

Comments

[test189]

コメントありがとうございます。
AutoResetEventというものを初めて知りました。
これを使って書き換えてみると、cpu使用率も特に上昇せず期待通りに動きました。
ちなみに書き方ですが、上のような書き方で問題ないでしょうか。

Answer 2

メソッドHogehoge内で生成される値barを、Btn_Click内の処理で随時取得したく、メソッドGetValueAsyncを作成したのですが、

private string _foo; と private async task Hogehoge() は何らかのクラスに属していると思いますが、であればそのクラスに _foo の値を返すプロパティを追加して、それ経由で取得してはいかがですか？

コードは以下のような感じ。(変数、メソッドの名前等は質問のコードから変えてます）

using System;
using System.Threading.Tasks;
using System.Windows.Forms;

namespace WindowsFormsAsyncTest
{
    public partial class Form6 : Form
    {
        private MyClass myClass;

        public Form6()
        {
            InitializeComponent();
        }

        private async void button1_Click(object sender, EventArgs e)
        {
            this.myClass = new MyClass();
            await this.myClass.MyAsyncMethod();
        }

        private void button2_Click(object sender, EventArgs e)
        {
            if (this.myClass != null)
            {
                this.label1.Text = this.myClass.Value;
            }
        }
    }

    public class MyClass
    {
        private string _value;

        public string Value
        {
            get { return _value; }
        }

        public async Task MyAsyncMethod()
        {
            // 取りあえず 100 を上限
            int i = 0;
            while (i < 100)
            {
                // なんらかの処置と bar の生成
                // Task.Delay(100) と i で代用
                await Task.Delay(100);
                string bar = "Bar の値: " + i;

                this._value = bar;
                i++;
            }
        }
    }
}

結果は以下の通りです。

![]

Comments

[test189]

コードまで書いていただき、ご回答ありがとうございます。
説明不足で申し訳ないのですが、
Btn_Clickの中でwhileループなどでずっとmyClass.Valueの値を読みたいのですが、
MyAsyncMethodのwhileループ内でthis._valueの値が更新されたときに読み込みたいので、y_waiwaiさんがおっしゃられてるようなAutoResetEventのようなシグナル？を使った手段が適切なのかなと思いました。

[退会済みユーザー]

> MyAsyncMethodのwhileループ内でthis._valueの値が更新されたときに読み込みたい

それは話が違うような気がしますけど？　質問には、

> Btn_Click内でGetValueAsyncが呼ばれたタイミングのbarの値が取得できればそれでいいです。

と書いてありましたが・・・

> AutoResetEventのようなシグナル？を使った手段が適切なのかなと思いました。

同期コードと非同期コードを混在させることによるデッドロックの問題とかはないのでしょうか？　以下のドキュメントにあるように「すべて非同期にする」のが基本だと思っているのですが・・・

非同期プログラミングのベスト プラクティス
https://docs.microsoft.com/ja-jp/archive/msdn-magazine/2013/march/async-await-best-practices-in-asynchronous-programming

[test189]

質問が不適切で、申し訳ありませんでした。
正しくは「Btn_Click内でGetValueAsyncが呼ばれたタイミングのbarの値（ただし、barが更新されていなければ、更新されるまで待つ）を取得したい」になります。
質問文も編集しておきます。
非同期のベストプラクティス挙げていただきありがとうございます。
なかなか難しいですが、じっくり考えてみたいと思います。

[退会済みユーザー]

いつまで待っても更新されないと破綻しそうなのでキャンセルできるようにしないとダメかもしれませんね。イベントとそれを処理するコールバックで行うことも考えてみてはどうでしょう？

[test189]

＞いつまで待っても更新されないと破綻しそうなので...
そうですね、まさにそこがネックですが、イベント処理の方法を調べてやってみたいと思います。
ありがとうございます。