Merge branch 'insp20' into master.

[user/henk/code/inspircd.git] / include / threadengines / threadengine_win32.h

diff --git a/include/threadengines/threadengine_win32.h b/include/threadengines/threadengine_win32.h
index 18b6e798c82f7113246f645e3966cd83c911cc85..aac7b8b974ca3d49efcc20673db7266bc96c5372 100644 (file)
--- a/include/threadengines/threadengine_win32.h
+++ b/include/threadengines/threadengine_win32.h
@@ -38,6 +38,13 @@ class Thread;
 class CoreExport ThreadEngine
 {
  public:
+       /** Per-thread state, present in each Thread object, managed by the ThreadEngine
+        */
+       struct ThreadState
+       {
+               HANDLE handle;
+       };
+
        static DWORD WINAPI Entry(void* parameter);
 
        /** Create a new thread. This takes an already allocated
@@ -47,13 +54,18 @@ class CoreExport ThreadEngine
          * derived object.
          */
        void Start(Thread* thread_to_init);
-};
 
-class CoreExport ThreadData
-{
- public:
-       HANDLE handle;
-       void FreeThread(Thread* toFree);
+       /** Stop a thread gracefully.
+        * First, this function asks the thread to terminate by calling Thread::SetExitFlag().
+        * Next, it waits until the thread terminates (on the operating system level). Finally,
+        * all OS-level resources associated with the thread are released. The Thread instance
+        * passed to the function is NOT freed.
+        * When this function returns, the thread is stopped and you can destroy it or restart it
+        * at a later point.
+        * Stopping a thread that is not running is a bug.
+        * @param thread The thread to stop.
+        */
+       void Stop(Thread* thread);
 };
 
 /** The Mutex class represents a mutex, which can be used to keep threads
@@ -87,9 +99,8 @@ class CoreExport Mutex
        }
 };
 
-class ThreadQueueData
+class ThreadQueueData : public Mutex
 {
-       CRITICAL_SECTION mutex;
        HANDLE event;
  public:
        ThreadQueueData()
@@ -97,23 +108,11 @@ class ThreadQueueData
                event = CreateEvent(NULL, false, false, NULL);
                if (event == NULL)
                        throw CoreException("CreateEvent() failed in ThreadQueueData::ThreadQueueData()!");
-               InitializeCriticalSection(&mutex);
        }
 
        ~ThreadQueueData()
        {
                CloseHandle(event);
-               DeleteCriticalSection(&mutex);
-       }
-
-       void Lock()
-       {
-               EnterCriticalSection(&mutex);
-       }
-
-       void Unlock()
-       {
-               LeaveCriticalSection(&mutex);
        }
 
        void Wakeup()
@@ -123,9 +122,9 @@ class ThreadQueueData
 
        void Wait()
        {
-               LeaveCriticalSection(&mutex);
+               Unlock();
                WaitForSingleObject(event, INFINITE);
-               EnterCriticalSection(&mutex);
+               Lock();
        }
 };