diff options
author | Mike Buland <eichlan@xagasoft.com> | 2007-07-03 00:28:59 +0000 |
---|---|---|
committer | Mike Buland <eichlan@xagasoft.com> | 2007-07-03 00:28:59 +0000 |
commit | ac517a2b7625e0aa0862679e961c6349f859ea3b (patch) | |
tree | e3e27a6b9bd5e2be6150088495c91fc91786ad9d /src/itomutex.h | |
parent | f8d4301e9fa4f3709258505941e37fab2eadadc6 (diff) | |
parent | bd865cee5f89116c1f054cd0e5c275e97c2d0a9b (diff) | |
download | libbu++-ac517a2b7625e0aa0862679e961c6349f859ea3b.tar.gz libbu++-ac517a2b7625e0aa0862679e961c6349f859ea3b.tar.bz2 libbu++-ac517a2b7625e0aa0862679e961c6349f859ea3b.tar.xz libbu++-ac517a2b7625e0aa0862679e961c6349f859ea3b.zip |
The reorg is being put in trunk, I think it's ready. Now we just get to find
out how many applications won't work anymore :)
Diffstat (limited to '')
-rw-r--r-- | src/itomutex.h | 61 |
1 files changed, 61 insertions, 0 deletions
diff --git a/src/itomutex.h b/src/itomutex.h new file mode 100644 index 0000000..9c9d205 --- /dev/null +++ b/src/itomutex.h | |||
@@ -0,0 +1,61 @@ | |||
1 | #ifndef BU_ITO_MUTEX_H | ||
2 | #define BU_ITO_MUTEX_H | ||
3 | |||
4 | #include <pthread.h> | ||
5 | |||
6 | namespace Bu | ||
7 | { | ||
8 | /** | ||
9 | * Simple mutex wrapper. Currently this doesn't do anything extra for you | ||
10 | * except keep all of the functionality together in an OO sorta' way and keep | ||
11 | * you from having to worry about cleaning up your mutexes properly, or initing | ||
12 | * them. | ||
13 | *@author Mike Buland | ||
14 | */ | ||
15 | class ItoMutex | ||
16 | { | ||
17 | public: | ||
18 | /** | ||
19 | * Create an unlocked mutex. | ||
20 | */ | ||
21 | ItoMutex(); | ||
22 | |||
23 | /** | ||
24 | * Destroy a mutex. This can only be done when a mutex is unlocked. | ||
25 | * Failure to unlock before destroying a mutex object could cause it to | ||
26 | * wait for the mutex to unlock, the odds of which are usually farily low | ||
27 | * at deconstruction time. | ||
28 | */ | ||
29 | ~ItoMutex(); | ||
30 | |||
31 | /** | ||
32 | * Lock the mutex. This causes all future calls to lock on this instance | ||
33 | * of mutex to block until the first thread that called mutex unlocks it. | ||
34 | * At that point the next thread that called lock will get a chance to go | ||
35 | * to work. Because of the nature of a mutex lock it is a very bad idea to | ||
36 | * do any kind of serious or rather time consuming computation within a | ||
37 | * locked section. This can cause thread-deadlock and your program may | ||
38 | * hang. | ||
39 | */ | ||
40 | int lock(); | ||
41 | |||
42 | /** | ||
43 | * Unlock the mutex. This allows the next thread that asked for a lock to | ||
44 | * lock the mutex and continue with execution. | ||
45 | */ | ||
46 | int unlock(); | ||
47 | |||
48 | /** | ||
49 | * Try to lock the mutex. This is the option to go with if you cannot avoid | ||
50 | * putting lengthy operations within a locked section. trylock will attempt | ||
51 | * to lock the mutex, if the mutex is already locked this function returns | ||
52 | * immediately with an error code. | ||
53 | */ | ||
54 | int trylock(); | ||
55 | |||
56 | protected: | ||
57 | pthread_mutex_t mutex; /**< The internal mutex reference. */ | ||
58 | }; | ||
59 | } | ||
60 | |||
61 | #endif | ||