gdドキュメント0.8.0

非同期処理とキャンセル

English | 日本語

ファイルの読み取りや通信の完了を待つ間も、ほかの処理は進みます。APIリファレンスには、関数を呼ぶだけで結果を待てるか、awaitで待つ必要があるかを記載しています。

そのまま結果を受け取る方法と、あとで待つ方法

GD.file.read_text(path)は読み取りが終わるまで待って結果を返します。GD.file.read_text_async(path)は読み取りを開始し、完了を知らせるSignalをすぐに返します。後者は、先に別の処理を始めてからawaitで結果を受け取る場合に使います。

func main():
    var pending: Signal = GD.file.read_text_async("message.txt")
    var result: Array = await pending
    var text: String = result[0]
    var error: Err = result[1]
    if error != null:
        printerr(error.text())
        return 1
    print(text)
    return 0

正確な戻り値はread_textとread_text_asyncを参照してください。

複数の処理を同時に進める

互いの結果を必要としない処理は、CallableとしてGD.async.allへ渡します。完了通知の準備をしてから処理を始め、渡した順番で各結果を配列に入れて返します。すべての処理が終わっても、すべて成功したとは限りません。それぞれのエラーを確認してください。

func main():
    var results: Array = await GD.async.all([
        GD.file.read_text_async.bind("first.txt"),
        GD.file.read_text_async.bind("second.txt"),
    ])
    for result: Array in results:
        var error: Err = result[1]
        if error != null:
            printerr(error.text())
            return 1
        print(result[0])
    return 0

GD.async.spawnは、関数の処理をメインスレッド上で開始します。ほかの処理と交代しながら動く仕組みで、CPU負荷の高いGDScriptを別のスレッドへ移す機能ではありません。

処理をキャンセルする

GD.async.contextは、キャンセルや制限時間を管理するオブジェクト(コンテキスト)を作ります。with_timeoutを呼ぶと、秒数で指定した制限時間を持つ子コンテキストができます。親の設定は変わりません。親をキャンセルすると、子もキャンセルされます。

GD.async.with_context_pairには、コンテキストと、二値を返す処理のSignalをこの順に渡します。Webリクエストを処理する関数ではreq.contextを使うと、接続が切れた場合などに待機中の処理をキャンセルできます。

func load(req: GDWebRequest, db: GDDatabaseClient) -> Variant, Err:
    return await GD.async.with_context_pair(req.context, db.query_async("SELECT 1"))

結果をそのまま返すと、失敗やキャンセルの理由も呼び出し元に渡せます。キャンセルしても後片付けがすべて済むわけではありません。自分で開いたストリームや、データベースの行を読み取るオブジェクトは、使い終わったら閉じてください。

ほかの処理を待たせないために

リクエストを受け取る関数や、処理の完了時に呼ばれる関数では、長い計算を続けないようにします。大きなデータを標準モジュールで処理する場合は、対応する_async付きの関数を使います。自分で書いた長いループが、awaitを使うだけで別のスレッドに移るわけではありません。