A
lgorithmique
N
umérique
D
istribuée
Public GIT Repository
projects
/
simgrid.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
further improve the doc of s4u::Mutex
[simgrid.git]
/
src
/
s4u
/
s4u_mutex.cpp
diff --git
a/src/s4u/s4u_mutex.cpp
b/src/s4u/s4u_mutex.cpp
index
ba83148
..
4f2cce6
100644
(file)
--- a/
src/s4u/s4u_mutex.cpp
+++ b/
src/s4u/s4u_mutex.cpp
@@
-13,21
+13,31
@@
namespace simgrid {
namespace s4u {
namespace simgrid {
namespace s4u {
+/** @brief Blocks the calling actor until the mutex can be obtained */
void Mutex::lock()
{
simcall_mutex_lock(mutex_);
}
void Mutex::lock()
{
simcall_mutex_lock(mutex_);
}
+/** @brief Release the ownership of the mutex, unleashing a blocked actor (if any)
+ *
+ * Will fail if the calling actor does not own the mutex.
+ */
void Mutex::unlock()
{
simcall_mutex_unlock(mutex_);
}
void Mutex::unlock()
{
simcall_mutex_unlock(mutex_);
}
+/** @brief Acquire the mutex if it's free, and return false (without blocking) if not */
bool Mutex::try_lock()
{
return simcall_mutex_trylock(mutex_);
}
bool Mutex::try_lock()
{
return simcall_mutex_trylock(mutex_);
}
+/** @brief Create a new mutex
+ *
+ * See @ref s4u_raii.
+ */
MutexPtr Mutex::createMutex()
{
smx_mutex_t mutex = simcall_mutex_init();
MutexPtr Mutex::createMutex()
{
smx_mutex_t mutex = simcall_mutex_init();