RWLock.h

Go to the documentation of this file.

//==============================================================================================
//  FILENAME    :   RWLock.h
//  AUTHOR      :   Jing Ning
//  CREATION    :   9/26/01
//  Copyright (C) MicroStrategy Incorporated 2001
//==============================================================================================
#ifndef MSynch_RWLock_h
#define MSynch_RWLock_h

#include "Base/Defines/NoCopy.h"
#include "Base/Defines/StrongPtr.h"
#include "Base/Interfaces/BaseException.h"

#include "Synch.h"
#include "LockCategories.h"
#include "LockOrderViolationException.h"

namespace MSynch
{
    class RWLock
    {
    public:

        typedef MBase::StrongPtr<RWLock, MBase::DeleteOperatorGeneric<RWLock> > Ptr;
        typedef MBase::ReturnPtr<RWLock, MBase::DeleteOperatorGeneric<RWLock> > ReturnPtr;

        class DLL_SYNCH_EXIM ReadSmartLock:
            public MBase::NoCopy
        {
        public:
            ReadSmartLock(RWLock& irRWLock, bool ibLocking = true); // bxia: add second param to control whether we lock in constructor
            ~ReadSmartLock() throw();

            void Lock();
            void Unlock() throw();

        private:
            RWLock& mrRWLock;
            bool mbLocked;
        };

        class DLL_SYNCH_EXIM WriteSmartLock:
            public MBase::NoCopy
        {
        public:
            WriteSmartLock(RWLock& irRWLock, bool ibLocking = true); // bxia: add second param to control whether we lock in constructor
            ~WriteSmartLock() throw();

            void Lock();
            void Unlock() throw();

        private:
            RWLock& mrRWLock;
            bool mbLocked;
        };
        virtual void Delete() throw() = 0;

    protected:
        friend class ReadSmartLock;
        friend class WriteSmartLock;

        virtual void ReadLock() = 0;    

        virtual void WriteLock() = 0; 

        virtual void ReadUnlock() throw() = 0;  
        virtual void WriteUnlock() throw() = 0; 
    };

    // this typedef is obsolete
    typedef RWLock::Ptr RWLockPtr;

    DLL_SYNCH_EXIM RWLock* CreateRWLock(EnumDSSLockStackCategory iLockCategory = DssLkStkCatNotNestingLock);

    class RWLockException:
        public MBase::BaseException
    {
    };
}

#endif // MSynch_RWLock_h