2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
5 * Copyright (C) 2008 Craig Edwards <craigedwards@brainbox.cc>
7 * This file is part of InspIRCd. InspIRCd is free software: you can
8 * redistribute it and/or modify it under the terms of the GNU General Public
9 * License as published by the Free Software Foundation, version 2.
11 * This program is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
13 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
21 #ifndef THREADENGINE_WIN32_H
22 #define THREADENGINE_WIN32_H
24 #include "inspircd_config.h"
29 /** The ThreadEngine class has the responsibility of initialising
30 * Thread derived classes. It does this by creating operating system
31 * level threads which are then associated with the class transparently.
32 * This allows Thread classes to be derived without needing to know how
33 * the OS implements threads. You should ensure that any sections of code
34 * that use threads are threadsafe and do not interact with any other
35 * parts of the code which are NOT known threadsafe! If you really MUST
36 * access non-threadsafe code from a Thread, use the Mutex class to wrap
37 * access to the code carefully.
39 class CoreExport ThreadEngine
45 virtual ~ThreadEngine();
47 static DWORD WINAPI Entry(void* parameter);
49 /** Create a new thread. This takes an already allocated
50 * Thread* pointer and initializes it to use this threading
51 * engine. On failure, this function may throw a CoreException.
52 * @param thread_to_init Pointer to a newly allocated Thread
55 void Start(Thread* thread_to_init);
57 /** Returns the thread engine's name for display purposes
58 * @return The thread engine name
60 const std::string GetName()
62 return "windows-thread";
66 class CoreExport ThreadData
70 void FreeThread(Thread* toFree);
73 /** The Mutex class represents a mutex, which can be used to keep threads
74 * properly synchronised. Use mutexes sparingly, as they are a good source
75 * of thread deadlocks etc, and should be avoided except where absolutely
76 * neccessary. Note that the internal behaviour of the mutex varies from OS
77 * to OS depending on the thread engine, for example in windows a Mutex
78 * in InspIRCd uses critical sections, as they are faster and simpler to
81 class CoreExport Mutex
84 CRITICAL_SECTION wutex;
88 InitializeCriticalSection(&wutex);
92 EnterCriticalSection(&wutex);
96 LeaveCriticalSection(&wutex);
100 DeleteCriticalSection(&wutex);
104 class ThreadQueueData
106 CRITICAL_SECTION mutex;
111 InitializeCriticalSection(&mutex);
112 event = CreateEvent(NULL, false, false, NULL);
117 DeleteCriticalSection(&mutex);
122 EnterCriticalSection(&mutex);
127 LeaveCriticalSection(&mutex);
137 LeaveCriticalSection(&mutex);
138 WaitForSingleObject(event, INFINITE);
139 EnterCriticalSection(&mutex);
143 class ThreadSignalData