2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2014 Attila Molnar <attilamolnar@hush.com>
5 * Copyright (C) 2013 Sadie Powell <sadie@witchery.services>
6 * Copyright (C) 2012 Robby <robby@chatbelgie.be>
7 * Copyright (C) 2012 ChrisTX <xpipe@hotmail.de>
8 * Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
9 * Copyright (C) 2008-2010 Craig Edwards <brain@inspircd.org>
11 * This file is part of InspIRCd. InspIRCd is free software: you can
12 * redistribute it and/or modify it under the terms of the GNU General Public
13 * License as published by the Free Software Foundation, version 2.
15 * This program is distributed in the hope that it will be useful, but WITHOUT
16 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
17 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
20 * You should have received a copy of the GNU General Public License
21 * along with this program. If not, see <http://www.gnu.org/licenses/>.
31 /** The ThreadEngine class has the responsibility of initialising
32 * Thread derived classes. It does this by creating operating system
33 * level threads which are then associated with the class transparently.
34 * This allows Thread classes to be derived without needing to know how
35 * the OS implements threads. You should ensure that any sections of code
36 * that use threads are threadsafe and do not interact with any other
37 * parts of the code which are NOT known threadsafe! If you really MUST
38 * access non-threadsafe code from a Thread, use the Mutex class to wrap
39 * access to the code carefully.
41 class CoreExport ThreadEngine
44 /** Per-thread state, present in each Thread object, managed by the ThreadEngine
51 static DWORD WINAPI Entry(void* parameter);
53 /** Create a new thread. This takes an already allocated
54 * Thread* pointer and initializes it to use this threading
55 * engine. On failure, this function may throw a CoreException.
56 * @param thread_to_init Pointer to a newly allocated Thread
59 void Start(Thread* thread_to_init);
61 /** Stop a thread gracefully.
62 * First, this function asks the thread to terminate by calling Thread::SetExitFlag().
63 * Next, it waits until the thread terminates (on the operating system level). Finally,
64 * all OS-level resources associated with the thread are released. The Thread instance
65 * passed to the function is NOT freed.
66 * When this function returns, the thread is stopped and you can destroy it or restart it
68 * Stopping a thread that is not running is a bug.
69 * @param thread The thread to stop.
71 void Stop(Thread* thread);
74 /** The Mutex class represents a mutex, which can be used to keep threads
75 * properly synchronised. Use mutexes sparingly, as they are a good source
76 * of thread deadlocks etc, and should be avoided except where absolutely
77 * necessary. Note that the internal behaviour of the mutex varies from OS
78 * to OS depending on the thread engine, for example in windows a Mutex
79 * in InspIRCd uses critical sections, as they are faster and simpler to
82 class CoreExport Mutex
85 CRITICAL_SECTION wutex;
89 InitializeCriticalSection(&wutex);
93 EnterCriticalSection(&wutex);
97 LeaveCriticalSection(&wutex);
101 DeleteCriticalSection(&wutex);
105 class ThreadQueueData : public Mutex
111 event = CreateEvent(NULL, false, false, NULL);
113 throw CoreException("CreateEvent() failed in ThreadQueueData::ThreadQueueData()!");
129 WaitForSingleObject(event, INFINITE);
134 class ThreadSignalData