Windows API——CreateEvent和SetEvent函数

Windows API——CreateEvent和SetEvent函数

（1）CreateEvent
函数原型：
HANDLE CreateEvent( 　　
    LPSECURITY_ATTRIBUTES lpEventAttributes, // 安全属性 　　
    BOOL bManualReset, // 复位方式 　　
    BOOL bInitialState, // 初始状态 　　
    LPCTSTR lpName // 对象名称 　　
); 
      lpEventAttributes：一个指向SECURITY_ATTRIBUTES结构的指针，确定返回的句柄是否可被子进程继承。如果lpEventAttributes是NULL，此句柄不能被继承。
      bManualReset：指定将事件对象创建成手动复原还是自动复原。如果是TRUE，那么就算等待线程处理了，必须用ResetEvent函数来手工才能将事件的状态复原到无信号状态。如果设置为FALSE，当事件被一个等待线程处理并释放以后，系统会自动将事件状态复原为无信号状态。所以两者可用于不同的场合，自动复位的需要每次的事件信号才会执行，而手动复位的则可以一直运行。
      bInitialState：指定事件对象的初始状态。如果为TRUE，初始状态为有信号状态；否则为无信号状态。
lpName：指定事件的对象的名称，是一个以0结束的字符串指针。名字是对大小写敏感的。如果lpName为NULL，将创建一个无名的事件对象。
      示例代码：// 创建一个有名的，不能被继承的，手动复原，初始状态是无信号状态的事件对象：
Handle h = CreateEvent(NULL,TRUE,FALSE,“MyEvent”);
（2）SetEvent
函数原型：
BOOL WINAPI SetEvent(
      __in  HANDLE hEvent
);
设置事件的状态为有标记。如果事件创建时是手工的，此事件将保持有标记直到调用ResetEvent。如果事件是自动的，此事件将保持有标记，直到一个线程被释放，系统将设置事件的状态为无标记。
（3）ResetEvent
函数原型：
BOOL ResetEvent( 　　
     HANDLE hEvent 　　
); 
hEvent 指向事件对象的句柄，由 CreateEvent or OpenEvent 函数返回。这个句柄需要拥有EVENT_MODIFY_STATE 访问权限。函数成功，返回非0值，否则返回0值，可以调用GetLastError得到错误的详细信息。 
      这个函数用于手动重置事件对象。手动重置的对象在线程释放后必须手动置为无信号状态。自动重置的事件对象在一个等待它成功的线程释放后会自动变为无信号状态。 重置一个无信号的事件对象没有任何效果。
（4）WaitForSingleObject
函数原型：
DWORD WaitForSingleObject( 
      HANDLE hHandle, 
      DWORD dwMilliseconds
);
参数hHandle是一个事件的句柄，第二个参数dwMilliseconds是时间间隔。如果事件是有信号状态返回WAIT_OBJECT_0，如果事件超过dwMilliseconds值但事件还是无信号状态，则返回WAIT_TIMEOUT。之前线程会一直阻塞程序在该语句处

当你创建一个线程时，其实那个线程是一个循环，不像上面那样只运行一次的。这样就带来了一个问题，在那个死循环里要找到合适的条件退出那个死循环，那么是怎么样实现它的呢？在Windows里往往是采用事件的方式，当然还可以采用其它的方式。在这里先介绍采用事件的方式来通知从线程运行函数退出来，它的实现原理是这样，在那个死循环里不断地使用WaitForSingleObject函数来检查事件是否满足，如果满足就退出线程，不满足就继续运行。当在线程里运行阻塞的函数时，就需要在退出线程时，先要把阻塞状态变成非阻塞状态，比如使用一个线程去接收网络数据，同时使用阻塞的SOCKET时，那么要先关闭SOCKET，再发送事件信号，才可以退出线程的。下面就来演示怎么样使用事件来通知线程退出来。

HANDLE WINAPI 

CreateEventA(

__in_opt LPSECURITY_ATTRIBUTES lpEventAttributes,

__in BOOL bManu alReset,

__in BOOL bInitialState,

__in_opt LPCSTR lpName

);

WINBASEAPI

__out

HANDLE

WINAPI

CreateEventW(

__in_opt LPSECURITY_ATTRIBUTES lpEventAttributes,

__in BOOL bManualReset,

__in BOOL bInitialState,

__in_opt LPCWSTR lpName

);

#ifdef UNICODE

#define CreateEventCreateEventW

#else

#define CreateEventCreateEventA

#endif // !UNICODE

lpEventAttributes 是事件的属性。

bManualReset 是指事件手动复位，还是自动复位状态。

bInitialState 是初始化的状态是否处于有信号的状态。

lpName 是事件的名称，如果有名称，可以跨进程共享事件状态。

调用这个函数的例子如下：

#pragma once

// 线程类。

class CThread

{

public:

CThread(void)

{

m_hThread = NULL;

 m_hEventExit = NULL;

}

virtual ~CThread(void)

{

 if (m_hThread)

{

// 删除的线程资源。

::CloseHandle(m_hThread);

 }

 if (m_hEventExit)

 {

 // 删除事件。

 ::CloseHandle(m_hEventExit);

 }

}

// 创建线程

HANDLE CreateThread(void)

{

 // 创建退出事件。属性为:NULL，手动复位,初始化为无信号状态,事件的名称为NULL

 m_hEventExit = ::CreateEvent(NULL,TRUE,FALSE,NULL);

if (!m_hEventExit)

 {

// 创建事件失败。

return NULL;

 }

 // 创建线程。

 m_hThread = ::CreateThread(

 NULL, // 安全属性使用缺省。

 0, // 线程的堆栈大小。

ThreadProc, // 线程运行函数地址。

this, // 传给线程函数的参数。

 0, // 创建标志。

&m_dwThreadID); // 成功创建后的线程标识码。

 return m_hThread;

}

// 等待线程结束。

void WaitFor(DWORD dwMilliseconds = INFINITE)

{

// 发送退出线程信号。

 ::SetEvent(m_hEventExit);

 // 等待线程结束。

 ::WaitForSingleObject(m_hThread,dwMilliseconds);

}

protected:

// 线程运行函数。

static DWORD WINAPI ThreadProc(LPVOID lpParameter)

{

 // 转换传送入来的参数。

CThread* pThread = reinterpret_cast<cthread>(lpParameter);</cthread>

 if (pThread)

{

// 线程返回码。

// 调用类的线程处理函数。

 return pThread->Run();

 }

 return -1;

}

// 线程运行函数。

// 在这里可以使用类里的成员，也可以让派生类实现更强大的功能。

virtual DWORD Run(void)

{

 // 输出到调试窗口。

::OutputDebugString(_T("Run() 线程函数运行 \r\n"));

 // 线程循环。

 for (;;)

 {

 DWORD dwRet = WaitForSingleObject(m_hEventExit,0);

if (dwRet == WAIT_TIMEOUT)

{

 // 可以继续运行。

TCHAR chTemp[128];

 wsprintf(chTemp,_T("ThreadID=%d\r\n"),m_dwThreadID);

 ::OutputDebugString(chTemp);

// 目前没有做什么事情，就让线程释放一下 CPU 。

Sleep(10);

}

else if (dwRet == WAIT_OBJECT_0)

 {

 // 退出线程。

 ::OutputDebugString(_T("Run()  退出线程 \r\n"));

break;

 }

 else if (dwRet == WAIT_ABANDONED)

 {

// 出错。

 ::OutputDebugString(_T("Run()  线程出错 \r\n"));

 return -1;

 }

}

 return 0;

}

protected:

HANDLE m_hThread; // 线程句柄。

DWORD m_dwThreadID; // 线程 ID 。

HANDLE m_hEventExit; // 线程退出事件。

};

上面在第 35 行创建线程退出事件，第 95 行检查事件是否可退出线程运行，第 58 行设置退出线程的事件。