XTaskQueueSubmitDelayedCallback
Submits a callback to the queue for the given port.Syntax
Parameters
queue _In_Type: XTaskQueueHandle The queue to submit the callback to. port _In_
Type: XTaskQueuePort The port to submit the callback to. Callbacks can be assigned to work or completion ports. delayMs _In_
Type: uint32_t The number of milliseconds to delay before submitting the callback to the queue.
A callback can be submitted to be added to the queue some time in the future. If delayMs is non-zero the callback will be placed on a pending list and a timer is initialized with the next closest wait time. When the time elapses, the callback with the next time will be placed on the execution list. The queue will raise a XTaskQueueMonitorCallback, and if the queue is running in a thread pool dispatch mode, thread pool work will be submitted.
Type: void* An optional context pointer that will be passed to the callback. callback _In_
Type: XTaskQueueCallback* A pointer to the callback function.
Return value
Type: HRESULT HRESULT success or error code.Remarks
This callback will be added to the queue after delayMs milliseconds.Adding an item to a queue needs to be lock and wait free in order to satisfy the performance requirements of upstream code. The following APIs are lock free:
- XTaskQueueSubmitCallback
- XTaskQueueSubmitDelayedCallback
- XTaskQueueDispatch, provided that 0 is passed for timeoutInMs
SubmitCallback is a helper function that is defined in the code example for the XTaskQueueSubmitCallback function.
Requirements
Header: XTaskQueue.h Library: xgameruntime.lib Supported platforms: Windows, XBOX One family consoles and XBOX Series consolesSee also
XTaskQueue membersAsynchronous Programming Model
Async Task Queue design
