> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# XTaskQueueDispatch

> XTaskQueueDispatch

# XTaskQueueDispatch

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

## 構文

```cpp theme={null}
bool XTaskQueueDispatch(  
         XTaskQueueHandle queue,  
         XTaskQueuePort port,  
         uint32_t timeoutInMs  
)  
```

### パラメーター

*queue*   \_In\_\
Type: XTaskQueueHandle

作業をディスパッチする対象のキューです。

*port*   \_In\_\
Type: [XTaskQueuePort](/reference/system/xtaskqueue/enums/xtaskqueueport)

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

*timeoutInMs*   \_In\_\
Type: uint32\_t

false を返す前に作業の到着を待機するミリ秒数です。永久に待機するには **INFINITE** を渡すことができます。

### 戻り値

Type: bool

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

## 解説

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

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

<img src="https://mintcdn.com/microsoft-4404708b/gzrdvT5kpqAXKEQt/images/gdk/reference/note.gif?s=6c1a4c009b25ad5315c45ce51bc83983" alt="alert" width="10" height="10" data-path="images/gdk/reference/note.gif" /> **パフォーマンスに関する注:**\
上位のコードのパフォーマンス要件を満たすためには、キューへの項目の追加はロックフリーかつ待機フリーである必要があります。次の API はロックフリーです:

* [XTaskQueueSubmitCallback](/reference/system/xtaskqueue/functions/xtaskqueuesubmitcallback)
* [XTaskQueueSubmitDelayedCallback](/reference/system/xtaskqueue/functions/xtaskqueuesubmitdelayedcallback)
* [XTaskQueueDispatch](/reference/system/xtaskqueue/functions/xtaskqueuedispatch) (ただし *timeoutInMs* に 0 が渡される場合)

<img src="https://mintcdn.com/microsoft-4404708b/gzrdvT5kpqAXKEQt/images/gdk/reference/note.gif?s=6c1a4c009b25ad5315c45ce51bc83983" alt="alert" width="10" height="10" data-path="images/gdk/reference/note.gif" /> **パフォーマンスに関する注:**\
[XTaskQueueDispatch](/reference/system/xtaskqueue/functions/xtaskqueuedispatch) がワーク ポートからの項目を処理するときに費やす時間は変動し、実行される作業に依存します。
場合によっては、呼び出し元のスレッドは他のシステム作業の完了を待機してブロックされることがあります。

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

<Note>**SubmitCallback** は、[XTaskQueueSubmitCallback](/reference/system/xtaskqueue/functions/xtaskqueuesubmitcallback) 関数のコード例で定義されているヘルパー関数です。</Note>

```cpp theme={null}
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 本体

## 概念ドキュメント

* [タスク キューのクリーンアップ](/build/core-features/common/async/async-libraries/async-library-xtaskqueue-example-cleanup-task-queue)
* [タスク キューのディスパッチ](/build/core-features/common/async/async-libraries/async-library-xtaskqueue-example-dispatch-task-queue)
* [XTaskQueue ライブラリの概要](/build/core-features/common/async/async-libraries/async-library-xtaskqueue)
* [非同期プログラミング モデル](/build/core-features/common/async/async-programming-model)
* [非同期プログラミングの設計目標と改善点](/build/core-features/common/async/async-whitepaper)

## 関連項目

[XTaskQueue members](/reference/system/xtaskqueue/xtaskqueue_members)\
[非同期プログラミング モデル](/build/core-features/common/async/async-programming-model)\
[非同期タスク キューの設計](/build/core-features/common/async/async-task-queue-design)


## Related topics

- [XTaskQueueDispatchMode](/ja-jp/reference/system/xtaskqueue/enums/xtaskqueuedispatchmode.md)
- [XTaskQueuePort](/ja-jp/reference/system/xtaskqueue/enums/xtaskqueueport.md)
- [XSAPI C API で非同期呼び出しを行う](/ja-jp/services/xbox-services/fundamentals/xbox-services-api/live-flatc-async-patterns.md)
- [非同期呼び出しの実行](/ja-jp/services/playfab/sdks/c/async.md)
- [PlayFab 統合 SDK での非同期呼び出し](/ja-jp/services/playfab/sdks/unified-sdk/async-model.md)