- XAsyncBlock は、非同期タスクと完了コールバックに関するすべての情報を保持します。
- XTaskQueueHandle を使用すると、どのスレッドが非同期タスクを実行し、どのスレッドが XAsyncBlock の完了コールバックを呼び出すかを決定できます。
XAsyncBlock
XAsyncBlock の詳細を見てみましょう。 これは次のように定義された構造体です:- queue - 作業を実行する場所についての情報を表すハンドルである XTaskQueueHandle。これが設定されていない場合、デフォルトキューが使用されます。
- context - コールバック関数にデータを渡すことができます。
- callback - 非同期作業が完了した後に呼び出されるオプションのコールバック関数。コールバックを指定しない場合は、XAsyncGetStatus で XAsyncBlock の完了を待ってから結果を取得できます。
重要: XAsyncBlock は、非同期タスクが完了するまでメモリに残っている必要があります。動的に割り当てられている場合、XAsyncBlock の完了コールバックの内部で削除できます。
非同期タスクの待機
非同期タスクが完了したことは、次のいくつかの異なる方法で確認できます:- XAsyncBlock の完了コールバックが呼び出される。
- XAsyncGetStatus を true で呼び出して、完了するまで待機する。
非同期タスクの結果の取得
結果を取得するには、ほとんどの非同期 API 関数には、対応する [Name of Function]Result 関数があり、非同期呼び出しの結果を受け取ります。 例のコードでは、XblProfileGetUserProfileAsync に対応する XblProfileGetUserProfileResult 関数があります。 この関数を使用して関数の結果を取得し、それに応じて動作させることができます。 結果の取得に関する詳細については、各非同期 API 関数のドキュメントを参照してください。XTaskQueueHandle
XTaskQueueHandle を使用すると、どのスレッドが非同期タスクを実行し、どのスレッドが XAsyncBlock の完了コールバックを呼び出すかを決定できます。 ディスパッチモードを設定することで、これらの操作を行うスレッドを制御できます。 利用可能なディスパッチモードは 3 つあります:- Manual - 手動キューは自動的にディスパッチされません。開発者が任意のスレッドでディスパッチする必要があります。これは、非同期呼び出しの作業側またはコールバック側のいずれかを特定のスレッドに割り当てるために使用できます。これについては後ほど詳しく説明します。
- Thread Pool - スレッドプールを使用してディスパッチします。スレッドプールは呼び出しを並行して実行し、スレッドプールのスレッドが利用可能になるにつれて、キューから順番に呼び出しを取り出して実行します。これは最も使いやすいですが、使用するスレッドに対する制御が最も少ないです。
- Serialized Thread Pool - スレッドプールを使用してディスパッチします。スレッドプールは呼び出しをシリアルに実行し、単一のスレッドプールスレッドが利用可能になるにつれて、キューから順番に呼び出しを取り出して実行します。
- Immediate - キューに入れられた作業を、送信されたスレッドから直ちにディスパッチします。
XTaskQueueDispatchMode パラメータを取ります。
XTaskQueueDispatchMode には 3 つの可能な値があります:
XTaskQueueHandle の手動ディスパッチ
XTaskQueueHandle の作業または完了キューに手動キューディスパッチモードを使用した場合、手動でディスパッチする必要があります。 作業キューと完了キューの両方が次のように手動でディスパッチされるように設定された XTaskQueueHandle が作成されたとしましょう:- queue - 作業をディスパッチするキュー。
- port - XTaskQueuePort 列挙型のインスタンス。
- timeoutInMs - ミリ秒単位のタイムアウトを表す uint32_t。
XTaskQueueDispatch を呼び出すタイミング
キューが新しい項目を受け取ったかどうかを確認するには、XTaskQueueRegisterMonitor を呼び出してイベントハンドラを設定し、作業または完了がディスパッチ可能になったことをコードに知らせることができます。- queue - コールバックを送信する非同期キュー。
- callbackContext - 送信コールバックに渡されるデータへのポインタ。
- callback - 新しいコールバックがキューに送信されるときに呼び出される関数。
- token - コールバックを削除するために XTaskQueueUnregisterMonitor の後の呼び出しで使用されるトークン。
XTaskQueueRegisterMonitor(queue, nullptr, HandleAsyncQueueCallback, &m_callbackToken);
対応する XTaskQueueMonitorCallback コールバックは、次のように実装できます:
