timerqueue.c File Reference

#include <k32.h>
#include <debug.h>

Include dependency graph for timerqueue.c:

Go to the source code of this file.

Macros
#define	NDEBUG

Functions
BOOL WINAPI	BasepCreateDefaultTimerQueue (VOID)
BOOL WINAPI	CancelTimerQueueTimer (IN HANDLE TimerQueue, IN HANDLE Timer)
BOOL WINAPI	ChangeTimerQueueTimer (IN HANDLE TimerQueue, IN HANDLE Timer, IN ULONG DueTime, IN ULONG Period)
HANDLE WINAPI	CreateTimerQueue (VOID)
BOOL WINAPI	CreateTimerQueueTimer (OUT PHANDLE phNewTimer, IN HANDLE TimerQueue, IN WAITORTIMERCALLBACK Callback, IN PVOID Parameter, IN DWORD DueTime, IN DWORD Period, IN ULONG Flags)
BOOL WINAPI	DeleteTimerQueue (IN HANDLE TimerQueue)
BOOL WINAPI	DeleteTimerQueueEx (IN HANDLE TimerQueue, IN HANDLE CompletionEvent)
BOOL WINAPI	DeleteTimerQueueTimer (IN HANDLE TimerQueue, IN HANDLE Timer, IN HANDLE CompletionEvent)
HANDLE WINAPI	SetTimerQueueTimer (IN HANDLE TimerQueue, IN WAITORTIMERCALLBACK Callback, IN PVOID Parameter, IN DWORD DueTime, IN DWORD Period, IN BOOL PreferIo)

Variables
HANDLE	BasepDefaultTimerQueue = NULL

Macro Definition Documentation

NDEBUG

#define NDEBUG

Definition at line 13 of file timerqueue.c.

Function Documentation

BasepCreateDefaultTimerQueue()

BOOL WINAPI BasepCreateDefaultTimerQueue

(

VOID

)

Definition at line 24 of file timerqueue.c.

{
    NTSTATUS Status;
    HANDLE TimerQueue;
 
    /* Already initialized */
    if (BasepDefaultTimerQueue != NULL)
        return TRUE;
 
    /* Create the timer queue */
    Status = RtlCreateTimerQueue(&TimerQueue);
    if (!NT_SUCCESS(Status))
    {
        BaseSetLastNTError(Status);
        DPRINT1("Unable to create the default timer queue!\n");
        return FALSE;
    }
 
    /* Try to publish it. If another thread already did, throw ours away */
    if (InterlockedCompareExchangePointer((PVOID *)&BasepDefaultTimerQueue,
                                           TimerQueue,
                                           NULL) != NULL)
    {
        RtlDeleteTimerQueueEx(TimerQueue, NULL);
    }
 
    return TRUE;
}

Referenced by CreateTimerQueueTimer(), and SetTimerQueueTimer().

CancelTimerQueueTimer()

BOOL WINAPI CancelTimerQueueTimer	(	IN HANDLE	TimerQueue,
		IN HANDLE	Timer
	)

Definition at line 61 of file timerqueue.c.

{
    NTSTATUS Status;
 
    if (!TimerQueue)
    {
        /* Use the default timer queue */
        TimerQueue = BasepDefaultTimerQueue;
        if (!TimerQueue)
        {
            /* A timer is being cancelled before one was created... fail */
            SetLastError(ERROR_INVALID_HANDLE);
            return FALSE;
        }
    }
 
    /* Delete the timer */
    Status = RtlDeleteTimer(TimerQueue, Timer, NULL);
    if (!NT_SUCCESS(Status))
    {
        BaseSetLastNTError(Status);
        return FALSE;
    }
 
    return TRUE;
}

ChangeTimerQueueTimer()

BOOL WINAPI ChangeTimerQueueTimer	(	IN HANDLE	TimerQueue,
		IN HANDLE	Timer,
		IN ULONG	DueTime,
		IN ULONG	Period
	)

Definition at line 94 of file timerqueue.c.

{
    NTSTATUS Status;
 
    if (!TimerQueue)
    {
        /* Use the default timer queue */
        TimerQueue = BasepDefaultTimerQueue;
        if (!TimerQueue)
        {
            /* A timer is being cancelled before one was created... fail */
            SetLastError(ERROR_INVALID_PARAMETER);
            return FALSE;
        }
    }
 
    /* Delete the timer */
    Status = RtlUpdateTimer(TimerQueue, Timer, DueTime, Period);
    if (!NT_SUCCESS(Status))
    {
        BaseSetLastNTError(Status);
        return FALSE;
    }
 
    return TRUE;
}

CreateTimerQueue()

HANDLE WINAPI CreateTimerQueue

(

VOID

)

Definition at line 129 of file timerqueue.c.

{
    HANDLE Handle;
    NTSTATUS Status;
 
    /* Create the timer queue */
    Status = RtlCreateTimerQueue(&Handle);
    if(!NT_SUCCESS(Status))
    {
        BaseSetLastNTError(Status);
        return NULL;
    }
 
    return Handle;
}

CreateTimerQueueTimer()

BOOL WINAPI CreateTimerQueueTimer	(	OUT PHANDLE	phNewTimer,
		IN HANDLE	TimerQueue,
		IN WAITORTIMERCALLBACK	Callback,
		IN PVOID	Parameter,
		IN DWORD	DueTime,
		IN DWORD	Period,
		IN ULONG	Flags
	)

Definition at line 150 of file timerqueue.c.

{
    NTSTATUS Status;
 
    /* Parameter is not optional -- clear it now */
    *phNewTimer = NULL;
 
    /* Check if no queue was given */
    if (!TimerQueue)
    {
        /* Create the queue if it didn't already exist */
        if (!(BasepDefaultTimerQueue) && !(BasepCreateDefaultTimerQueue()))
        {
            return FALSE;
        }
 
        /* Use the default queue */
        TimerQueue = BasepDefaultTimerQueue;
    }
 
    /* Create the timer. Note that no parameter checking is done here */
    Status = RtlCreateTimer(TimerQueue,
                            phNewTimer,
                            Callback,
                            Parameter,
                            DueTime,
                            Period,
                            Flags);
    if (!NT_SUCCESS(Status))
    {
        BaseSetLastNTError(Status);
        return FALSE;
    }
 
    return TRUE;
}

Referenced by SHSetTimerQueueTimer(), Test1(), Test2(), and Test3().

DeleteTimerQueue()

BOOL WINAPI DeleteTimerQueue

(

IN HANDLE

TimerQueue

)

Definition at line 198 of file timerqueue.c.

{
    /* We don't allow the user to delete the default timer queue */
    if (!TimerQueue)
    {
        SetLastError(ERROR_INVALID_HANDLE);
        return FALSE;
    }
 
    /* Delete the timer queue */
    RtlDeleteTimerQueueEx(TimerQueue, 0);
    return TRUE;
}

DeleteTimerQueueEx()

BOOL WINAPI DeleteTimerQueueEx	(	IN HANDLE	TimerQueue,
		IN HANDLE	CompletionEvent
	)

Definition at line 217 of file timerqueue.c.

{
    NTSTATUS Status;
 
    /* We don't allow the user to delete the default timer queue */
    if (!TimerQueue)
    {
        SetLastError(ERROR_INVALID_HANDLE);
        return FALSE;
    }
 
    /* Delete the timer queue */
    Status = RtlDeleteTimerQueueEx(TimerQueue, CompletionEvent);
    if (((CompletionEvent != INVALID_HANDLE_VALUE) && (Status == STATUS_PENDING)) ||
        !(NT_SUCCESS(Status)))
    {
        /* In case CompletionEvent == NULL, RtlDeleteTimerQueueEx() returns before
           all callback routines returned. We set the last error code to STATUS_PENDING
           and return FALSE. In case CompletionEvent == INVALID_HANDLE_VALUE we only
           can get here if another error occured. In case CompletionEvent is something
           else, we get here and fail, even though it isn't really an error (if Status == STATUS_PENDING).
           We also handle all other failures the same way. */
        BaseSetLastNTError(Status);
        return FALSE;
    }
 
    return TRUE;
}

DeleteTimerQueueTimer()

BOOL WINAPI DeleteTimerQueueTimer	(	IN HANDLE	TimerQueue,
		IN HANDLE	Timer,
		IN HANDLE	CompletionEvent
	)

Definition at line 252 of file timerqueue.c.

{
    NTSTATUS Status;
 
    if (!TimerQueue)
    {
        /* Use the default timer queue */
        TimerQueue = BasepDefaultTimerQueue;
        if (!TimerQueue)
        {
            /* A timer is being cancelled before one was created... fail */
            SetLastError(ERROR_INVALID_PARAMETER);
            return FALSE;
        }
    }
 
    /* Delete the timer */
    Status = RtlDeleteTimer(TimerQueue, Timer, CompletionEvent);
    if (((CompletionEvent != INVALID_HANDLE_VALUE) && (Status == STATUS_PENDING)) ||
        !(NT_SUCCESS(Status)))
    {
        /* In case CompletionEvent == NULL, RtlDeleteTimerQueueEx() returns before
           all callback routines returned. We set the last error code to STATUS_PENDING
           and return FALSE. In case CompletionEvent == INVALID_HANDLE_VALUE we only
           can get here if another error occured. In case CompletionEvent is something
           else, we get here and fail, even though it isn't really an error (if Status == STATUS_PENDING).
           We also handle all other failures the same way. */
        BaseSetLastNTError(Status);
        return FALSE;
    }
 
    return TRUE;
}

Referenced by Test2(), Test3(), and TimerCallback1().

SetTimerQueueTimer()

HANDLE WINAPI SetTimerQueueTimer	(	IN HANDLE	TimerQueue,
		IN WAITORTIMERCALLBACK	Callback,
		IN PVOID	Parameter,
		IN DWORD	DueTime,
		IN DWORD	Period,
		IN BOOL	PreferIo
	)

Definition at line 293 of file timerqueue.c.

{
    HANDLE Timer;
    NTSTATUS Status;
 
    /* Check if no queue was given */
    if (!TimerQueue)
    {
        /* Create the queue if it didn't already exist */
        if (!(BasepDefaultTimerQueue) && !(BasepCreateDefaultTimerQueue()))
        {
            return FALSE;
        }
 
        /* Use the default queue */
        TimerQueue = BasepDefaultTimerQueue;
    }
 
    /* Create the timer */
    Status = RtlCreateTimer(TimerQueue,
                            &Timer,
                            Callback,
                            Parameter,
                            DueTime,
                            Period,
                            PreferIo ? WT_EXECUTEINIOTHREAD : WT_EXECUTEDEFAULT);
    if (!NT_SUCCESS(Status))
    {
        BaseSetLastNTError(Status);
        return NULL;
    }
 
    return Timer;
}

Variable Documentation

BasepDefaultTimerQueue

HANDLE BasepDefaultTimerQueue = NULL

Definition at line 18 of file timerqueue.c.

Referenced by BasepCreateDefaultTimerQueue(), CancelTimerQueueTimer(), ChangeTimerQueueTimer(), CreateTimerQueueTimer(), DeleteTimerQueueTimer(), and SetTimerQueueTimer().