• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdepimlibs 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_ >:
Inheritance graph
[legend]

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)
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
 QObject (QObject *parent, const char *name)
 
bool blockSignals (bool block)
 
QObject * child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
 
const QObjectList & children () const
 
const char * className () const
 
bool connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const QObject *receiver, const char *method)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method)
 
void dumpObjectInfo ()
 
void dumpObjectTree ()
 
QList< QByteArray > dynamicPropertyNames () const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
T findChild (const QString &name) const
 
QList< T > findChildren (const QRegExp &regExp) const
 
QList< T > findChildren (const QString &name) const
 
bool inherits (const char *className) const
 
void insertChild (QObject *object)
 
void installEventFilter (QObject *filterObj)
 
bool isA (const char *className) const
 
bool isWidgetType () const
 
void killTimer (int id)
 
virtual const QMetaObject * metaObject () const
 
void moveToThread (QThread *targetThread)
 
const char * name () const
 
const char * name (const char *defaultName) const
 
QString objectName () const
 
QObject * parent () const
 
QVariant property (const char *name) const
 
void removeChild (QObject *object)
 
void removeEventFilter (QObject *obj)
 
void setName (const char *name)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const
 
int startTimer (int interval)
 
QThread * thread () const
 

Additional Inherited Members

- Signals inherited from Akonadi::EntityCacheBase
void dataAvailable ()
 
- Static Public Member Functions inherited from QObject
bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
bool connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Protected Member Functions inherited from QObject
bool checkConnectArgs (const char *signal, const QObject *object, const char *method)
 
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const char *signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const char *signal)
 
int receivers (const char *signal) const
 
QObject * sender () const
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *event)
 
- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
 
- Protected Attributes inherited from Akonadi::EntityCacheBase
Session * session
 
- Properties inherited from QObject
 objectName
 

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 Function Documentation

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.

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.

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.

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.

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.

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.

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-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:38:04 by doxygen 1.8.7 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
  • Modules
  • Related Pages

kdepimlibs API Reference

Skip menu "kdepimlibs 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

Search



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