rtworkq.h header

This header is used by System Services. For more information, see:

• System Services

rtworkq.h contains the following programming interfaces:

Interfaces

IRtwqAsyncCallback Callback interface to notify the application when an asynchronous method completes. (IRtwqAsyncCallback)
IRtwqAsyncResult Provides information about the result of an asynchronous operation. (IRtwqAsyncResult)
IRtwqPlatformEvents Provides events related platform work queue.

Functions

RtwqAddPeriodicCallback Sets a callback function to be called at a fixed interval. (RtwqAddPeriodicCallback)
RtwqAllocateSerialWorkQueue Creates a virtual work queue on top of another work queue that is guaranteed to serialize work items. The serial work queue wraps an existing multithreaded work queue. The serial work queue enforces a first-in, first-out (FIFO) execution order.
RtwqAllocateWorkQueue Creates a new work queue. (RtwqAllocateWorkQueue)
RtwqBeginRegisterWorkQueueWithMMCSS Associates a work queue with a Multimedia Class Scheduler Service (MMCSS) task. (RtwqBeginRegisterWorkQueueWithMMCSS)
RtwqBeginUnregisterWorkQueueWithMMCSS Unregisters a work queue from a Multimedia Class Scheduler Service (MMCSS) task. (RtwqBeginUnregisterWorkQueueWithMMCSS)
RtwqCancelDeadline Cancels a deadline that was previously set with RtwqSetDeadline.
RtwqCancelWorkItem Attempts to cancel an asynchronous operation that was scheduled with RtwqScheduleWorkItem.
RtwqCreateAsyncResult Creates an asynchronous result object. Use this function if you are implementing an asynchronous method. (RtwqCreateAsyncResult)
RtwqEndRegisterWorkQueueWithMMCSS Completes an asynchronous request to associate a work queue with a Multimedia Class Scheduler Service (MMCSS) task. (RtwqEndRegisterWorkQueueWithMMCSS)
RtwqGetWorkQueueMMCSSClass Retrieves the Multimedia Class Scheduler Service (MMCSS) class currently associated with this work queue. (RtwqGetWorkQueueMMCSSClass)
RtwqGetWorkQueueMMCSSPriority Gets the relative thread priority of a work queue. (RtwqGetWorkQueueMMCSSPriority)
RtwqGetWorkQueueMMCSSTaskId Retrieves the Multimedia Class Scheduler Service (MMCSS) task identifier currently associated with this work queue. (RtwqGetWorkQueueMMCSSTaskId)
RtwqInvokeCallback Invokes a callback method to complete an asynchronous operation. (RtwqInvokeCallback)
RtwqJoinWorkQueue Associates a work queue with an input/output (I/O) handle.
RtwqLockPlatform Adds a reference to indicate to the platform that there are still pending asynchronous items. Blocks the RtwqShutdown function if there are active asynchronous items.
RtwqLockSharedWorkQueue Obtains and locks a shared work queue. (RtwqLockSharedWorkQueue)
RtwqLockWorkQueue Locks a work queue. (RtwqLockWorkQueue)
RtwqPutWaitingWorkItem Queues a work item that waits for an event to be signaled. (RtwqPutWaitingWorkItem)
RtwqPutWorkItem Puts an asynchronous operation on a work queue. (RtwqPutWorkItem)
RtwqRegisterPlatformEvents Enables an app to listen to the RtwqStartup and RtwqShutdown functions.
RtwqRegisterPlatformWithMMCSS Registers the standard platform work queues with the Multimedia Class Scheduler Service (MMCSS).
RtwqRemovePeriodicCallback Cancels a callback function that was set by the RtwqAddPeriodicCallback function.
RtwqScheduleWorkItem Schedules an asynchronous operation to be completed after a specified interval. (RtwqScheduleWorkItem)
RtwqSetDeadline Sets a deadline by which the work in a work queue must be completed. (RtwqSetDeadline)
RtwqSetDeadline2 Sets a deadline by which the work in a work queue must be completed. (RtwqSetDeadline2)
RtwqSetLongRunning Indicates that the app will be submitting a hint that long running work will occur on this work queue.
RtwqShutdown Shuts down the platform. Call this function once for every call to RtwqStartup. Do not call this function from work queue threads.
RtwqStartup Initializes the platform.
RtwqUnjoinWorkQueue Disassociates a work queue from an input/output (I/O) handle.
RtwqUnlockPlatform Unlocks the platform after it was locked by a call to the RtwqLockPlatform function.
RtwqUnlockWorkQueue Unlocks a work queue. (RtwqUnlockWorkQueue)
RtwqUnregisterPlatformEvents Unregisters a listener event from the callback platform.
RtwqUnregisterPlatformFromMMCSS Unregisters the platform work queues from a Multimedia Class Scheduler Service (MMCSS) task.

Enumerations

RTWQ_WORKQUEUE_TYPE Specifies the type of work queue for the RtwqAllocateWorkQueue function to create.