APIリファレンス
GDAsyncContext
処理のキャンセルや制限時間を管理するオブジェクトです。親から子へ、最初のキャンセル理由と期限を伝えます。
プロパティ
reason: Err失敗の種類、説明、追加情報、原因、部分結果を持つ値です。Err.NOT_FOUNDなどは共有値で、直接返せます。独立した失敗はjoin()でまとめ、原因に同じ種類があるかはfind()で調べます。
メソッド
cancel(msg: String = "canceled", kind: Err = null) -> voidwith_cancel() -> GDAsyncContextwith_timeout(sec: float) -> GDAsyncContextis_done() -> bool
cancel
cancel(msg: String = "canceled", kind: Err = null) -> void英語原文Cancel a script context with a shared error category.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
msg | String | "canceled" | この操作に添えるメッセージ。 |
kind | Err | null | 分類・照合に使うエラー種別。 |
戻り値
void
値を返しません。
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
with_cancel
with_cancel() -> GDAsyncContext英語原文Create a child inheriting parent cancellation.
引数
引数はありません。
戻り値
GDAsyncContext
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
with_timeout
with_timeout(sec: float) -> GDAsyncContext制限時間を秒数で指定した子コンテキストを作ります。親の設定は変わりません。親をキャンセルすると、子もキャンセルされます。
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
sec | float | 省略不可 | キャンセルまでの秒数。 |
戻り値
GDAsyncContext
新しい子コンテキスト。
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
関連文書
is_done
is_done() -> bool英語原文Return whether cancellation or the deadline has completed this context.
引数
引数はありません。
戻り値
bool
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。