KisLockFreeCacheWithModeConsistency< T, Mode > Class Template Reference

#include <kis_lock_free_cache.h>

Public Member Functions
T	getValue (Mode mode) const
void	invalidate ()
bool	tryGetValue (T &result, Mode mode) const
virtual	~KisLockFreeCacheWithModeConsistency ()

Protected Member Functions
virtual T	calculateNewValue () const =0

Private Attributes
Mode	m_mode
KisCacheStateValue	m_state
T	m_value

Detailed Description

template<typename T, typename Mode>
class KisLockFreeCacheWithModeConsistency< T, Mode >

Definition at line 165 of file kis_lock_free_cache.h.

Constructor & Destructor Documentation

~KisLockFreeCacheWithModeConsistency()

template<typename T , typename Mode >

virtual KisLockFreeCacheWithModeConsistency< T, Mode >::~KisLockFreeCacheWithModeConsistency ( )

inlinevirtual

Definition at line 168 of file kis_lock_free_cache.h.

    {
    }

Member Function Documentation

calculateNewValue()

template<typename T , typename Mode >

virtual T KisLockFreeCacheWithModeConsistency< T, Mode >::calculateNewValue ( ) const

protectedpure virtual

Calculate the value. Used by the cache internally. Reimplemented by the user.

Implemented in KisPaintDeviceCache::ExactBoundsCache, KisPaintDeviceCache::NonDefaultPixelCache, and KisPaintDeviceCache::RegionCache.

getValue()

template<typename T , typename Mode >

T KisLockFreeCacheWithModeConsistency< T, Mode >::getValue ( Mode mode ) const

inline

Calculate the value or fetch it from the cache

Definition at line 182 of file kis_lock_free_cache.h.

                                {
        KisCacheStateValue::SeqValue seqValue;
        bool isValid = false;
        T savedValue;
        Mode savedMode;
 
        if (m_state.startRead(&seqValue)) {
            savedValue = m_value;
            savedMode = m_mode;
            isValid = m_state.endRead(seqValue);
            isValid &= savedMode == mode;
        }
 
        if (isValid) {
            return savedValue;
        } else if (m_state.startWrite(&seqValue)) {
            savedValue = calculateNewValue();
            m_value = savedValue;
            m_mode = mode;
            m_state.endWrite(seqValue);
            return savedValue;
        } else {
            return calculateNewValue();
        }
    }

References KisLockFreeCacheWithModeConsistency< T, Mode >::calculateNewValue(), KisCacheStateValue::endRead(), KisCacheStateValue::endWrite(), KisLockFreeCacheWithModeConsistency< T, Mode >::m_mode, KisLockFreeCacheWithModeConsistency< T, Mode >::m_state, KisLockFreeCacheWithModeConsistency< T, Mode >::m_value, KisCacheStateValue::startRead(), and KisCacheStateValue::startWrite().

invalidate()

template<typename T , typename Mode >

void KisLockFreeCacheWithModeConsistency< T, Mode >::invalidate ( )

inline

Notify the cache that the value has changed

Definition at line 175 of file kis_lock_free_cache.h.

                      {
        m_state.invalidate();
    }

References KisCacheStateValue::invalidate(), and KisLockFreeCacheWithModeConsistency< T, Mode >::m_state.

tryGetValue()

template<typename T , typename Mode >

bool KisLockFreeCacheWithModeConsistency< T, Mode >::tryGetValue ( T & result, Mode mode ) const

inline

Definition at line 208 of file kis_lock_free_cache.h.

                                                 {
        KisCacheStateValue::SeqValue seqValue;
        bool isValid = false;
        T newValue;
        Mode savedMode;
 
        if (m_state.startRead(&seqValue)) {
            newValue = m_value;
            savedMode = m_mode;
            isValid = m_state.endRead(seqValue);
            isValid &= savedMode == mode;
        }
 
        if (isValid) {
            result = newValue;
        }
 
        return isValid;
    }

References KisCacheStateValue::endRead(), KisLockFreeCacheWithModeConsistency< T, Mode >::m_mode, KisLockFreeCacheWithModeConsistency< T, Mode >::m_state, KisLockFreeCacheWithModeConsistency< T, Mode >::m_value, and KisCacheStateValue::startRead().

Member Data Documentation

m_mode

template<typename T , typename Mode >

Mode KisLockFreeCacheWithModeConsistency< T, Mode >::m_mode

mutableprivate

Definition at line 238 of file kis_lock_free_cache.h.

m_state

template<typename T , typename Mode >

KisCacheStateValue KisLockFreeCacheWithModeConsistency< T, Mode >::m_state

mutableprivate

Definition at line 236 of file kis_lock_free_cache.h.

m_value

template<typename T , typename Mode >

T KisLockFreeCacheWithModeConsistency< T, Mode >::m_value

mutableprivate

Definition at line 237 of file kis_lock_free_cache.h.

---

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

• libs/image/kis_lock_free_cache.h