KDAV::EtagCache

Search for usage in LXR

#include <KDAV/EtagCache>

Inheritance diagram for KDAV::EtagCache:

Public Member Functions

 EtagCache (QObject *parent=nullptr)
 
QStringList changedRemoteIds () const
 
bool contains (const QString &remoteId) const
 
bool etagChanged (const QString &remoteId, const QString &refEtag) const
 
bool isOutOfDate (const QString &remoteId) const
 
void markAsChanged (const QString &remoteId)
 
void removeEtag (const QString &remoteId)
 
void setEtag (const QString &remoteId, const QString &etag)
 
QStringList urls () const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (const QObject *object)
 
qobject_cast (QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 

Protected Member Functions

void setEtagInternal (const QString &remoteId, const QString &etag)
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Additional Inherited Members

- Properties inherited from QObject
 objectName
 
- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
bool disconnect (const QMetaObject::Connection &connection)
 
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)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Public Attributes inherited from QObject
typedef QObjectList
 

Detailed Description

A helper class to cache ETags.

The EtagCache caches the remote ids and ETags of all items in a given collection. This cache is needed to find out which items have been changed in the backend and have to be refetched on the next call of Akonadi::ResourceBase::retrieveItems()

Definition at line 31 of file etagcache.h.

Constructor & Destructor Documentation

◆ EtagCache()

EtagCache::EtagCache ( QObject * parent = nullptr)
explicit

Creates a new ETag cache and populates it with the ETags of items found in collection.

Definition at line 24 of file etagcache.cpp.

Member Function Documentation

◆ changedRemoteIds()

QStringList EtagCache::changedRemoteIds ( ) const

Returns the list of remote ids of items that have been changed in the backend.

Definition at line 83 of file etagcache.cpp.

◆ contains()

bool EtagCache::contains ( const QString & remoteId) const

Checks if the given item is in the cache.

Definition at line 44 of file etagcache.cpp.

◆ etagChanged()

bool EtagCache::etagChanged ( const QString & remoteId,
const QString & refEtag ) const

Check if the known ETag for the remote ID is equal to refEtag.

Definition at line 49 of file etagcache.cpp.

◆ isOutOfDate()

bool EtagCache::isOutOfDate ( const QString & remoteId) const

Returns true if the remote ID is marked as changed (is contained in the return of changedRemoteIds)

Definition at line 62 of file etagcache.cpp.

◆ markAsChanged()

void EtagCache::markAsChanged ( const QString & remoteId)

Mark an item as changed in the backend.

Definition at line 57 of file etagcache.cpp.

◆ removeEtag()

void EtagCache::removeEtag ( const QString & remoteId)

Removes the entry for item with remote ID remoteId.

Definition at line 67 of file etagcache.cpp.

◆ setEtag()

void EtagCache::setEtag ( const QString & remoteId,
const QString & etag )

Sets the ETag for the remote ID.

If the remote ID is marked as changed (is contained in the return of changedRemoteIds), remove it from the changed list.

Definition at line 32 of file etagcache.cpp.

◆ setEtagInternal()

void EtagCache::setEtagInternal ( const QString & remoteId,
const QString & etag )
protected

Sets the ETag for the remote ID.

Definition at line 39 of file etagcache.cpp.

◆ urls()

QStringList EtagCache::urls ( ) const

Returns the list of all items URLs.

Definition at line 78 of file etagcache.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Sun Feb 25 2024 18:42:58 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.