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

# XTaskQueueRegisterMonitor

> XTaskQueueRegisterMonitor

# XTaskQueueRegisterMonitor

注册一个回调，每当有回调提交到此队列时都会调用该回调。

## Syntax

```cpp theme={null}
HRESULT XTaskQueueRegisterMonitor(  
         XTaskQueueHandle queue,  
         void* callbackContext,  
         XTaskQueueMonitorCallback* callback,  
         XTaskQueueRegistrationToken* token  
)  
```

### Parameters

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

要向其注册提交回调的队列。

*callbackContext*   \_In\_opt\_\
类型：void\*

要传递给提交回调的可选上下文指针。

*callback*   \_In\_\
类型：[XTaskQueueMonitorCallback\*](https://docs.xbox.com/zh-CN/reference/system/xtaskqueue/functions/xtaskqueuemonitorcallback.md)

当新回调提交到队列时将调用的回调。

*token*   \_Out\_\
类型：[XTaskQueueRegistrationToken\*](https://docs.xbox.com/zh-CN/reference/system/xtaskqueue/structs/xtaskqueueregistrationtoken.md)

调用 [XTaskQueueUnregisterMonitor](https://docs.xbox.com/zh-CN/reference/system/xtaskqueue/functions/xtaskqueueunregistermonitor.md) 移除回调时使用的令牌。

### Return value

类型：HRESULT

HRESULT 成功或错误代码。

## Remarks

> [!NOTE]
>
> 此函数在时间敏感线程上调用不安全。有关详细信息，请参阅[时间敏感线程](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/console-dev/overviews/threads/time-sensitive-threads)。

以下示例展示了任务队列如何在有项要调度时向条件变量发出信号。应用程序可以使用它将其用于任务队列的线程与应用程序中的其他工作共享。

> [!NOTE]
>
> **SubmitCallback** 是在 [XTaskQueueSubmitCallback](https://docs.xbox.com/zh-CN/reference/system/xtaskqueue/functions/xtaskqueuesubmitcallback.md) 函数的代码示例中定义的帮助程序函数。

```cpp theme={null}
// We will use condition variables to signal when there is something for us 
// in the queue and a bool to signal when we want the whole thing to close.
// Keep all this in a struct for convenient access
struct QueueControl
{
    std::condition_variable workActivity;
    std::mutex workMutex;
    std::condition_variable completionActivity;
    std::mutex completionMutex;
    bool terminate = false;
} queueControl;

void CALLBACK TaskQueueNewItemSubmitted(void* context, XTaskQueueHandle, XTaskQueuePort port)
{
    // A new callback has been submitted. notify the correct condition variable
    QueueControl* queueControl = static_cast<QueueControl*>(context);
    switch (port)
    {
    case XTaskQueuePort::Work:
        queueControl->workActivity.notify_all();
        break;

    case XTaskQueuePort::Completion:
        queueControl->completionActivity.notify_all();
        break;
    }
}

void CreatingTaskQueueWithManualSignaling()
{
    // 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;
    }

    // Listen to callback submitted notifications to signal
    // our condition variable.
    XTaskQueueRegistrationToken token;
    hr = XTaskQueueRegisterMonitor(
        queue, &queueControl, 
        TaskQueueNewItemSubmitted, &token);

    std::thread workThread([&]()
    {
        std::unique_lock<std::mutex> lock(queueControl.workMutex);
        while (!queueControl.terminate)
        {
            queueControl.workActivity.wait(lock);
            XTaskQueueDispatch(queue, XTaskQueuePort::Work, 0);
        }
    });

    std::thread completionThread([&]()
    {
        std::unique_lock<std::mutex> lock(queueControl.completionMutex);
        while (!queueControl.terminate)
        {
            queueControl.completionActivity.wait(lock);
            XTaskQueueDispatch(queue, XTaskQueuePort::Completion, 0);
        }
    });

    SubmitCallbacks(queue);

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

    XTaskQueueTerminate(queue, true, nullptr, nullptr);

    queueControl.terminate = true;
    queueControl.workActivity.notify_all();
    queueControl.completionActivity.notify_all();

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

## Requirements

**头文件：** XTaskQueue.h

**库：** xgameruntime.lib

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

## Conceptual documentation

* [XTaskQueue 库概述](https://docs.xbox.com/zh-CN/build/core-features/common/async/async-libraries/async-library-xtaskqueue.md)
* [时间敏感线程](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/console-dev/overviews/threads/time-sensitive-threads)

## See also

[XTaskQueue 成员](https://docs.xbox.com/zh-CN/reference/system/xtaskqueue/xtaskqueue_members.md)\
[异步编程模型](https://docs.xbox.com/zh-CN/build/core-features/common/async/async-programming-model.md)\
[异步任务队列设计](https://docs.xbox.com/zh-CN/build/core-features/common/async/async-task-queue-design.md)


## Related topics

- [XTaskQueueUnregisterMonitor](https://docs.xbox.com/zh-CN/reference/system/xtaskqueue/functions/xtaskqueueunregistermonitor.md)
- [XTaskQueueMonitorCallback](https://docs.xbox.com/zh-CN/reference/system/xtaskqueue/functions/xtaskqueuemonitorcallback.md)
- [在 XSAPI C API 中进行异步调用](https://docs.xbox.com/zh-CN/services/xbox-services/fundamentals/xbox-services-api/live-flatc-async-patterns.md)
- [进行异步调用](https://docs.xbox.com/zh-CN/services/playfab/sdks/c/async.md)
- [在 PlayFab 统一 SDK 中进行异步调用](https://docs.xbox.com/zh-CN/services/playfab/sdks/unified-sdk/async-model.md)