author | peter1138 |
Sun, 03 Aug 2008 17:35:08 +0000 | |
changeset 9834 | 7474149531c1 |
parent 9479 | c8ab793e4595 |
permissions | -rw-r--r-- |
2285
410dedcf46d1
(svn r2809) Implement more generic threading functions, which allow more than one thread
tron
parents:
diff
changeset
|
1 |
/* $Id$ */ |
410dedcf46d1
(svn r2809) Implement more generic threading functions, which allow more than one thread
tron
parents:
diff
changeset
|
2 |
|
9111
48ce04029fe4
(svn r12971) -Documentation: add @file in files that missed them and add something more than whitespace as description of files that don't have a description.
rubidium
parents:
8934
diff
changeset
|
3 |
/** @file thread.h Base of all threads. */ |
6422
6679df1c05ba
(svn r9558) -Documentation: doxygen and comment changes: 'T' now. Almost done
belugas
parents:
6248
diff
changeset
|
4 |
|
2285
410dedcf46d1
(svn r2809) Implement more generic threading functions, which allow more than one thread
tron
parents:
diff
changeset
|
5 |
#ifndef THREAD_H |
410dedcf46d1
(svn r2809) Implement more generic threading functions, which allow more than one thread
tron
parents:
diff
changeset
|
6 |
#define THREAD_H |
410dedcf46d1
(svn r2809) Implement more generic threading functions, which allow more than one thread
tron
parents:
diff
changeset
|
7 |
|
9476
902f9cf6373f
(svn r13411) -Codechange: remove the return value from the thread procs because it is never used.
rubidium
parents:
9111
diff
changeset
|
8 |
typedef void (*OTTDThreadFunc)(void *); |
2285
410dedcf46d1
(svn r2809) Implement more generic threading functions, which allow more than one thread
tron
parents:
diff
changeset
|
9 |
|
8934
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
10 |
/** |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
11 |
* A Thread Object which works on all our supported OSes. |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
12 |
*/ |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
13 |
class ThreadObject { |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
14 |
public: |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
15 |
/** |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
16 |
* Virtual destructor to allow 'delete' operator to work properly. |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
17 |
*/ |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
18 |
virtual ~ThreadObject() {}; |
2285
410dedcf46d1
(svn r2809) Implement more generic threading functions, which allow more than one thread
tron
parents:
diff
changeset
|
19 |
|
8934
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
20 |
/** |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
21 |
* Check if the thread is currently running. |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
22 |
* @return True if the thread is running. |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
23 |
*/ |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
24 |
virtual bool IsRunning() = 0; |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
25 |
|
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
26 |
/** |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
27 |
* Waits for the thread to exit. |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
28 |
* @return True if the thread has exited. |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
29 |
*/ |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
30 |
virtual bool WaitForStop() = 0; |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
31 |
|
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
32 |
/** |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
33 |
* Exit this thread. |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
34 |
*/ |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
35 |
virtual bool Exit() = 0; |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
36 |
|
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
37 |
/** |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
38 |
* Join this thread. |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
39 |
*/ |
9476
902f9cf6373f
(svn r13411) -Codechange: remove the return value from the thread procs because it is never used.
rubidium
parents:
9111
diff
changeset
|
40 |
virtual void Join() = 0; |
8934
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
41 |
|
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
42 |
/** |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
43 |
* Check if this thread is the current active thread. |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
44 |
* @return True if it is the current active thread. |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
45 |
*/ |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
46 |
virtual bool IsCurrent() = 0; |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
47 |
|
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
48 |
/** |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
49 |
* Get the unique ID of this thread. |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
50 |
* @return A value unique to each thread. |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
51 |
*/ |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
52 |
virtual uint GetId() = 0; |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
53 |
|
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
54 |
/** |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
55 |
* Create a thread; proc will be called as first function inside the thread, |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
56 |
* with optinal params. |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
57 |
* @param proc The procedure to call inside the thread. |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
58 |
* @param param The params to give with 'proc'. |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
59 |
* @return True if the thread was started correctly. |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
60 |
*/ |
9479
c8ab793e4595
(svn r13417) -Fix (r12945, r13413): freeing the ThreadObjects in a manner that hopefully doesn't cause crashes.
rubidium
parents:
9477
diff
changeset
|
61 |
static ThreadObject *New(OTTDThreadFunc proc, void *param); |
8934
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
62 |
|
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
63 |
/** |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
64 |
* Convert the current thread to a new ThreadObject. |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
65 |
* @return A new ThreadObject with the current thread attached to it. |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
66 |
*/ |
9476
902f9cf6373f
(svn r13411) -Codechange: remove the return value from the thread procs because it is never used.
rubidium
parents:
9111
diff
changeset
|
67 |
static ThreadObject *AttachCurrent(); |
8934
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
68 |
|
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
69 |
/** |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
70 |
* Find the Id of the current running thread. |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
71 |
* @return The thread ID of the current active thread. |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
72 |
*/ |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
73 |
static uint CurrentId(); |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
74 |
}; |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
75 |
|
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
76 |
/** |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
77 |
* Cross-platform Thread Semaphore. Wait() waits for a Set() of someone else. |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
78 |
*/ |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
79 |
class ThreadSemaphore { |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
80 |
public: |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
81 |
static ThreadSemaphore *New(); |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
82 |
|
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
83 |
/** |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
84 |
* Virtual Destructor to avoid compiler warnings. |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
85 |
*/ |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
86 |
virtual ~ThreadSemaphore() {}; |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
87 |
|
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
88 |
/** |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
89 |
* Signal all threads that are in Wait() to continue. |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
90 |
*/ |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
91 |
virtual void Set() = 0; |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
92 |
|
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
93 |
/** |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
94 |
* Wait until we are signaled by a call to Set(). |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
95 |
*/ |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
96 |
virtual void Wait() = 0; |
f46812d21fe6
(svn r12706) -Merge: the thread rewrite from NoAI. The rewrite makes the threading we have better extendable.
rubidium
parents:
7318
diff
changeset
|
97 |
}; |
2285
410dedcf46d1
(svn r2809) Implement more generic threading functions, which allow more than one thread
tron
parents:
diff
changeset
|
98 |
|
2380
392bba57462d
(svn r2906) Fix some threaded saving problems. Now the thread only interfaces with the main program through a sort of mutex. Communication uses the function OTTD_SendThreadMessage() with the approiate message which is handled in ProcessSentMessage() during the main loop.
Darkvater
parents:
2286
diff
changeset
|
99 |
#endif /* THREAD_H */ |