Remove the Kiwi links from the readme.

[user/henk/code/inspircd.git] / include / threadengine.h

diff --git a/include/threadengine.h b/include/threadengine.h
index d7eaaef6938277e4b559d5007ebd02ee51425fb5..0c2d26ce6e14f4546cb8b5a952c3ac40372838b4 100644 (file)
--- a/include/threadengine.h
+++ b/include/threadengine.h
@@ -1,37 +1,50 @@
-/*       +------------------------------------+
- *       | 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) 2014 Attila Molnar <attilamolnar@hush.com>
+ *   Copyright (C) 2013, 2017 Sadie Powell <sadie@witchery.services>
+ *   Copyright (C) 2012 Robby <robby@chatbelgie.be>
+ *   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2008 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__
-#define __THREADENGINE__
 
-#include <vector>
-#include <string>
-#include <map>
-#include "inspircd_config.h"
+#pragma once
+
 #include "base.h"
 
 /** Derive from this class to implement your own threaded sections of
  * code. Be sure to keep your code thread-safe and not prone to deadlocks
  * and race conditions if you MUST use threading!
  */
-class CoreExport Thread : public Extensible
+class CoreExport Thread
 {
  private:
        /** Set to true when the thread is to exit
         */
        bool ExitFlag;
-// TODO protected:
- public:
+
+       /** Opaque thread state managed by the ThreadEngine
+        */
+       ThreadEngine::ThreadState state;
+
+       /** ThreadEngine manages Thread::state
+        */
+       friend class ThreadEngine;
+
+ protected:
        /** Get thread's current exit status.
         * (are we being asked to exit?)
         */
@@ -40,28 +53,12 @@ class CoreExport Thread : public Extensible
                return ExitFlag;
        }
  public:
-       /** Opaque thread state managed by threading engine
-        */
-       ThreadData* state;
-
        /** Set Creator to NULL at this point
         */
-       Thread() : ExitFlag(false), state(NULL)
+       Thread() : ExitFlag(false)
        {
        }
 
-       /** If this thread has a Creator set, call it to
-        * free the thread
-        */
-       virtual ~Thread()
-       {
-               if (state)
-               {
-                       state->FreeThread(this);
-                       delete state;
-               }
-       }
-
        /** Override this method to put your actual
         * threaded code here.
         */
@@ -69,10 +66,11 @@ class CoreExport Thread : public Extensible
 
        /** Signal the thread to exit gracefully.
         */
-       virtual void SetExitFlag()
-       {
-               ExitFlag = true;
-       }
+       virtual void SetExitFlag();
+
+       /** Join the thread (calls SetExitFlag and waits for exit)
+        */
+       void join();
 };
 
 
@@ -109,7 +107,7 @@ class CoreExport QueuedThread : public Thread
                queue.Wakeup();
                queue.Unlock();
        }
-       virtual void SetExitFlag()
+       void SetExitFlag() CXX11_OVERRIDE
        {
                queue.Lock();
                Thread::SetExitFlag();
@@ -132,12 +130,12 @@ class CoreExport SocketThread : public Thread
        {
                queue.Wait();
        }
+ public:
        /** Notifies parent by making the SignalFD ready to read
         * No requirements on locking
         */
        void NotifyParent();
- public:
-       SocketThread(InspIRCd* SI);
+       SocketThread();
        virtual ~SocketThread();
        /** Lock queue.
         */
@@ -158,7 +156,7 @@ class CoreExport SocketThread : public Thread
                queue.Wakeup();
                queue.Unlock();
        }
-       virtual void SetExitFlag()
+       void SetExitFlag() CXX11_OVERRIDE
        {
                queue.Lock();
                Thread::SetExitFlag();
@@ -172,6 +170,3 @@ class CoreExport SocketThread : public Thread
         */
        virtual void OnNotify() = 0;
 };
-
-#endif
-