> ## 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

处理任务队列中给定端口的项。

## Syntax

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

### Parameters

*queue*   \_In\_\
类型：XTaskQueueHandle

要在其上调度工作的队列。

*port*   \_In\_\
类型：[XTaskQueuePort](/reference/system/xtaskqueue/enums/xtaskqueueport)

要调度的端口。

*timeoutInMs*   \_In\_\
类型：uint32\_t

返回 false 之前等待工作到达的毫秒数。可以传递 **INFINITE** 以永久等待。

### Return value

类型：bool

如果此函数调度了调用，则返回 true；否则返回 false。如果队列已终止，即使传入 **INFINITE** 作为超时，此函数也会返回 false。

## Remarks

可以传递超时，这将导致 **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();
}
```

## Requirements

**头文件：** XTaskQueue.h

**库：** xgameruntime.lib

**受支持的平台：** Windows、XBOX One 系列主机和 XBOX Series 主机

## Conceptual documentation

* [清理任务队列](/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)

## See also

[XTaskQueue 成员](/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](/zh-CN/reference/system/xtaskqueue/enums/xtaskqueuedispatchmode.md)
- [XTaskQueuePort](/zh-CN/reference/system/xtaskqueue/enums/xtaskqueueport.md)
- [在 XSAPI C API 中进行异步调用](/zh-CN/services/xbox-services/fundamentals/xbox-services-api/live-flatc-async-patterns.md)
- [进行异步调用](/zh-CN/services/playfab/sdks/c/async.md)
- [在 PlayFab 统一 SDK 中进行异步调用](/zh-CN/services/playfab/sdks/unified-sdk/async-model.md)