CreateWaitableTimer 、SetWaitableTimer用於創建無界面的定時器。

平時創建定時器使用的是WINAPI  SetTimer，不過該函數一般用於有界面的時候。無界面的情況下，可以選擇微軟提供的CreateWaitableTimer和SetWaitableTimer API。

 

HANDLE WINAPI CreateWaitableTimer(
  _In_opt_  LPSECURITY_ATTRIBUTES lpTimerAttributes,
  _In_      BOOL bManualReset,
  _In_opt_  LPCTSTR lpTimerName
);

BOOL WINAPI SetWaitableTimer(
  _In_      HANDLE hTimer,
  _In_      const LARGE_INTEGER *pDueTime,
  _In_      LONG lPeriod,
  _In_opt_  PTIMERAPCROUTINE pfnCompletionRoutine,
  _In_opt_  LPVOID lpArgToCompletionRoutine,
  _In_      BOOL fResume
);

詳細介紹可以查看MSDN( http://msdn.microsoft.com/en-us/library/windows/desktop/ms682492(v=vs.85).aspx )

一、應用實例

我自己在使用的時候，封裝了一個類，用來創建了一個線程，並定時調用我提供的函數。類代碼如下：

#ifndef APLAYER_TIMERTHREAD_H
#define APLAYER_TIMERTHREAD_H
#include <Windows.h>
class CTimerThread
{
public:
    CTimerThread() :
        _hThread(NULL), _hEvent(NULL),
        _bRunning(false), _nInterval(10)
    {}
    ~CTimerThread()
    {
        KillTimer();
    }
public:
    int                        CreateTimer(unsigned int interval, PTIMERAPCROUTINE func, void* lpParam);
    void                    KillTimer();
private:
    static DWORD WINAPI        timerThread(LPVOID lpParam);

private:
    HANDLE                _hTimer;
    int                    _nInterval;
    HANDLE                _hEvent;
    void*                _lpParam;

    PTIMERAPCROUTINE    _callbackFunc;
    HANDLE                _hThread;
    DWORD                _dwThread;
    bool                _bRunning;
};

#endif

#include "TimerThread.h"

void CTimerThread::KillTimer()
{
    if (_hTimer != NULL) {
        CancelWaitableTimer(_hTimer);
        CloseHandle(_hTimer);
        _hTimer = NULL;
    }
    _bRunning = false;
}
int CTimerThread::CreateTimer(unsigned int interval, PTIMERAPCROUTINE func, void* lpParam)
{
    if (_bRunning) return TRUE;
    _nInterval = interval;
    _callbackFunc = func;
    _lpParam = lpParam;
    _bRunning = true;
    _hThread = CreateThread(
        NULL,
        0,
        timerThread,
        this,
        0,
        &_dwThread
        );
    if (_hThread == NULL) {
        _bRunning = false;
        return FALSE;
    }
    CloseHandle(_hThread);
    return TRUE;
}

DWORD CTimerThread::timerThread(LPVOID lpParam)
{
    CTimerThread* pThis = (CTimerThread*)lpParam;
    do {
        pThis->_hTimer = CreateWaitableTimer(NULL, FALSE, NULL);
        if (pThis->_hTimer == NULL) break;

        LARGE_INTEGER liDueTime;
        liDueTime.QuadPart = 0;
        BOOL bRet = SetWaitableTimer(
            pThis->_hTimer,
            &liDueTime,
            pThis->_nInterval,
            pThis->_callbackFunc,
            pThis->_lpParam,
            FALSE);
        do {
            SleepEx(30000, TRUE);
        } while (pThis->_bRunning);
        return bRet;
    } while (0);
    return 0;
}

TimerThread.h/cpp實現了一個可以定時調用函數的類。使用的時候也很簡單。首先定義一個要被調用的函數

void __stdcall DoSomething(void *lpParam, DWORD, DWORD)
{
　　//to do
}
void *lpParam;
CTimerThread _timer;
_timer.CreateTimer(50, DoSomething, lpParam);
//
some code
....
//
_timer.KillTimer();

DoSomething函數在_timer.CreateTimer 和_timer.KillTimer之間會每隔50ms調用一次。

二、詳細說明

下面根據我自己的理解介紹下這兩個函數。

1.CreateWaitableTimer

HANDLE WINAPI CreateWaitableTimer(
  _In_opt_  LPSECURITY_ATTRIBUTES lpTimerAttributes,
  _In_      BOOL bManualReset,
  _In_opt_  LPCTSTR lpTimerName
);

用來創建一個timer對象。首先翻譯下MSDN對各參數的介紹（個人理解）：

lpTimerAttributes　

 略過，具體可以查看MSDN或《Windows核心編程》，一般設置為NULL。

bManualReset　　

If this parameter is TRUE, the timer is a manual-reset notification timer. Otherwise, the timer is a synchronization timer.

（此處不知道如何翻譯才能清晰的傳達意思，故抄錄原文。用我的語言解釋就是，如果為TRUE，則該timer到時間時，需要手動重置才能有下一次；FALSE則每次到時后自動進行下一次計時）

lpTimerName 

該timer對象的名稱。最大MAX_PATH個字母，區分大小寫。

傳遞NULL則創建一個沒有名字的timer對象。

如果名稱和現有的event，semaphore，mutex，job or file-mapping對象名稱沖突，則該函數失敗，調用GetLastError會返回ERROR_INVALID_HANDLE錯誤。原因是這些對象共享相同的命名空間。

返回值（return value）

如果函數調用成功，則返回指向timer對象的handle。如果和現有的已命名timer同名，則返回指向該timer的handle。

2.SetWaitableTimer

BOOL WINAPI SetWaitableTimer(
  _In_      HANDLE hTimer,
  _In_      const LARGE_INTEGER *pDueTime,
  _In_      LONG lPeriod,
  _In_opt_  PTIMERAPCROUTINE pfnCompletionRoutine,
  _In_opt_  LPVOID lpArgToCompletionRoutine,
  _In_      BOOL fResume
);

啟動timer對象。首先翻譯下MSDN對各參數的介紹（個人理解）：

hTimer

指向timer對象的handle。顯然可以是CreateWaitableTimer函數返回的handle。

pDueTime

該時間之后的timer會signaled(意會下..)，間隔為100納秒（應該就是此值的單位吧？）

正值的話，就是基於UTC的絕對時間。負值的話就是相對現在的時間了。

例如-10 000 000表示1s后。

lPeriod

嗯，這個就是我比較關心的參數，signaled間隔。類似於SetTimer里那個間隔。單位毫秒(ms)

為0則只signaled一次。

pfnCompletionRoutine

每次signaled都會調用此處的函數了，傳遞一個函數指針。原型為：

typedef
VOID
(APIENTRY *PTIMERAPCROUTINE)(
    _In_opt_ LPVOID lpArgToCompletionRoutine,  \\SetWaitableTimer傳入的參數lpArgToCompletionRoutine
    _In_     DWORD dwTimerLowValue,
    _In_     DWORD dwTimerHighValue
    );

 

lpArgToCompletionRoutine

傳入的參數，往上看:-)

fResume

懶得介紹，自己看msdn，一般設置為FALSE。

返回值（return value）

成功返回非零值。