MxEvent Class Reference

#include <mxevent.h>

Collaboration diagram for MxEvent:

Public Member Functions
__inline	MxEvent ()
__inline	~MxEvent ()
CHECK_RETURN_IF_USER_MODE __inline NTSTATUS	Initialize (__in EVENT_TYPE Type, __in BOOLEAN InitialState)
__inline PVOID	GetEvent ()
__inline VOID	Set ()
__inline VOID	SetWithIncrement (__in KPRIORITY Priority)
__inline VOID	Clear ()
	__drv_when (Timeout==NULL &&Alertable==FALSE, __drv_valueIs(==0)) __drv_when(Timeout !
	__drv_valueIs (==0;==258)) __drv_when(Timeout !
_Must_inspect_result_ __inline NTSTATUS	WaitFor (__in KWAIT_REASON WaitReason, __in KPROCESSOR_MODE WaitMode, __in BOOLEAN Alertable, __in_opt PLARGE_INTEGER Timeout)
__inline LONG	ReadState ()
__inline VOID	Uninitialize ()
MxEvent *	GetSelfPointer (VOID)

Private Member Functions
MxEvent *	operator& (VOID)

Private Attributes
MdEvent	m_Event
	DECLARE_DBGFLAG_INITIALIZED

Detailed Description

Definition at line 28 of file mxevent.h.

Constructor & Destructor Documentation

MxEvent()

__inline MxEvent::MxEvent

(

)

Definition at line 31 of file mxeventkm.h.

{
    //
    // Make sure that m_Event is the first member. That way if someone passes
    // address of MxEvent to Ke*Event functions, it would still work.
    //
    // If this statement causes compilation failure, check if you added a field
    // before m_Event.
    //
    C_ASSERT(FIELD_OFFSET(MxEvent, m_Event) == 0);
 
    CLEAR_DBGFLAG_INITIALIZED;
}

~MxEvent()

__inline MxEvent::~MxEvent

(

)

Definition at line 46 of file mxeventkm.h.

{
}

Member Function Documentation

__drv_valueIs()

MxEvent::__drv_valueIs

(

)

__drv_when()

MxEvent::__drv_when	(	Timeout	= = NULL && Alertable == FALSE,
		__drv_valueIs(==0)
	)

Clear()

__inline VOID MxEvent::Clear

(

)

Definition at line 102 of file mxeventkm.h.

{
    ASSERT_DBGFLAG_INITIALIZED;
 
    KeClearEvent(&m_Event);
}

Referenced by FxChildList::BeginIteration(), FxChildList::BeginScan(), FxCREvent::Clear(), FxUsbPipe::GotoStartState(), FxIoQueue::StartPowerTransitionOff(), FxIoQueue::StopProcessingForPower(), and FxSystemThread::Thread().

GetEvent()

__inline PVOID MxEvent::GetEvent

(

)

Definition at line 69 of file mxeventkm.h.

{
    ASSERT_DBGFLAG_INITIALIZED;
 
    return &m_Event;
}

Referenced by FxCREvent::GetEvent().

GetSelfPointer()

MxEvent * MxEvent::GetSelfPointer ( VOID  )

inline

Definition at line 110 of file mxevent.h.

    {
        //
        // Since operator& is hidden, we still need to be able to get a pointer
        // to this object, so we must make it an explicit method.
        //
        return this;
    }

Referenced by FxPkgPdo::_PnpEject(), FxPkgPnp::_PnpRemoveDevice(), FxDevice::DeleteDeviceFromFailedCreateNoDelete(), FxIoQueue::Dispose(), FxChildList::GetScanEvent(), FxIoQueue::QueueDrainSynchronously(), FxIoQueue::QueueIdleSynchronously(), FxIoQueue::QueuePurgeSynchronously(), FxIoQueue::StartPowerTransitionOff(), FxIoQueue::StopProcessingForPower(), and FxInterrupt::WakeInterruptIsr().

Initialize()

_Must_inspect_result_ __inline NTSTATUS MxEvent::Initialize	(	__in EVENT_TYPE	Type,
		__in BOOLEAN	InitialState
	)

Definition at line 55 of file mxeventkm.h.

{
    KeInitializeEvent(&m_Event, Type, InitialState);
 
    SET_DBGFLAG_INITIALIZED;
 
    return STATUS_SUCCESS;
}

Referenced by FxPkgPnp::_PnpRemoveDevice(), FxUsbPipeContinuousReader::Config(), FxInterrupt::CreateWakeInterruptMachine(), FxDevice::DeleteDeviceFromFailedCreateNoDelete(), FxAllocateDriverGlobals(), FxChildList::FxChildList(), FxCREvent::FxCREvent(), FxSystemThread::FxSystemThread(), FxCREvent::Initialize(), FxIoQueue::Initialize(), FxPkgPnp::Initialize(), FxIoQueue::QueueDrainSynchronously(), FxIoQueue::QueueIdleSynchronously(), and FxIoQueue::QueuePurgeSynchronously().

operator&()

MxEvent * MxEvent::operator& ( VOID  )

inlineprivate

Definition at line 122 of file mxevent.h.

    {
        //
        // By making the address of operator private, we make it harder
        // to accidentally use this object in an improper fashion, ie
        // something like this is prevented:
        //
        // MxEvent event;
        // KeWaitForSingleObject(&event, ...);
        //
        // However please note that in some cases event pointer is needed when
        // event is passed around, in which case, GetSelfPointer() is used and
        // this protection is circumvented. Calling code should be careful
        // not to pass the pointer to KeWaitForSingleObject in such cases.
        //
        ASSERT(FALSE);
        return NULL;
    }

ReadState()

LONG __inline MxEvent::ReadState

(

)

Definition at line 135 of file mxeventkm.h.

{
    ASSERT_DBGFLAG_INITIALIZED;
 
    return KeReadStateEvent(&m_Event);
}

Referenced by FxCREvent::ReadState().

Set()

__inline VOID MxEvent::Set

(

)

Definition at line 91 of file mxeventkm.h.

{
    ASSERT_DBGFLAG_INITIALIZED;
 
    KeSetEvent(&m_Event, IO_NO_INCREMENT, FALSE);
}

Referenced by FxChildList::EndScan(), FxSystemThread::ExitThread(), FxSystemThread::ExitThreadAsync(), FxPkgPdo::PnpEventEjectHardwareOverload(), FxSystemThread::QueueWorkItem(), _FX_DRIVER_GLOBALS::Release(), FxCREvent::Set(), FxPkgPnp::SignalDeviceRemovedEvent(), and FxSystemThread::Thread().

SetWithIncrement()

__inline VOID MxEvent::SetWithIncrement

(

__in KPRIORITY

Priority

)

Definition at line 80 of file mxeventkm.h.

{
    ASSERT_DBGFLAG_INITIALIZED;
 
    KeSetEvent(&m_Event, Priority, FALSE);
}

Uninitialize()

__inline VOID MxEvent::Uninitialize

(

)

Definition at line 146 of file mxeventkm.h.

{
    CLEAR_DBGFLAG_INITIALIZED;
}

Referenced by FxFreeDriverGlobals().

WaitFor()

_Must_inspect_result_ __inline NTSTATUS MxEvent::WaitFor	(	__in KWAIT_REASON	WaitReason,
		__in KPROCESSOR_MODE	WaitMode,
		__in BOOLEAN	Alertable,
		__in_opt PLARGE_INTEGER	Timeout
	)

Definition at line 115 of file mxeventkm.h.

{
    ASSERT_DBGFLAG_INITIALIZED;
 
    return KeWaitForSingleObject(
                    &m_Event,
                    WaitReason,
                    WaitMode,
                    Alertable,
                    Timeout
                    );
}

Referenced by FxCREvent::__drv_valueIs(), FxCREvent::_Acquires_lock_(), FxSystemThread::ExitThread(), FxSystemThread::Reaper(), and FxSystemThread::Thread().

Member Data Documentation

DECLARE_DBGFLAG_INITIALIZED

MxEvent::DECLARE_DBGFLAG_INITIALIZED

private

Definition at line 38 of file mxevent.h.

m_Event

MdEvent MxEvent::m_Event

private

Definition at line 36 of file mxevent.h.

Referenced by __drv_when(), Clear(), GetEvent(), Initialize(), MxEvent(), ReadState(), Set(), and SetWithIncrement().

---

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

• sdk/lib/drivers/wdf/shared/inc/primitives/common/mxevent.h
• sdk/lib/drivers/wdf/shared/inc/primitives/km/mxeventkm.h
• sdk/lib/drivers/wdf/shared/inc/primitives/um/mxeventum.h