KisLockFreeCache< T > Class Template Reference

#include <kis_lock_free_cache.h>

Public Member Functions
T	getValue () const
void	invalidate ()
bool	tryGetValue (T &result) const
virtual	~KisLockFreeCache ()

Protected Member Functions
virtual T	calculateNewValue () const =0

Private Attributes
KisCacheStateValue	m_state
T	m_value

Detailed Description

template<typename T>
class KisLockFreeCache< T >

Definition at line 98 of file kis_lock_free_cache.h.

Constructor & Destructor Documentation

~KisLockFreeCache()

template<typename T >

virtual KisLockFreeCache< T >::~KisLockFreeCache ( )

inlinevirtual

Definition at line 101 of file kis_lock_free_cache.h.

{}

Member Function Documentation

calculateNewValue()

template<typename T >

virtual T KisLockFreeCache< T >::calculateNewValue ( ) const

protectedpure virtual

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

getValue()

template<typename T >

T KisLockFreeCache< T >::getValue ( ) const

inline

Calculate the value or fetch it from the cache

Definition at line 113 of file kis_lock_free_cache.h.

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

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

invalidate()

template<typename T >

void KisLockFreeCache< T >::invalidate ( )

inline

Notify the cache that the value has changed

Definition at line 106 of file kis_lock_free_cache.h.

                      {
        m_state.invalidate();
    }

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

tryGetValue()

template<typename T >

bool KisLockFreeCache< T >::tryGetValue ( T & result ) const

inline

Definition at line 135 of file kis_lock_free_cache.h.

                                      {
        KisCacheStateValue::SeqValue seqValue;
        bool isValid = false;
        T savedValue;
 
        if (m_state.startRead(&seqValue)) {
            savedValue = m_value;
            isValid = m_state.endRead(seqValue);
        }
 
        if (isValid) {
            result = savedValue;
        }
 
        return isValid;
    }

References KisCacheStateValue::endRead(), KisLockFreeCache< T >::m_state, KisLockFreeCache< T >::m_value, and KisCacheStateValue::startRead().

Member Data Documentation

m_state

template<typename T >

KisCacheStateValue KisLockFreeCache< T >::m_state

mutableprivate

Definition at line 160 of file kis_lock_free_cache.h.

m_value

template<typename T >

T KisLockFreeCache< T >::m_value

mutableprivate

Definition at line 161 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