Akonadi::EntityCache< T, FetchJob, FetchScope > Class Template Reference

#include <entitycache_p.h>

Inheritance diagram for Akonadi::EntityCache< T, FetchJob, FetchScope >:

[legend]

List of all members.

Public Member Functions
	EntityCache (int maxCapacity, Session *session=0, QObject *parent=0)
template<>
CollectionFetchJob *	createFetchJob (Collection::Id id)
bool	ensureCached (typename T::Id id, const FetchScope &scope)
template<>
void	extractResult (EntityCacheNode< Item > *node, KJob *job) const
template<>
void	extractResult (EntityCacheNode< Collection > *node, KJob *job) const
void	invalidate (typename T::Id id)
bool	isCached (typename T::Id id) const
bool	isRequested (typename T::Id id) const
void	request (typename T::Id id, const FetchScope &scope)
T	retrieve (typename T::Id id) const
void	update (typename T::Id id, const FetchScope &scope)

---

Detailed Description

template<typename T, typename FetchJob, typename FetchScope>
class Akonadi::EntityCache< T, FetchJob, FetchScope >

For internal use only.

A in-memory FIFO cache for a small amount of Entity objects.

Definition at line 77 of file entitycache_p.h.

---

Member Function Documentation

template<typename T, typename FetchJob, typename FetchScope>

bool Akonadi::EntityCache< T, FetchJob, FetchScope >::ensureCached	(	typename T::Id	id,
		const FetchScope &	scope
	)			[inline]

Requests the object to be cached if it is not yet in the cache.

Returns:

true if it was in the cache already.

Definition at line 133 of file entitycache_p.h.

template<typename T, typename FetchJob, typename FetchScope>

void Akonadi::EntityCache< T, FetchJob, FetchScope >::invalidate

(

typename T::Id

id

)

[inline]

Marks the cache entry as invalid, use in case the object has been deleted on the server.

Definition at line 113 of file entitycache_p.h.

template<typename T, typename FetchJob, typename FetchScope>

bool Akonadi::EntityCache< T, FetchJob, FetchScope >::isCached

(

typename T::Id

id

)

const [inline]

Object is available in the cache and can be retrieved.

Definition at line 91 of file entitycache_p.h.

template<typename T, typename FetchJob, typename FetchScope>

bool Akonadi::EntityCache< T, FetchJob, FetchScope >::isRequested

(

typename T::Id

id

)

const [inline]

Object has been requested but is not yet loaded into the cache or is already available.

Definition at line 98 of file entitycache_p.h.

template<typename T, typename FetchJob, typename FetchScope>

void Akonadi::EntityCache< T, FetchJob, FetchScope >::request	(	typename T::Id	id,
		const FetchScope &	scope
	)			[inline]

Asks the cache to retrieve id.

request is used as a token to indicate which request has been finished in the dataAvailable() signal.

Definition at line 148 of file entitycache_p.h.

template<typename T, typename FetchJob, typename FetchScope>

T Akonadi::EntityCache< T, FetchJob, FetchScope >::retrieve

(

typename T::Id

id

)

const [inline]

Returns the cached object if available, an empty instance otherwise.

Definition at line 104 of file entitycache_p.h.

template<typename T, typename FetchJob, typename FetchScope>

void Akonadi::EntityCache< T, FetchJob, FetchScope >::update	(	typename T::Id	id,
		const FetchScope &	scope
	)			[inline]

Triggers a re-fetching of a cache entry, use if it has changed on the server.

Definition at line 121 of file entitycache_p.h.

---

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

• entitycache_p.h