Mutex.h

Go to the documentation of this file.

#pragma once
 
#include <tdme/tdme.h>
#include <tdme/os/threading/fwd-tdme.h>
 
#if defined(CPPTHREADS)
    #include <mutex>
    using std::mutex;
#else
    #include <pthread.h>
#endif
 
#include <string>
 
#include <tdme/os/threading/Condition.h>
 
using std::string;
 
using tdme::os::threading::Condition;
 
/**
 * Mutex implementation.
 * Mutexes are used to ensure that only one process can run a critical section,
 * which is e.g. modifying shared data between thread.
 * @author Andreas Drewke
 */
class tdme::os::threading::Mutex {
    friend class Condition;
 
public:
    /**
     * @brief Public constructor
     * @param name name
     */
    Mutex(const string& name);
 
    /**
     * @brief Destroys the mutex
     */
    ~Mutex();
 
    /**
     * @brief Tries to locks the mutex
     */
    bool tryLock();
 
    /**
     * @brief Locks the mutex, additionally mutex locks will block until other locks have been unlocked.
     */
    void lock();
 
    /**
     * @brief Unlocks this mutex
     */
    void unlock();
 
private:
    string name;
    #if defined(CPPTHREADS)
        mutex mutex;
    #else
        pthread_mutex_t pThreadMutex;
    #endif
 
};