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) |
![]() | |
EntityCacheBase (Session *session, QObject *parent=0) | |
void | setSession (Session *session) |
Additional Inherited Members | |
![]() | |
void | dataAvailable () |
![]() | |
Session * | session |
Detailed Description
class Akonadi::EntityCache< T, FetchJob, FetchScope_ >
A in-memory FIFO cache for a small amount of Entity objects.
Definition at line 97 of file entitycache_p.h.
Member Typedef Documentation
◆ FetchScope
typedef FetchScope_ Akonadi::EntityCache< T, FetchJob, FetchScope_ >::FetchScope |
Definition at line 100 of file entitycache_p.h.
Constructor & Destructor Documentation
◆ EntityCache()
|
inlineexplicit |
Definition at line 101 of file entitycache_p.h.
◆ ~EntityCache()
|
inline |
Definition at line 107 of file entitycache_p.h.
Member Function Documentation
◆ ensureCached()
|
inlinevirtual |
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 158 of file entitycache_p.h.
◆ invalidate()
|
inline |
Marks the cache entry as invalid, use in case the object has been deleted on the server.
Definition at line 136 of file entitycache_p.h.
◆ isCached()
|
inline |
Object is available in the cache and can be retrieved.
Definition at line 113 of file entitycache_p.h.
◆ isRequested()
|
inline |
Object has been requested but is not yet loaded into the cache or is already available.
Definition at line 120 of file entitycache_p.h.
◆ request()
|
inlinevirtual |
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 173 of file entitycache_p.h.
◆ retrieve()
|
inlinevirtual |
Returns the cached object if available, an empty instance otherwise.
Definition at line 126 of file entitycache_p.h.
◆ update()
|
inline |
Triggers a re-fetching of a cache entry, use if it has changed on the server.
Definition at line 145 of file entitycache_p.h.
The documentation for this class was generated from the following file:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Wed Jan 24 2024 00:00:00 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.