blob: 83d4119e5fe8fefe02dd23d8e8076ad0aea2f3c5 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
|
/*
* Copyright (C) 2007-2013 Xagasoft, All rights reserved.
*
* This file is part of the libbu++ library and is released under the
* terms of the license contained in the file LICENSE.
*/
#ifndef BU_MUTEX_H
#define BU_MUTEX_H
#include <pthread.h>
namespace Bu
{
/**
* Simple mutex wrapper. Currently this doesn't do anything extra for you
* except keep all of the functionality together in an OO sorta' way and
* keep you from having to worry about cleaning up your mutexes properly,
* or initing them.
*@ingroup Threading
*/
class Mutex
{
public:
/**
* Create an unlocked mutex.
*/
Mutex();
/**
* Destroy a mutex. This can only be done when a mutex is unlocked.
* Failure to unlock before destroying a mutex object could cause it to
* wait for the mutex to unlock, the odds of which are usually farily
* low at deconstruction time.
*/
~Mutex();
/**
* Lock the mutex. This causes all future calls to lock on this
* instance of mutex to block until the first thread that called mutex
* unlocks it. At that point the next thread that called lock will get
* a chance to go to work. Because of the nature of a mutex lock it is
* a very bad idea to do any kind of serious or rather time consuming
* computation within a locked section. This can cause thread-deadlock
* and your program may hang.
*/
int lock();
/**
* Unlock the mutex. This allows the next thread that asked for a lock
* to lock the mutex and continue with execution.
*/
int unlock();
/**
* Try to lock the mutex. This is the option to go with if you cannot
* avoid putting lengthy operations within a locked section. trylock
* will attempt to lock the mutex, if the mutex is already locked this
* function returns immediately with an error code.
*/
int trylock();
protected:
pthread_mutex_t mutex; /**< The internal mutex reference. */
};
}
#endif
|
