X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fthreadengine.h;h=4bf5a48f38399a94d367989f405f9bff213f5936;hb=4c751dbbe8945e5efc230a59b0ed51c2ba10cf92;hp=27060ebe9e5a4d0b18977a85ed21738c8ea43cbc;hpb=f9e6de5284aaacd55aa389445cd595bdcaa8339e;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/threadengine.h b/include/threadengine.h index 27060ebe9..4bf5a48f3 100644 --- a/include/threadengine.h +++ b/include/threadengine.h @@ -1,18 +1,25 @@ -/* +------------------------------------+ - * | 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 + * Copyright (C) 2008 Craig Edwards * - * 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 . */ -#ifndef __THREADENGINE__ -#define __THREADENGINE__ + +#ifndef THREADENGINE_H +#define THREADENGINE_H #include #include @@ -20,16 +27,26 @@ #include "inspircd_config.h" #include "base.h" +class ThreadData; + /** 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; + protected: + /** Get thread's current exit status. + * (are we being asked to exit?) + */ + bool GetExitFlag() + { + return ExitFlag; + } public: /** Opaque thread state managed by threading engine */ @@ -41,17 +58,8 @@ class CoreExport Thread : public Extensible { } - /** If this thread has a Creator set, call it to - * free the thread - */ - virtual ~Thread() - { - if (state) - { - state->FreeThread(this); - delete state; - } - } + /* If the thread is running, you MUST join BEFORE deletion */ + virtual ~Thread(); /** Override this method to put your actual * threaded code here. @@ -60,18 +68,109 @@ class CoreExport Thread : public Extensible /** Signal the thread to exit gracefully. */ - void SetExitFlag(bool value) + virtual void SetExitFlag(); + + /** Join the thread (calls SetExitFlag and waits for exit) + */ + void join(); +}; + + +class CoreExport QueuedThread : public Thread +{ + ThreadQueueData queue; + protected: + /** Waits for an enqueue operation to complete + * You MUST hold the queue lock when you call this. + * It will be unlocked while you wait, and will be relocked + * before the function returns + */ + void WaitForQueue() + { + queue.Wait(); + } + public: + /** Lock queue. + */ + void LockQueue() + { + queue.Lock(); + } + /** Unlock queue. + */ + void UnlockQueue() { - ExitFlag = value; + queue.Unlock(); } + /** Unlock queue and wake up worker + */ + void UnlockQueueWakeup() + { + queue.Wakeup(); + queue.Unlock(); + } + virtual void SetExitFlag() + { + queue.Lock(); + Thread::SetExitFlag(); + queue.Wakeup(); + queue.Unlock(); + } +}; - /** Get thread's current exit status. - * (are we being asked to exit?) +class CoreExport SocketThread : public Thread +{ + ThreadQueueData queue; + ThreadSignalData signal; + protected: + /** Waits for an enqueue operation to complete + * You MUST hold the queue lock when you call this. + * It will be unlocked while you wait, and will be relocked + * before the function returns */ - bool GetExitFlag() + void WaitForQueue() { - return ExitFlag; + queue.Wait(); + } + public: + /** Notifies parent by making the SignalFD ready to read + * No requirements on locking + */ + void NotifyParent(); + SocketThread(); + virtual ~SocketThread(); + /** Lock queue. + */ + void LockQueue() + { + queue.Lock(); } + /** Unlock queue. + */ + void UnlockQueue() + { + queue.Unlock(); + } + /** Unlock queue and send wakeup to worker + */ + void UnlockQueueWakeup() + { + queue.Wakeup(); + queue.Unlock(); + } + virtual void SetExitFlag() + { + queue.Lock(); + Thread::SetExitFlag(); + queue.Wakeup(); + queue.Unlock(); + } + + /** + * Called in the context of the parent thread after a notification + * has passed through the socket + */ + virtual void OnNotify() = 0; }; #endif