X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fthreadengines%2Fthreadengine_win32.h;h=2fdf1cb242d2bc631f851a80714f9895bb046d02;hb=d3a7ac87cb9ef8687f7fec09f54a570f9858efb4;hp=18b6e798c82f7113246f645e3966cd83c911cc85;hpb=aa7df4b8234d4b601ad0310605181fdabc8cfcaa;p=user%2Fhenk%2Fcode%2Finspircd.git

diff --git a/include/threadengines/threadengine_win32.h b/include/threadengines/threadengine_win32.h
index 18b6e798c..2fdf1cb24 100644
--- a/include/threadengines/threadengine_win32.h
+++ b/include/threadengines/threadengine_win32.h
@@ -1,8 +1,12 @@
 /*
  * InspIRCd -- Internet Relay Chat Daemon
  *
+ *   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 Craig Edwards <craigedwards@brainbox.cc>
+ *   Copyright (C) 2008-2010 Craig Edwards <brain@inspircd.org>
  *
  * 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
@@ -38,6 +42,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,19 +58,24 @@ 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
  * 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.
@@ -87,9 +103,8 @@ class CoreExport Mutex
 	}
 };
 
-class ThreadQueueData
+class ThreadQueueData : public Mutex
 {
-	CRITICAL_SECTION mutex;
 	HANDLE event;
  public:
 	ThreadQueueData()
@@ -97,23 +112,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 +126,9 @@ class ThreadQueueData
 
 	void Wait()
 	{
-		LeaveCriticalSection(&mutex);
+		Unlock();
 		WaitForSingleObject(event, INFINITE);
-		EnterCriticalSection(&mutex);
+		Lock();
 	}
 };