vmutex.h

Go to the documentation of this file.

/*
Copyright c1997-2014 Trygve Isaacson. All rights reserved.
This file is part of the Code Vault version 4.1
http://www.bombaydigital.com/
License: MIT. See LICENSE.md in the Vault top level directory.
*/

#ifndef vmutex_h
#define vmutex_h

#include "vtypes.h"

#include "vthread_platform.h"
#include "vstring.h"
#include "vinstant.h"

class VMutex {
    public:

        VMutex(const VString& name = VString::EMPTY(), bool suppressLogging = false);
        virtual ~VMutex();

        void setName(const VString& name);

        VMutex_Type* getMutex();

        bool isLockedByCurrentThread() const;

        /* PLATFORM-SPECIFIC STATIC FUNCTIONS --------------------------------
        The remaining functions defined here are the low-level interfaces to
        the platform-specific threading APIs. These are implemented in each
        platform-specific version of vthread_platform.cpp.
        */

        static bool mutexInit(VMutex_Type* mutex);

        static void mutexDestroy(VMutex_Type* mutex);

        static bool mutexLock(VMutex_Type* mutex);

        static bool mutexUnlock(VMutex_Type* mutex);

        static void setLockDelayLoggingThreshold(const VDuration& threshold)    { gVMutexLockDelayLoggingThreshold = threshold; }
        static VDuration getLockDelayLoggingThreshold()                         { return gVMutexLockDelayLoggingThreshold; }
        static void setLockDelayLoggingLevel(int logLevel)                      { gVMutexLockDelayLoggingLevel = logLevel; }
        static int getLockDelayLoggingLevel()                                   { return gVMutexLockDelayLoggingLevel; }

    private:

        VMutex(const VMutex&); // not copyable
        VMutex& operator=(const VMutex&); // not assignable

        // _lock() and _unlock() are only accessible to the locker and unlocker classes, and unit test.
        friend class VMutexLocker;
        friend class VMutexUnlocker;
        friend class VThreadsUnit;

        void _lock(const VString& lockerName = VString::EMPTY());
        void _unlock();

        VMutex_Type             mMutex;             
        VString                 mName;              
        bool                    mSuppressLogging;   
        volatile VThreadID_Type mLastLockThread;    
        VString                 mLastLockerName;    
        VInstant                mLastLockTime;      
        volatile bool           mIsLocked;          

        static VDuration gVMutexLockDelayLoggingThreshold;  
        static int gVMutexLockDelayLoggingLevel;            
};

#endif /* vmutex_h */