Fix a bunch of weird indentation and spacing issues.

[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 b6025d3361005c5957b44f99f2c5a68cf00206f6..1b88179b60b29bf060c2d3210af5ccbe7833b39a 100644 (file)
--- a/include/threadengines/threadengine_win32.h
+++ b/include/threadengines/threadengine_win32.h
@@ -1,20 +1,29 @@
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  InspIRCd: (C) 2002-2010 InspIRCd Development Team
- * See: http://wiki.inspircd.org/Credits
+ *   Copyright (C) 2014 Attila Molnar <attilamolnar@hush.com>
+ *   Copyright (C) 2013 Sadie Powell <sadie@witchery.services>
+ *   Copyright (C) 2012 Robby <robby@chatbelgie.be>
+ *   Copyright (C) 2012 ChrisTX <xpipe@hotmail.de>
+ *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2008-2010 Craig Edwards <brain@inspircd.org>
  *
- * 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_WIN32_H
-#define THREADENGINE_WIN32_H
 
-#include "inspircd_config.h"
+#pragma once
+
 #include "base.h"
 
 class Thread;
@@ -32,41 +41,40 @@ class Thread;
 class CoreExport ThreadEngine
 {
  public:
-
-       ThreadEngine();
-
-       virtual ~ThreadEngine();
+       /** 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
-         * Thread* pointer and initializes it to use this threading
-         * engine. On failure, this function may throw a CoreException.
-         * @param thread_to_init Pointer to a newly allocated Thread
-         * derived object.
-         */
+        * Thread* pointer and initializes it to use this threading
+        * engine. On failure, this function may throw a CoreException.
+        * @param thread_to_init Pointer to a newly allocated Thread
+        * derived object.
+        */
        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
  * properly synchronised. Use mutexes sparingly, as they are a good source
  * of thread deadlocks etc, and should be avoided except where absolutely
- * neccessary. Note that the internal behaviour of the mutex varies from OS
+ * necessary. Note that the internal behaviour of the mutex varies from OS
  * to OS depending on the thread engine, for example in windows a Mutex
  * in InspIRCd uses critical sections, as they are faster and simpler to
  * manage.
@@ -94,30 +102,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()
@@ -127,9 +125,9 @@ class ThreadQueueData
 
        void Wait()
        {
-               LeaveCriticalSection(&mutex);
+               Unlock();
                WaitForSingleObject(event, INFINITE);
-               EnterCriticalSection(&mutex);
+               Lock();
        }
 };
 
@@ -142,6 +140,3 @@ class ThreadSignalData
                connFD = -1;
        }
 };
-
-#endif
-