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) 2009 Daniel De Graaf <danieldg@inspircd.org>
8 * Copyright (C) 2008, 2010 Craig Edwards <brain@inspircd.org>
10 * This file is part of InspIRCd. InspIRCd is free software: you can
11 * redistribute it and/or modify it under the terms of the GNU General Public
12 * License as published by the Free Software Foundation, version 2.
14 * This program is distributed in the hope that it will be useful, but WITHOUT
15 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
16 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
19 * You should have received a copy of the GNU General Public License
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
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
42 /** Per-thread state, present in each Thread object, managed by the ThreadEngine
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 /** Stop a thread gracefully.
58 * First, this function asks the thread to terminate by calling Thread::SetExitFlag().
59 * Next, it waits until the thread terminates (on the operating system level). Finally,
60 * all OS-level resources associated with the thread are released. The Thread instance
61 * passed to the function is NOT freed.
62 * When this function returns, the thread is stopped and you can destroy it or restart it
64 * Stopping a thread that is not running is a bug.
65 * @param thread The thread to stop.
67 void Stop(Thread* thread);
70 /** The Mutex class represents a mutex, which can be used to keep threads
71 * properly synchronised. Use mutexes sparingly, as they are a good source
72 * of thread deadlocks etc, and should be avoided except where absolutely
73 * necessary. Note that the internal behaviour of the mutex varies from OS
74 * to OS depending on the thread engine, for example in windows a Mutex
75 * in InspIRCd uses critical sections, as they are faster and simpler to
78 class CoreExport Mutex
81 pthread_mutex_t putex;
87 pthread_mutex_init(&putex, NULL);
89 /** Enter/enable the mutex lock.
93 pthread_mutex_lock(&putex);
95 /** Leave/disable the mutex lock.
99 pthread_mutex_unlock(&putex);
105 pthread_mutex_destroy(&putex);
109 class ThreadQueueData : public Mutex
115 pthread_cond_init(&cond, NULL);
120 pthread_cond_destroy(&cond);
125 pthread_cond_signal(&cond);
130 pthread_cond_wait(&cond, &putex);
134 class ThreadSignalSocket;
135 class ThreadSignalData
138 ThreadSignalSocket* sock;