• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.14.10 API Reference
  • KDE Home
  • Contact Us
 

akonadi

  • Akonadi
  • EntityCache
Public Types | Public Member Functions | List of all members
Akonadi::EntityCache< T, FetchJob, FetchScope_ > Class Template Reference

#include <entitycache_p.h>

Inheritance diagram for Akonadi::EntityCache< T, FetchJob, FetchScope_ >:
Akonadi::EntityCacheBase

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)
 
- Public Member Functions inherited from Akonadi::EntityCacheBase
 EntityCacheBase (Session *session, QObject *parent=0)
 
void setSession (Session *session)
 

Additional Inherited Members

- Signals inherited from Akonadi::EntityCacheBase
void dataAvailable ()
 
- Protected Attributes inherited from Akonadi::EntityCacheBase
Session * session
 

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 97 of file entitycache_p.h.

Member Typedef Documentation

◆ FetchScope

template<typename T , typename FetchJob , typename FetchScope_ >
typedef FetchScope_ Akonadi::EntityCache< T, FetchJob, FetchScope_ >::FetchScope

Definition at line 100 of file entitycache_p.h.

Constructor & Destructor Documentation

◆ EntityCache()

template<typename T , typename FetchJob , typename FetchScope_ >
Akonadi::EntityCache< T, FetchJob, FetchScope_ >::EntityCache ( int maxCapacity,
Session * session = 0,
QObject * parent = 0 )
inlineexplicit

Definition at line 101 of file entitycache_p.h.

◆ ~EntityCache()

template<typename T , typename FetchJob , typename FetchScope_ >
Akonadi::EntityCache< T, FetchJob, FetchScope_ >::~EntityCache ( )
inline

Definition at line 107 of file entitycache_p.h.

Member Function Documentation

◆ ensureCached()

template<typename T , typename FetchJob , typename FetchScope_ >
virtual bool Akonadi::EntityCache< T, FetchJob, FetchScope_ >::ensureCached ( typename T::Id id,
const FetchScope & scope )
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()

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 136 of file entitycache_p.h.

◆ isCached()

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 113 of file entitycache_p.h.

◆ isRequested()

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 120 of file entitycache_p.h.

◆ request()

template<typename T , typename FetchJob , typename FetchScope_ >
virtual void Akonadi::EntityCache< T, FetchJob, FetchScope_ >::request ( typename T::Id id,
const FetchScope & scope )
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()

template<typename T , typename FetchJob , typename FetchScope_ >
virtual T Akonadi::EntityCache< T, FetchJob, FetchScope_ >::retrieve ( typename T::Id id) const
inlinevirtual

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

Definition at line 126 of file entitycache_p.h.

◆ update()

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 145 of file entitycache_p.h.


The documentation for this class was generated from the following file:
  • entitycache_p.h
This file is part of the KDE documentation.
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.

akonadi

Skip menu "akonadi"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • Related Pages

kdepimlibs-4.14.10 API Reference

Skip menu "kdepimlibs-4.14.10 API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal