#include <mxworkitem.h>

Inheritance diagram for MxWorkItem:

Collaboration diagram for MxWorkItem:

[legend]

Public Member Functions
__inline	MxWorkItem ()

VOID	WaitForCallbacksToComplete (VOID)

_Must_inspect_result_ __inline NTSTATUS	Allocate (__in MdDeviceObject DeviceObject, __in_opt PVOID ThreadPoolEnv=NULL)

__inline VOID	Enqueue (__in PMX_WORKITEM_ROUTINE Callback, __in PVOID Context)

__inline MdWorkItem	GetWorkItem ()

__inline VOID	Free ()

__inline	~MxWorkItem ()

Static Public Member Functions
static VOID CALLBACK	_WorkerThunk (_Inout_ PTP_CALLBACK_INSTANCE Instance, _Inout_opt_ PVOID Parameter, _Inout_ PTP_WAIT Wait, _In_ TP_WAIT_RESULT WaitResult)

static __inline VOID	_Free (__in MdWorkItem Item)

Protected Attributes
MdWorkItem	m_WorkItem

Detailed Description

Definition at line 28 of file mxworkitem.h.

Constructor & Destructor Documentation

◆ MxWorkItem()

__inline MxWorkItem::MxWorkItem ( )

Definition at line 32 of file mxworkitemkm.h.

{
    m_WorkItem = NULL;
}

◆ ~MxWorkItem()

__inline MxWorkItem::~MxWorkItem ( )

inline

Definition at line 95 of file mxworkitem.h.

97 {

98 }

Member Function Documentation

◆ _Free()

__inline VOID MxWorkItem::_Free ( __in MdWorkItem Item )

static

Definition at line 81 of file mxworkitemkm.h.

{
    IoFreeWorkItem(Item);
}

Referenced by FxPkgPdo::_QueryCapsWorkItem(), and Free().

◆ _WorkerThunk()

VOID CALLBACK MxWorkItem::_WorkerThunk	(	_Inout_ PTP_CALLBACK_INSTANCE	Instance,
		_Inout_opt_ PVOID	Parameter,
		_Inout_ PTP_WAIT	Wait,
		_In_ TP_WAIT_RESULT	WaitResult
	)

static

Definition at line 30 of file mxworkitemum.cpp.

{
    MdWorkItem workItem = (MdWorkItem) Parameter;
 
    UNREFERENCED_PARAMETER(Instance);
    UNREFERENCED_PARAMETER(Wait);
    UNREFERENCED_PARAMETER(WaitResult);
 
    (*workItem->Callback)(
        workItem->DeviceObject,
        workItem->Context
        );
 
    return;
}

◆ Allocate()

_Must_inspect_result_ __inline NTSTATUS MxWorkItem::Allocate	(	__in MdDeviceObject	DeviceObject,
		__in_opt PVOID	ThreadPoolEnv = `NULL`
	)

Definition at line 41 of file mxworkitemkm.h.

{
    UNREFERENCED_PARAMETER(ThreadPoolEnv);
 
    m_WorkItem = IoAllocateWorkItem(DeviceObject);
    if (NULL == m_WorkItem) {
        return STATUS_INSUFFICIENT_RESOURCES;
    }
 
    return STATUS_SUCCESS;
}

Referenced by FxWorkItemEventQueue::Init(), FxThreadedEventQueue::Init(), FxSystemWorkItem::Initialize(), FxWorkItem::Initialize(), FxPkgPnp::PnpDeviceUsageNotification(), and FxPkgPdo::PnpQueryCapabilities().

◆ Enqueue()

__inline VOID MxWorkItem::Enqueue	(	__in PMX_WORKITEM_ROUTINE	Callback,
		__in PVOID	Context
	)

Definition at line 58 of file mxworkitemkm.h.

{
    IoQueueWorkItem(
        m_WorkItem,
        Callback,
        DelayedWorkQueue,
        Context
        );
}

Referenced by FxSystemWorkItem::EnqueueWorker(), FxPkgPdo::PnpQueryCapabilities(), FxWorkItemEventQueue::QueueWorkItem(), and FxThreadedEventQueue::QueueWorkItem().

◆ Free()

__inline VOID MxWorkItem::Free ( )

Definition at line 90 of file mxworkitemkm.h.

{
    if (NULL != m_WorkItem) {
        MxWorkItem::_Free(m_WorkItem);
        m_WorkItem = NULL;
    }
}

Referenced by FxSystemWorkItem::~FxSystemWorkItem(), FxThreadedEventQueue::~FxThreadedEventQueue(), FxWorkItem::~FxWorkItem(), FxWorkItemEventQueue::~FxWorkItemEventQueue(), and MxAutoWorkItem::~MxAutoWorkItem().

◆ GetWorkItem()

__inline MdWorkItem MxWorkItem::GetWorkItem ( )

Definition at line 73 of file mxworkitemkm.h.

{
    return m_WorkItem;
}

Referenced by FxSystemWorkItem::EnqueueWorker(), FxWorkItem::GetWorkItemPtr(), FxSystemWorkItem::GetWorkItemPtr(), FxSystemWorkItem::Initialize(), FxWorkItem::Initialize(), FxPkgPdo::PnpQueryCapabilities(), FxSystemWorkItem::~FxSystemWorkItem(), and FxWorkItem::~FxWorkItem().

◆ WaitForCallbacksToComplete()

VOID MxWorkItem::WaitForCallbacksToComplete ( VOID )

Definition at line 52 of file mxworkitemum.cpp.

{
    Mx::MxAssert(NULL != m_WorkItem->WaitBlock);
 
    //
    // Wait for outstanding callbacks to complete.
    //
    WaitForThreadpoolWaitCallbacks(m_WorkItem->WaitBlock,
                           FALSE  // donot cancel pending waits
                           );
 
}

Member Data Documentation

◆ m_WorkItem

MdWorkItem MxWorkItem::m_WorkItem

protected

Definition at line 32 of file mxworkitem.h.

Referenced by Allocate(), Enqueue(), Free(), GetWorkItem(), MxWorkItem(), and WaitForCallbacksToComplete().

The documentation for this class was generated from the following files:

sdk/lib/drivers/wdf/shared/inc/primitives/common/mxworkitem.h
sdk/lib/drivers/wdf/shared/inc/primitives/km/mxworkitemkm.h
sdk/lib/drivers/wdf/shared/inc/primitives/um/mxworkitemum.h
sdk/lib/drivers/wdf/shared/primitives/um/mxworkitemum.cpp

Public Member Functions

Static Public Member Functions

Protected Attributes