CriticalSection.h

Go to the documentation of this file.

#pragma once





class cCriticalSection
{
    friend class cDeadlockDetect;  // Allow the DeadlockDetect to read the internals, so that it may output some statistics

public:
    void Lock(void);
    void Unlock(void);

    cCriticalSection(void);

    bool IsLocked(void);

    bool IsLockedByCurrentThread(void);

private:

    int m_RecursionCount;

    std::thread::id m_OwningThreadID;

    std::recursive_mutex m_Mutex;
};




class cCSLock
{
    cCriticalSection * m_CS;

    // Unlike a cCriticalSection, this object should be used from a single thread, therefore access to m_IsLocked is not threadsafe
    // In Windows, it is an error to call cCriticalSection::Unlock() multiple times if the lock is not held,
    // therefore we need to check this value whether we are locked or not.
    bool m_IsLocked;

public:
    cCSLock(cCriticalSection * a_CS);
    cCSLock(cCriticalSection & a_CS);
    ~cCSLock();

    // Temporarily unlock or re-lock:
    void Lock(void);
    void Unlock(void);

private:
    DISALLOW_COPY_AND_ASSIGN(cCSLock);
} ;





class cCSUnlock
{
    cCSLock & m_Lock;
public:
    cCSUnlock(cCSLock & a_Lock);
    ~cCSUnlock();

private:
    DISALLOW_COPY_AND_ASSIGN(cCSUnlock);
} ;