akonadi
#include <entitycache_p.h>

Public Types | |
typedef FetchScope_ | FetchScope |
Public Member Functions | |
EntityCache (int maxCapacity, Session *session=0, QObject *parent=0) | |
virtual bool | ensureCached (typename T::Id id, const FetchScope &scope) |
void | invalidate (typename T::Id id) |
bool | isCached (typename T::Id id) const |
bool | isRequested (typename T::Id id) const |
virtual void | request (typename T::Id id, const FetchScope &scope) |
virtual 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_ >
A in-memory FIFO cache for a small amount of Entity objects.
Definition at line 79 of file entitycache_p.h.
Member Function Documentation
virtual bool Akonadi::EntityCache< T, FetchJob, FetchScope_ >::ensureCached | ( | typename T::Id | id, |
const FetchScope & | scope | ||
) | [inline, virtual] |
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 136 of file entitycache_p.h.
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 116 of file entitycache_p.h.
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 94 of file entitycache_p.h.
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 101 of file entitycache_p.h.
virtual void Akonadi::EntityCache< T, FetchJob, FetchScope_ >::request | ( | typename T::Id | id, |
const FetchScope & | scope | ||
) | [inline, virtual] |
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 151 of file entitycache_p.h.
virtual T Akonadi::EntityCache< T, FetchJob, FetchScope_ >::retrieve | ( | typename T::Id | id | ) | const [inline, virtual] |
Returns the cached object if available, an empty instance otherwise.
Definition at line 107 of file entitycache_p.h.
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 124 of file entitycache_p.h.
The documentation for this class was generated from the following file:
Documentation copyright © 1996-2012 The KDE developers.
Generated on Thu May 10 2012 22:18:40 by doxygen 1.8.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.