X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fthreadengines%2Fthreadengine_pthread.h;h=4952ea3e8782369c87713c7c28d4040398bc8768;hb=6d03943426dcce76ba66567a9b18425a5ebb4c0c;hp=07bda45987996f7abc2a03f7c5329d350ce63e07;hpb=edd35ae3af70075e0d59b6409f6d206c6c08d85b;p=user%2Fhenk%2Fcode%2Finspircd.git

diff --git a/include/threadengines/threadengine_pthread.h b/include/threadengines/threadengine_pthread.h
index 07bda4598..4952ea3e8 100644
--- a/include/threadengines/threadengine_pthread.h
+++ b/include/threadengines/threadengine_pthread.h
@@ -2,8 +2,8 @@
  *       | Inspire Internet Relay Chat Daemon |
  *       +------------------------------------+
  *
- *  InspIRCd: (C) 2002-2008 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
+ * See: http://wiki.inspircd.org/Credits
  *
  * This program is free but copyrighted software; see
  *            the file COPYING for details.
@@ -17,60 +17,139 @@
 #include <pthread.h>
 #include "inspircd_config.h"
 #include "base.h"
-#include "threadengine.h"
 
-class InspIRCd;
-
-class CoreExport PThreadEngine : public ThreadEngine
+class Thread;
+
+/** The ThreadEngine class has the responsibility of initialising
+ * Thread derived classes. It does this by creating operating system
+ * level threads which are then associated with the class transparently.
+ * This allows Thread classes to be derived without needing to know how
+ * the OS implements threads. You should ensure that any sections of code
+ * that use threads are threadsafe and do not interact with any other
+ * parts of the code which are NOT known threadsafe! If you really MUST
+ * access non-threadsafe code from a Thread, use the Mutex class to wrap
+ * access to the code carefully.
+ */
+class CoreExport ThreadEngine
 {
  public:
 
-	PThreadEngine(InspIRCd* Instance);
-
-	virtual ~PThreadEngine();
-
-	bool Mutex(bool enable);
-
-	void Run();
-
-	static void* Entry(void* parameter);
-
-	void Create(Thread* thread_to_init);
-
-	void FreeThread(Thread* thread);
-
+	/** Constructor.
+	 * @param Instance Creator object
+	 */
+	ThreadEngine();
+
+	/** Destructor
+	 */
+	virtual ~ThreadEngine();
+
+	/** 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.
+	 */
+	void Start(Thread* thread_to_init);
+
+	/** Returns the thread engine's name for display purposes
+	 * @return The thread engine name
+	 */
 	const std::string GetName()
 	{
 		return "posix-thread";
 	}
 };
 
-class CoreExport ThreadEngineFactory : public classbase
+class CoreExport ThreadData
+{
+ public:
+	pthread_t pthread_id;
+	void FreeThread(Thread* toFree);
+};
+
+/** 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
+ * 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.
+ */
+class CoreExport Mutex
 {
+ private:
+	pthread_mutex_t putex;
  public:
-	ThreadEngine* Create(InspIRCd* ServerInstance)
+	/** Constructor.
+	 */
+	Mutex()
+	{
+		pthread_mutex_init(&putex, NULL);
+	}
+	/** Enter/enable the mutex lock.
+	 */
+	void Lock()
+	{
+		pthread_mutex_lock(&putex);
+	}
+	/** Leave/disable the mutex lock.
+	 */
+	void Unlock()
+	{
+		pthread_mutex_unlock(&putex);
+	}
+	/** Destructor
+	 */
+	~Mutex()
 	{
-		return new PThreadEngine(ServerInstance);
+		pthread_mutex_destroy(&putex);
 	}
 };
 
-class CoreExport PosixMutex : public Mutex
+class ThreadQueueData
 {
- private:
-	pthread_mutex_t putex
+	pthread_mutex_t mutex;
+	pthread_cond_t cond;
  public:
-	PosixMutex(InspIRCd* Instance);
-	virtual void Enable(bool enable);
-	~PosixMutex();
+	ThreadQueueData()
+	{
+		pthread_mutex_init(&mutex, NULL);
+		pthread_cond_init(&cond, NULL);
+	}
+
+	~ThreadQueueData()
+	{
+		pthread_mutex_destroy(&mutex);
+		pthread_cond_destroy(&cond);
+	}
+
+	void Lock()
+	{
+		pthread_mutex_lock(&mutex);
+	}
+
+	void Unlock()
+	{
+		pthread_mutex_unlock(&mutex);
+	}
+
+	void Wakeup()
+	{
+		pthread_cond_signal(&cond);
+	}
+
+	void Wait()
+	{
+		pthread_cond_wait(&cond, &mutex);
+	}
 };
 
-class CoreExport MutexEngine : public Extensible
+class ThreadSignalSocket;
+class ThreadSignalData
 {
- protected:
-	InspIRCd* ServerInstance;
  public:
-	virtual MutexEngine(InspIRCd* Instance);
-	Mutex* CreateMutex();
+	ThreadSignalSocket* sock;
 };
 
+
 #endif