次の方法で共有

XTaskQueueDispatch

  • [アーティクル]

指定されたポートのタスク キュー内の項目を処理します。

構文

bool XTaskQueueDispatch(  
         XTaskQueueHandle queue,  
         XTaskQueuePort port,  
         uint32_t timeoutInMs  
)

パラメーター

queue _In_
型: XTaskQueueHandle

処理をディスパッチするキュー。

port _In_
型: XTaskQueuePort

ディスパッチするポート。

timeoutInMs _In_
型: uint32_t

false を返す前に処理が到着するのを待機するミリ秒数。 INFINITE を渡して無期限に待機できます。

戻り値

型: bool

この関数が呼び出しをディスパッチした場合は true を返し、ディスパッチしなかった場合は false を返します。 また、この関数は、タイムアウトとして INFINITE を渡された場合でも、キューが終了された場合は false を返します。

解説

タイムアウトを渡すことができ、これにより XTaskQueueDispatch はキューに何かが到着するまで待ちます。

XTaskQueueDispatchMode::ThreadPool、XTaskQueueDispatchMode::SerializedThreadPool、XTaskQueueDispatchMode::Immediate のいずれかのディスパッチ モードでタスク キューのポートが作成された場合、コールバックを自動的にディスパッチします。 手動ディスパッチ ポートの場合は、XTaskQueueDispatch を呼び出す必要があります。 任意のディスパッチ モードに対して XTaskQueueDispatch を呼び出すことができますが、呼び出しは常に XTaskQueueDispatch を呼び出すスレッドでディスパッチされることに注意してください。

alert パフォーマンス 注:
キューへのアイテムの追加は、上流コードのパフォーマンス要件を満たすためには、ロック フリーかつ待機フリーであることが必要です。 次の API はロック フリーです。

alert パフォーマンス 注:
作業ポートからアイテムを処理するときに XTaskQueueDispatch が費やす時間は可変であり、実行されている作業によって異なります。 場合によっては、呼び出し元のスレッドが他のシステム作業が完了するのを待つのをブロックすることがあります。

次の例では、XTaskQueueDispatch 関数を使用してタスク キュー内の項目を処理する方法を示します。

注意

SubmitCallback は、XTaskQueueSubmitCallback 関数のコード例で定義されているヘルパー関数です。

void CreatingTaskQueueWithManualThreads()
{
    // Create a manual task queue
    XTaskQueueHandle queue;
    HRESULT hr = XTaskQueueCreate(XTaskQueueDispatchMode::Manual, XTaskQueueDispatchMode::Manual, &queue);
    if (FAILED(hr))
    {
        printf("Creating queue failed: 0x%x\r\n", hr);
        return;
    }

    // We create threads to pump the queue: one for the work port
    // and one for the completion port.
    std::thread workThread([queue]
    {
        while (XTaskQueueDispatch(queue, XTaskQueuePort::Work, INFINITE));
    });

    std::thread completionThread([queue]
    {
        while (XTaskQueueDispatch(queue, XTaskQueuePort::Completion, INFINITE));
    });

    SubmitCallbacks(queue);

    // Wait a while for the callbacks to run
    Sleep(1000);

    // Terminating the queue will cause a waiting DispatchTaskQueue to return
    // false.  
    XTaskQueueTerminate(queue, true, nullptr, nullptr);

    workThread.join();
    completionThread.join();
}

要件

ヘッダー: XTaskQueue.h

ライブラリ: xgameruntime.lib

サポートされているプラットフォーム: Windows、Xbox One ファミリー本体、Xbox Series 本体

関連項目

XTaskQueue のメンバー
非同期プログラミング モデル
非同期タスク キューの設計