diff options
Diffstat (limited to 'include/threadengine.h')
-rw-r--r-- | include/threadengine.h | 96 |
1 files changed, 0 insertions, 96 deletions
diff --git a/include/threadengine.h b/include/threadengine.h index 228f817ca..27060ebe9 100644 --- a/include/threadengine.h +++ b/include/threadengine.h @@ -20,100 +20,6 @@ #include "inspircd_config.h" #include "base.h" -class InspIRCd; -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 Extensible -{ - protected: - - /** Creator instance - */ - InspIRCd* ServerInstance; - - public: - - /** Constructor. - * @param Instance Creator object - */ - ThreadEngine(InspIRCd* Instance); - - /** 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. - */ - virtual void Start(Thread* thread_to_init) = 0; - - /** Returns the thread engine's name for display purposes - * @return The thread engine name - */ - virtual const std::string GetName() - { - return "<pure-virtual>"; - } -}; - -/** 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 -{ - protected: - /** Enable or disable the Mutex. This method has somewhat confusing - * wording (e.g. the function name and parameters) so it is protected - * in preference of the Lock() and Unlock() methods which are user- - * accessible. - * - * @param enable True to enable the mutex (enter it) and false to - * disable the mutex (leave it). - */ - virtual void Enable(bool enable) = 0; - public: - - /** Constructor. - */ - Mutex(); - - /** Enter/enable the mutex lock. - */ - void Lock() { Enable(true); } - - /** Leave/disable the mutex lock. - */ - void Unlock() { Enable(false); } - - /** Destructor - */ - ~Mutex() { } -}; - -class CoreExport ThreadData -{ - public: - virtual void FreeThread(Thread* thread) { } -}; - /** 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! @@ -168,7 +74,5 @@ class CoreExport Thread : public Extensible } }; - - #endif |