Merge branch 'insp20' into master.

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

diff --git a/include/threadengines/threadengine_pthread.h b/include/threadengines/threadengine_pthread.h
index 2aba4cb159c95225a54ebc82594ccadf39faa58d..ca33542607839ea168c48cb750af928552cca35b 100644 (file)
--- a/include/threadengines/threadengine_pthread.h
+++ b/include/threadengines/threadengine_pthread.h
@@ -1,25 +1,27 @@
-/*       +------------------------------------+
- *       | 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_PTHREAD__
-#define __THREADENGINE_PTHREAD__
 
-#include <pthread.h>
-#include "inspircd_config.h"
-#include "base.h"
+#pragma once
 
-class InspIRCd;
-class Thread;
+#include <pthread.h>
+#include "typedefs.h"
 
 /** The ThreadEngine class has the responsibility of initialising
  * Thread derived classes. It does this by creating operating system
@@ -31,18 +33,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:
-
-       /** Constructor.
-        * @param Instance Creator object
+       /** Per-thread state, present in each Thread object, managed by the ThreadEngine
         */
-       ThreadEngine(InspIRCd* Instance);
-
-       /** Destructor
-        */
-       virtual ~ThreadEngine();
+       struct ThreadState
+       {
+               pthread_t pthread_id;
+       };
 
        /** Create a new thread. This takes an already allocated
         * Thread* pointer and initializes it to use this threading
@@ -52,20 +51,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 "posix-thread";
-       }
-};
-
-class CoreExport ThreadData
-{
- public:
-       pthread_t pthread_id;
-       void FreeThread(Thread* toFree);
+       void Stop(Thread* thread);
 };
 
 /** The Mutex class represents a mutex, which can be used to keep threads
@@ -78,7 +74,7 @@ class CoreExport ThreadData
  */
 class CoreExport Mutex
 {
- private:
+ protected:
        pthread_mutex_t putex;
  public:
        /** Constructor.
@@ -107,4 +103,34 @@ class CoreExport Mutex
        }
 };
 
-#endif
+class ThreadQueueData : public Mutex
+{
+       pthread_cond_t cond;
+ public:
+       ThreadQueueData()
+       {
+               pthread_cond_init(&cond, NULL);
+       }
+
+       ~ThreadQueueData()
+       {
+               pthread_cond_destroy(&cond);
+       }
+
+       void Wakeup()
+       {
+               pthread_cond_signal(&cond);
+       }
+
+       void Wait()
+       {
+               pthread_cond_wait(&cond, &putex);
+       }
+};
+
+class ThreadSignalSocket;
+class ThreadSignalData
+{
+ public:
+       ThreadSignalSocket* sock;
+};