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 6bd1c2c005dd2765de1df279a61dfeabaf8d33c8..aac7b8b974ca3d49efcc20673db7266bc96c5372 100644 (file)
--- a/include/threadengines/threadengine_win32.h
+++ b/include/threadengines/threadengine_win32.h
@@ -1,23 +1,28 @@
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
- * See: http://wiki.inspircd.org/Credits
+ *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2008 Craig Edwards <craigedwards@brainbox.cc>
  *
- * This program is free but copyrighted software; see
- *            the file COPYING for details.
+ * This file is part of InspIRCd.  InspIRCd is free software: you can
+ * redistribute it and/or modify it under the terms of the GNU General Public
+ * License as published by the Free Software Foundation, version 2.
  *
- * ---------------------------------------------------
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#ifndef __THREADENGINE_WIN32THREAD__
-#define __THREADENGINE_WIN32THREAD__
 
-#include "inspircd_config.h"
+#pragma once
+
+#include "config.h"
 #include "base.h"
 
-class InspIRCd;
 class Thread;
 
 /** The ThreadEngine class has the responsibility of initialising
@@ -30,13 +35,15 @@ class Thread;
  * access non-threadsafe code from a Thread, use the Mutex class to wrap
  * access to the code carefully.
  */
-class CoreExport ThreadEngine : public Extensible
+class CoreExport ThreadEngine
 {
  public:
-
-       ThreadEngine(InspIRCd* Instance);
-
-       virtual ~ThreadEngine();
+       /** Per-thread state, present in each Thread object, managed by the ThreadEngine
+        */
+       struct ThreadState
+       {
+               HANDLE handle;
+       };
 
        static DWORD WINAPI Entry(void* parameter);
 
@@ -48,20 +55,17 @@ class CoreExport ThreadEngine : public Extensible
          */
        void Start(Thread* thread_to_init);
 
-       /** Returns the thread engine's name for display purposes
-        * @return The thread engine name
+       /** 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.
         */
-       const std::string GetName()
-       {
-               return "windows-thread";
-       }
-};
-
-class CoreExport ThreadData
-{
- public:
-       HANDLE handle;
-       void FreeThread(Thread* toFree);
+       void Stop(Thread* thread);
 };
 
 /** The Mutex class represents a mutex, which can be used to keep threads
@@ -95,30 +99,20 @@ class CoreExport Mutex
        }
 };
 
-class ThreadQueueData
+class ThreadQueueData : public Mutex
 {
-       CRITICAL_SECTION mutex;
        HANDLE event;
  public:
        ThreadQueueData()
        {
-               InitializeCriticalSection(&mutex);
                event = CreateEvent(NULL, false, false, NULL);
+               if (event == NULL)
+                       throw CoreException("CreateEvent() failed in ThreadQueueData::ThreadQueueData()!");
        }
 
        ~ThreadQueueData()
        {
-               DeleteCriticalSection(&mutex);
-       }
-
-       void Lock()
-       {
-               EnterCriticalSection(&mutex);
-       }
-
-       void Unlock()
-       {
-               LeaveCriticalSection(&mutex);
+               CloseHandle(event);
        }
 
        void Wakeup()
@@ -128,9 +122,9 @@ class ThreadQueueData
 
        void Wait()
        {
-               LeaveCriticalSection(&mutex);
+               Unlock();
                WaitForSingleObject(event, INFINITE);
-               EnterCriticalSection(&mutex);
+               Lock();
        }
 };
 
@@ -143,6 +137,3 @@ class ThreadSignalData
                connFD = -1;
        }
 };
-
-#endif
-