APIリファレンス
GD.async
非同期処理を開始したり、複数の処理の完了を待ったり、タイムアウトやキャンセルを扱ったりします。最初に完了した処理の結果を受け取ることもできます。spawnは関数をメインスレッド上で開始します。大きなデータの計算には、各標準モジュールの_async付き関数を使います。
:=で保存したSignalは完了時の型も保持します。異なる型や型不明のSignalは再代入できません。汎用のSignalを保存してから待つ場合、二値の完了通知はArrayで届くので、result[0]とresult[1]を読みます。
長いGDScriptは自動的にほかの処理へ実行権を譲りますが、ネイティブメソッドの内部は中断しません。
待つメソッドを呼べるのは、GDScriptから呼ばれた関数の中だけです。Array.map()のコールバック、_init()、メンバー変数の初期化、_to_string()などのネイティブコールバックは完了を待てません。中にawaitを書いても、ネイティブの呼び出し元は結果を待ちません。
メソッド
set_max_threads(max: int) -> intsleep(sec: float) -> Signalspawn(fn: Callable) -> Signalspawn_pair(fn: Callable) -> await Variant, Errcall_pair(fn: Callable) -> Variant, Errall(signals: Array) -> await Arrayrace(signals: Array) -> await intwith_timeout(signal: Signal, sec: float) -> await intwith_context(context: GDAsyncContext, signal: Signal) -> await Variantwith_context_pair(context: GDAsyncContext, signal: Signal) -> await Variant, Errcontext() -> GDAsyncContext
set_max_threads
set_max_threads(max: int) -> intgdが管理するOSスレッドの上限を設定し、以前の値を返します。
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
max | int | 省略不可 | 実行環境全体の管理対象スレッド数の上限。呼び出しは前の上限を返します。 |
戻り値
int
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
既定は10000です。上限を越えるとプロセスが終了します。現在の数より小さい値へ変更した場合も終了します。外部ライブラリが直接作るスレッドは数えません。
sleep
sleep(sec: float) -> Signal英語原文Return a signal emitted after the specified delay.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
sec | float | 省略不可 | 小数を含む秒単位の時間。 |
戻り値
Signal
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
spawn
spawn(fn: Callable) -> Signal渡した関数をメインスレッド上で開始し、完了を知らせるSignalを返します。ほかの処理と交代しながら動きますが、CPU負荷の高いスクリプトを別スレッドへ移す機能ではありません。大きなデータの処理には、別スレッドで処理できる標準APIを使います。
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
fn | Callable | 省略不可 | 開始するCallable。 |
戻り値
Signal
Callableの完了を通知するSignal。
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
関連文書
spawn_pair
spawn_pair(fn: Callable) -> await Variant, Err英語原文Start a callable with separate value and error completion slots.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
fn | Callable | 省略不可 | 呼び出す関数(Callable)。受け取る引数は、このAPIの説明を参照してください。 |
戻り値
await Variant, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
call_pair
call_pair(fn: Callable) -> Variant, Err動的に選んだCallableを呼び、値とErrを二つの結果として受け取ります。
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
fn | Callable | 省略不可 | 呼び出す関数(Callable)。受け取る引数は、このAPIの説明を参照してください。 |
戻り値
Variant, Err
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
all
all(signals: Array) -> await Array渡したすべての処理が終わるのを待ちます。Callableは呼び出してから結果を待ち、Signalは完了を待ちます。結果は渡した順番の配列で返し、完了した順番には並べ替えません。
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
signals | Array | 省略不可 | 待ちたいSignalや、開始したい関数(Callable)を並べた配列。 |
戻り値
await Array
各処理の結果を並べた配列です。すべての処理が終わっても、すべて成功したとは限らないため、各結果のエラーを確認してください。
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
待てない入力は、対応する位置の結果がErrになります。メッセージに位置と理由が入り、info.indexで位置を読めます。SignalよりCallableを渡してください。完了通知を受け取る準備をしてから開始するため、先に終わった処理の結果を取りこぼしません。
関連文書
race
race(signals: Array) -> await int英語原文Return the index of the first completed signal.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
signals | Array | 省略不可 | 待ちたいSignalや開始したい関数(Callable)を、結果を受け取りたい順番に並べた配列。 |
戻り値
await int
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
with_timeout
with_timeout(signal: Signal, sec: float) -> await int英語原文Wait for an operation or its deadline, whichever comes first.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
signal | Signal | 省略不可 | 待ちたい処理の完了を知らせるSignal。 |
sec | float | 省略不可 | 小数を含む秒単位の時間。 |
戻り値
await int
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
with_context
with_context(context: GDAsyncContext, signal: Signal) -> await Variantコンテキストのキャンセルを確認しながら、処理の完了を待ちます。Webリクエストの接続が切れた場合などに処理を止めたいときは、req.contextを渡します。
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
context | GDAsyncContext | 省略不可 | キャンセルや制限時間を管理するコンテキスト。 |
signal | Signal | 省略不可 | 待ちたい処理の完了を知らせるSignal。発行元はRefCountedを継承し、cancel()を持ち、まだ解放されていない必要があります。任意のSignalを渡せるわけではありません。 |
戻り値
await Variant
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
関連文書
with_context_pair
with_context_pair(context: GDAsyncContext, signal: Signal) -> await Variant, Err英語原文Propagate context cancellation while preserving both result slots.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
context | GDAsyncContext | 省略不可 | キャンセルや制限時間を管理するコンテキスト。 |
signal | Signal | 省略不可 | 待ちたい処理の完了を知らせるSignal。 |
戻り値
await Variant, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
context
context() -> GDAsyncContext英語原文Create a context that shares a cancellation reason.
引数
引数はありません。
戻り値
GDAsyncContext
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。