MxTimer Class Reference

#include <mxtimer.h>

Collaboration diagram for MxTimer:

Public Member Functions
__inline	MxTimer (VOID)
__inline	~MxTimer (VOID)
CHECK_RETURN_IF_USER_MODE __inline NTSTATUS	Initialize (__in_opt PVOID TimerContext, __in MdDeferredRoutine TimerCallback, __in LONG Period)
CHECK_RETURN_IF_USER_MODE __inline NTSTATUS	InitializeEx (__in_opt PVOID TimerContext, __in MdExtCallbackType TimerCallback, __in LONG Period, __in ULONG TolerableDelay, __in BOOLEAN UseHighResolutionTimer)
__inline VOID	Start (__in LARGE_INTEGER DueTime, __in ULONG TolerableDelay=0)
__inline BOOLEAN	StartWithReturn (__in LARGE_INTEGER DueTime, __in ULONG TolerableDelay=0)
_Must_inspect_result_ __inline BOOLEAN	Stop (VOID)
__inline VOID	FlushQueuedDpcs (VOID)

Private Attributes
MdTimer	m_Timer

Detailed Description

Definition at line 27 of file mxtimer.h.

Constructor & Destructor Documentation

MxTimer()

MxTimer::MxTimer

(

VOID

)

Definition at line 83 of file mxtimerkm.h.

{
    m_Timer.m_TimerContext = NULL;
    m_Timer.m_TimerCallback = NULL;
    m_Timer.m_Period = 0;
    m_Timer.m_KernelExTimer = NULL;
}

~MxTimer()

MxTimer::~MxTimer

(

VOID

)

Definition at line 93 of file mxtimerkm.h.

{
    // __REACTOS__ Ex timers are not supported
    // BOOLEAN wasCancelled;
 
    // if (m_Timer.m_IsExtTimer &&
    //     m_Timer.m_KernelExTimer) {
    //     wasCancelled = ExDeleteTimer(m_Timer.m_KernelExTimer,
    //                                  TRUE, // Cancel if pending. We don't expect
    //                                        // it to be pending though
    //                                  FALSE,// Wait
    //                                  NULL);
    //     //
    //     // Timer should not have been pending
    //     //
    //     ASSERT(wasCancelled == FALSE);
    //     m_Timer.m_KernelExTimer = NULL;
    // }
}

Member Function Documentation

FlushQueuedDpcs()

VOID MxTimer::FlushQueuedDpcs

(

VOID

)

Definition at line 291 of file mxtimerkm.h.

{
    Mx::MxFlushQueuedDpcs();
}

Referenced by FxTimer::Stop().

Initialize()

_Must_inspect_result_ NTSTATUS MxTimer::Initialize	(	__in_opt PVOID	TimerContext,
		__in MdDeferredRoutine	TimerCallback,
		__in LONG	Period
	)

Definition at line 119 of file mxtimerkm.h.

{
    m_Timer.m_TimerContext = TimerContext;
    m_Timer.m_TimerCallback = TimerCallback;
    m_Timer.m_Period = Period;
 
    KeInitializeTimerEx(&(m_Timer.KernelTimer), NotificationTimer);
    KeInitializeDpc(&(m_Timer.TimerDpc), // Timer DPC
                    m_Timer.m_TimerCallback, // DeferredRoutine
                    m_Timer.m_TimerContext); // DeferredContext
 
    m_Timer.m_IsExtTimer = FALSE;
 
    return STATUS_SUCCESS;
}

Referenced by FxRequestBase::CreateTimer(), FxPowerIdleMachine::Init(), FxTimer::Initialize(), and FxWatchdog::StartTimer().

InitializeEx()

_Must_inspect_result_ NTSTATUS MxTimer::InitializeEx	(	__in_opt PVOID	TimerContext,
		__in MdExtCallbackType	TimerCallback,
		__in LONG	Period,
		__in ULONG	TolerableDelay,
		__in BOOLEAN	UseHighResolutionTimer
	)

Definition at line 141 of file mxtimerkm.h.

{
    // NTSTATUS status;
    // ULONG attributes = 0;
 
    // m_Timer.m_TimerContext = TimerContext;
    // m_Timer.m_ExTimerCallback = TimerCallback;
    // m_Timer.m_Period = Period;
 
    // if (TolerableDelay != 0) {
 
    //     attributes |= EX_TIMER_NO_WAKE;
 
    // } else if (UseHighResolutionTimer) {
 
    //     attributes |= EX_TIMER_HIGH_RESOLUTION;
    // }
 
    // m_Timer.m_KernelExTimer = ExAllocateTimer(m_Timer.m_ExTimerCallback,
    //                                           TimerContext,
    //                                           attributes);
    // if (m_Timer.m_KernelExTimer) {
 
    //     status = STATUS_SUCCESS;
 
    // } else {
 
    //     status = STATUS_INSUFFICIENT_RESOURCES;
    // }
 
    // m_Timer.m_IsExtTimer = TRUE;
 
    // return status;
    return STATUS_NOT_IMPLEMENTED; // __REACTOS__ Ex timers are not supported
}

Start()

VOID MxTimer::Start	(	__in LARGE_INTEGER	DueTime,
		__in ULONG	TolerableDelay = 0
	)

Definition at line 251 of file mxtimerkm.h.

{
    if (m_Timer.m_IsExtTimer) {
 
        StartWithReturn(DueTime,TolerableDelay);
 
    } else {
        KeSetCoalescableTimer(&(m_Timer.KernelTimer),
                              DueTime,
                              m_Timer.m_Period,
                              TolerableDelay,
                              &(m_Timer.TimerDpc));
    }
 
    return;
}

Referenced by FxRequestBase::StartTimer(), and FxWatchdog::StartTimer().

StartWithReturn()

_Must_inspect_result_ BOOLEAN MxTimer::StartWithReturn	(	__in LARGE_INTEGER	DueTime,
		__in ULONG	TolerableDelay = 0
	)

Definition at line 209 of file mxtimerkm.h.

{
    if (m_Timer.m_IsExtTimer) {
        // __REACTOS__ Ex timers are not supported
        // EXT_SET_PARAMETERS parameters;
 
        // ExInitializeSetTimerParameters(&parameters);
 
        // //
        // // We get the delay in ms but the underlying API needs it in 100 ns
        // // units. Convert tolerable delay from ms to 100 ns. However,
        // // MAXULONG (TolerableDelayUnlimited) has a special meaning that the
        // // system should never be woken up, so we assign the corresponding
        // // special value for Ex timers
        // //
        // if (TolerableDelay == TolerableDelayUnlimited) {
        //     parameters.NoWakeTolerance = EX_TIMER_UNLIMITED_TOLERANCE;
        // } else {
        //     parameters.NoWakeTolerance = ((LONGLONG) TolerableDelay) * 10 * 1000;
        // }
 
        // return ExSetTimer(m_Timer.m_KernelExTimer,
        //                   DueTime.QuadPart,
        //                   (((LONGLONG) m_Timer.m_Period) * 10 * 1000),
        //                   &parameters);
        return FALSE;
    } else {
 
        return KeSetCoalescableTimer(&(m_Timer.KernelTimer),
                                     DueTime,
                                     m_Timer.m_Period,
                                     TolerableDelay,
                                     &(m_Timer.TimerDpc));
    }
 
}

Referenced by FxTimer::Start(), and Start().

Stop()

_Must_inspect_result_ BOOLEAN MxTimer::Stop

(

VOID

)

Definition at line 273 of file mxtimerkm.h.

{
    BOOLEAN bRetVal;
 
    if (m_Timer.m_IsExtTimer) {
        bRetVal = FALSE;
        // bRetVal = ExCancelTimer(m_Timer.m_KernelExTimer, NULL); // __REACTOS__ Ex timers are not supported
 
    } else {
        bRetVal = KeCancelTimer(&(m_Timer.KernelTimer));
    }
 
    return bRetVal;
}

Referenced by FxPowerIdleMachine::CancelIdleTimer(), FxWatchdog::CancelTimer(), FxRequestBase::CancelTimer(), and FxTimer::Stop().

Member Data Documentation

m_Timer

MdTimer MxTimer::m_Timer

private

Definition at line 33 of file mxtimer.h.

Referenced by Initialize(), MxTimer(), Start(), StartWithReturn(), and Stop().

---

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

• sdk/lib/drivers/wdf/shared/inc/primitives/common/mxtimer.h
• sdk/lib/drivers/wdf/shared/inc/primitives/km/mxtimerkm.h
• sdk/lib/drivers/wdf/shared/inc/primitives/um/mxtimerum.h