Share via

XTaskQueue

  • Article

XTaskQueue APIs

Functions

Function Description
XTaskQueueCallback A callback that is invoked by the task queue.
XTaskQueueCloseHandle Closes the task queue.
XTaskQueueCreate Creates a task queue, which can be used to queue and dispatch calls.
XTaskQueueCreateComposite Creates a task queue composed of ports of other task queues.
XTaskQueueDispatch Processes an item in the task queue for the given port.
XTaskQueueDuplicateHandle Duplicates a XTaskQueueHandle object.
XTaskQueueGetCurrentProcessTaskQueue Obtains a handle to the process task queue, or nullptr if there is no process task queue.
XTaskQueueGetPort Returns the task queue port handle for the given port.
XTaskQueueMonitorCallback A callback that is invoked by the task queue whenever a task is submitted for execution.
XTaskQueueRegisterMonitor Registers a callback that will be invoked whenever a callback is submitted to this queue.
XTaskQueueRegisterWaiter Registers a wait handle with a task queue.
XTaskQueueSetCurrentProcessTaskQueue Sets the given task queue as the process wide task queue.
XTaskQueueSubmitCallback Submits a callback to the queue for the given port.
XTaskQueueSubmitDelayedCallback Submits a callback to the queue for the given port.
XTaskQueueTerminate Terminates a task queue by canceling all pending items and preventning new items from being queued.
XTaskQueueTerminatedCallback A callback that is invoked when a task queue is terminated.
XTaskQueueUnregisterMonitor Unregisters a previously registered monitor callback.
XTaskQueueUnregisterWaiter Unregisters a previously registered task queue waiter.

Structures

Structure Description
XTaskQueueRegistrationToken A token returned when registering a callback, to identify the registration.

Enumerations

Enumeration Description
XTaskQueueDispatchMode Describes how task queue callbacks are processed.
XTaskQueuePort Declares which port of a task queue to dispatch or submit callbacks to.

See also

System API reference
Asynchronous Programming Design Goals and Improvements
Asynchronous Programming Model
Async Task Queue design