vmutexlocker.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 vmutexlocker_h
#define vmutexlocker_h

#include "vtypes.h"

#include "vstring.h"

class VMutex;

// VMutexLocker ----------------------------------------------------------------

class VMutexLocker {
    public:

        VMutexLocker(VMutex* mutex, const VString& name, bool lockInitially = true);
        virtual ~VMutexLocker();

        virtual void lock();
        virtual void unlock();
        bool isLocked() const { return mIsLocked; }
        VMutex* getMutex() { return mMutex; }
        void yield();

    protected:

        VMutex* mMutex;     
        bool    mIsLocked;  
        VString mName;      

    private:

        // Prevent copy construction and assignment since there is no provision for sharing a mutex.
        VMutexLocker(const VMutexLocker& other);
        VMutexLocker& operator=(const VMutexLocker& other);
};

// VMutexUnlocker --------------------------------------------------------------

class VMutexUnlocker : public VMutexLocker {
    public:

        VMutexUnlocker(VMutex* mutex, bool unlockInitially = true);
        virtual ~VMutexUnlocker();

    private:

        // Prevent copy construction and assignment since there is no provision for sharing a mutex.
        VMutexUnlocker(const VMutexUnlocker& other);
        VMutexUnlocker& operator=(const VMutexUnlocker& other);
};

#endif /* vmutexlocker_h */