Update copyright headers.

[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 253e8d2237ad38c641fea684c37c14ab17acef35..76886a35a841da95239bee5fc1bd6bb669089ba2 100644 (file)
--- a/include/threadengines/threadengine_pthread.h
+++ b/include/threadengines/threadengine_pthread.h
@@ -1,8 +1,11 @@
 /*
  * InspIRCd -- Internet Relay Chat Daemon
  *
+ *   Copyright (C) 2014 Attila Molnar <attilamolnar@hush.com>
+ *   Copyright (C) 2013, 2021 Sadie Powell <sadie@witchery.services>
+ *   Copyright (C) 2012 Robby <robby@chatbelgie.be>
  *   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
@@ -21,7 +24,8 @@
 #pragma once
 
 #include <pthread.h>
-#include "typedefs.h"
+
+class Thread;
 
 /** The ThreadEngine class has the responsibility of initialising
  * Thread derived classes. It does this by creating operating system
@@ -36,14 +40,12 @@
 class CoreExport ThreadEngine
 {
  public:
-
-       /** Constructor.
-        */
-       ThreadEngine();
-
-       /** Destructor
+       /** Per-thread state, present in each Thread object, managed by the ThreadEngine
         */
-       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
@@ -53,33 +55,30 @@ class CoreExport ThreadEngine
         */
        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
  * 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.
  */
 class CoreExport Mutex
 {
- private:
+ protected:
        pthread_mutex_t putex;
  public:
        /** Constructor.
@@ -108,33 +107,20 @@ class CoreExport Mutex
        }
 };
 
-class ThreadQueueData
+class ThreadQueueData : public Mutex
 {
-       pthread_mutex_t mutex;
        pthread_cond_t cond;
  public:
        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);
@@ -142,7 +128,7 @@ class ThreadQueueData
 
        void Wait()
        {
-               pthread_cond_wait(&cond, &mutex);
+               pthread_cond_wait(&cond, &putex);
        }
 };