-/* +------------------------------------+
- * | 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;
- public:
- /** Opaque thread state managed by threading engine
+
+ /** Opaque thread state managed by the ThreadEngine
*/
- ThreadData* state;
+ ThreadEngine::ThreadState state;
- /** Set Creator to NULL at this point
+ /** ThreadEngine manages Thread::state
+ */
+ friend class ThreadEngine;
+
+ protected:
+ /** Get thread's current exit status.
+ * (are we being asked to exit?)
*/
- Thread() : ExitFlag(false), state(NULL)
+ bool GetExitFlag()
{
+ return ExitFlag;
}
-
- /** If this thread has a Creator set, call it to
- * free the thread
+ public:
+ /** Set Creator to NULL at this point
*/
- virtual ~Thread()
+ Thread() : ExitFlag(false)
{
- if (state)
- {
- state->FreeThread(this);
- delete state;
- }
}
/** Override this method to put your actual
/** 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()
{
- ExitFlag = value;
+ queue.Wait();
}
-
- /** Get thread's current exit status.
- * (are we being asked to exit?)
+ public:
+ /** Lock queue.
*/
- bool GetExitFlag()
+ void LockQueue()
{
- return ExitFlag;
+ queue.Lock();
+ }
+ /** Unlock queue.
+ */
+ void UnlockQueue()
+ {
+ queue.Unlock();
+ }
+ /** Unlock queue and wake up worker
+ */
+ void UnlockQueueWakeup()
+ {
+ queue.Wakeup();
+ queue.Unlock();
+ }
+ void SetExitFlag() CXX11_OVERRIDE
+ {
+ queue.Lock();
+ Thread::SetExitFlag();
+ queue.Wakeup();
+ queue.Unlock();
}
};
-#endif
+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
+ */
+ void WaitForQueue()
+ {
+ 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();
+ }
+ void SetExitFlag() CXX11_OVERRIDE
+ {
+ 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;
+};
projects / user / henk / code / inspircd.git / blobdiff