KisAdaptedLock< Adapter > Class Template Reference

#include <KisAdaptedLock.h>

Inheritance diagram for KisAdaptedLock< Adapter >:

Public Member Functions
	KisAdaptedLock (KisAdaptedLock &&rhs)
template<typename Object >
	KisAdaptedLock (Object object)
template<typename Object >
	KisAdaptedLock (Object object, std::adopt_lock_t t)
template<typename Object >
	KisAdaptedLock (Object object, std::defer_lock_t t)
template<typename Object >
	KisAdaptedLock (Object object, std::try_to_lock_t t)
KisAdaptedLock &	operator= (KisAdaptedLock &&rhs)

Detailed Description

template<typename Adapter>
class KisAdaptedLock< Adapter >

A wrapper class that adapts std::unique_lock to any kind of locking that might be necessary to a particular class.

Just define an Adapter class that implements lock(), unlock() and (optionally) try_lock() interface and pass it to KisAdaptedLock. The resulting class will behave as normal std::unique_lock and lock/unlock the object as you instructed it.

See examples in KisCursorOverrideLockAdapter and KisLockFrameGenerationLock

Definition at line 26 of file KisAdaptedLock.h.

Constructor & Destructor Documentation

KisAdaptedLock() [1/5]

template<typename Adapter >

template<typename Object >

KisAdaptedLock< Adapter >::KisAdaptedLock ( Object object )

inline

Definition at line 32 of file KisAdaptedLock.h.

        : Adapter(object)
        , std::unique_lock<Adapter>(
              static_cast<Adapter&>(*this))
    {}

KisAdaptedLock() [2/5]

template<typename Adapter >

template<typename Object >

KisAdaptedLock< Adapter >::KisAdaptedLock ( Object object, std::try_to_lock_t t )

inline

Definition at line 39 of file KisAdaptedLock.h.

        : Adapter(object)
        , std::unique_lock<Adapter>(static_cast<Adapter&>(*this), t)
    {}

KisAdaptedLock() [3/5]

template<typename Adapter >

template<typename Object >

KisAdaptedLock< Adapter >::KisAdaptedLock ( Object object, std::defer_lock_t t )

inline

Definition at line 45 of file KisAdaptedLock.h.

        : Adapter(object)
        , std::unique_lock<Adapter>(static_cast<Adapter&>(*this), t)
    {}

KisAdaptedLock() [4/5]

template<typename Adapter >

template<typename Object >

KisAdaptedLock< Adapter >::KisAdaptedLock ( Object object, std::adopt_lock_t t )

inline

Definition at line 51 of file KisAdaptedLock.h.

        : Adapter(object)
        , std::unique_lock<Adapter>(static_cast<Adapter&>(*this), t)
    {}

KisAdaptedLock() [5/5]

template<typename Adapter >

KisAdaptedLock< Adapter >::KisAdaptedLock ( KisAdaptedLock< Adapter > && rhs )

inline

Definition at line 56 of file KisAdaptedLock.h.

        : Adapter(static_cast<Adapter&>(rhs))
        , std::unique_lock<Adapter>(
              static_cast<Adapter&>(*this), std::adopt_lock)
    {
        rhs.release();
    }

Member Function Documentation

operator=()

template<typename Adapter >

KisAdaptedLock & KisAdaptedLock< Adapter >::operator= ( KisAdaptedLock< Adapter > && rhs )

inline

Definition at line 64 of file KisAdaptedLock.h.

    {
        static_cast<Adapter&>(*this) = rhs;
        static_cast<std::unique_lock<Adapter>&>(*this) =
            std::unique_lock<Adapter>(static_cast<Adapter&>(*this),
                                      std::adopt_lock);
        rhs.release();
        return *this;
    }

---

The documentation for this class was generated from the following file:

• libs/global/KisAdaptedLock.h