cel_lockable.h

Go to the documentation of this file.

//----------------------------------------------------------------------------
//
// (C) 2003-2006 Celartem Technology Inc. All rights reserved.
//----------------------------------------------------------------------------

#ifndef _cel_lockable_h_
#define _cel_lockable_h_

#include "cel_types.h"
#include "cel_datatraits.h"

namespace Celartem
{
    class Lockable
    {
    public:
        virtual void lock() const = 0;

        virtual void unlock() const = 0;

    protected:
        virtual ~Lockable() {}
    };

    class Locker
    {
    public:
        Locker() : m_lockable(NULL)
        {
        }

        Locker(const Lockable& inLockable) : m_lockable(NULL)
        {
            lock(&inLockable);
        }

        Locker(const Locker& inLocker) : m_lockable(NULL)
        {
            lock(inLocker.m_lockable);
        }

        ~Locker()
        {
            unlock();
        }

        Locker& operator=(const Lockable& inLockable)
        {
            lock(&inLockable);
            return *this;
        }

        Locker& operator=(const Locker& inLocker)
        {
            lock(inLocker.m_lockable);
            return *this;
        }
        
        /*
            This method locks the specified Lockable instance.
            \param inLockable
                An instance to lock. You can also pass NULL to release
                the currently locked Lockable instance.
        */
        void lock(const Lockable *inLockable)
        {
            unlock();
            m_lockable = inLockable;
            if(m_lockable)
                m_lockable->lock();
        }
        
        void lock(const Lockable& inLockable)
        {
            lock(&inLockable);
        }

        void unlock()
        {
            if(m_lockable)
            {
                m_lockable->unlock();
                m_lockable = NULL;
            }
        }

        void swap(Locker& inLocker)
        {
            const Lockable *temp = inLocker.m_lockable;
            inLocker.m_lockable = m_lockable;
            m_lockable = temp;
        }
        
        const Lockable* detach()
        {
            const Lockable* l = m_lockable;
            m_lockable = NULL;
            return l;
        }

    private:
        const Lockable *m_lockable;
    };

    CEL_DEFINE_DATATRAITS(Locker, byConstructor, notToBeStored);
}

#endif // _cel_lockable_h_

---

This document is automatically generated using doxygen 1.5.4 at Fri Jun 27 18:21:54 2008.