1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2009 InspIRCd Development Team
6 * See: http://wiki.inspircd.org/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
14 #ifndef __THREADENGINE_PTHREAD__
15 #define __THREADENGINE_PTHREAD__
18 #include "inspircd_config.h"
23 /** The ThreadEngine class has the responsibility of initialising
24 * Thread derived classes. It does this by creating operating system
25 * level threads which are then associated with the class transparently.
26 * This allows Thread classes to be derived without needing to know how
27 * the OS implements threads. You should ensure that any sections of code
28 * that use threads are threadsafe and do not interact with any other
29 * parts of the code which are NOT known threadsafe! If you really MUST
30 * access non-threadsafe code from a Thread, use the Mutex class to wrap
31 * access to the code carefully.
33 class CoreExport ThreadEngine
38 * @param Instance Creator object
44 virtual ~ThreadEngine();
46 /** Create a new thread. This takes an already allocated
47 * Thread* pointer and initializes it to use this threading
48 * engine. On failure, this function may throw a CoreException.
49 * @param thread_to_init Pointer to a newly allocated Thread
52 void Start(Thread* thread_to_init);
54 /** Returns the thread engine's name for display purposes
55 * @return The thread engine name
57 const std::string GetName()
59 return "posix-thread";
63 class CoreExport ThreadData
67 void FreeThread(Thread* toFree);
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 * neccessary. 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
111 pthread_mutex_t mutex;
116 pthread_mutex_init(&mutex, NULL);
117 pthread_cond_init(&cond, NULL);
122 pthread_mutex_destroy(&mutex);
123 pthread_cond_destroy(&cond);
128 pthread_mutex_lock(&mutex);
133 pthread_mutex_unlock(&mutex);
138 pthread_cond_signal(&cond);
143 pthread_cond_wait(&cond, &mutex);
147 class ThreadSignalSocket;
148 class ThreadSignalData
151 ThreadSignalSocket* sock;