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

akonadi

  • Akonadi
  • MonitorPrivate
Classes | Public Member Functions | Public Attributes | List of all members
Akonadi::MonitorPrivate Class Reference

#include <monitor_p.h>

Inherited by Akonadi::ChangeRecorderPrivate.

Classes

class  PurgeBuffer
 

Public Member Functions

 MonitorPrivate (ChangeNotificationDependenciesFactory *dependenciesFactory_, Monitor *parent)
 
bool acceptNotification (const NotificationMessageV3 &msg) const
 
void cleanOldNotifications ()
 
virtual bool connectToNotificationManager ()
 
void dataAvailable ()
 
Collection::Id deref (Collection::Id id)
 
void dispatchNotifications ()
 
bool emitCollectionNotification (const NotificationMessageV3 &msg, const Collection &col=Collection(), const Collection &par=Collection(), const Collection &dest=Collection())
 
bool emitItemsNotification (const NotificationMessageV3 &msg, const Item::List &items=Item::List(), const Collection &collection=Collection(), const Collection &collectionDest=Collection())
 
virtual bool emitNotification (const NotificationMessageV3 &msg)
 
bool emitTagsNotification (const NotificationMessageV3 &msg, const Tag::List &tags)
 
bool ensureDataAvailable (const NotificationMessageV3 &msg)
 
void flushPipeline ()
 
void init ()
 
void invalidateCache (const Collection &col)
 
void invalidateCaches (const NotificationMessageV3 &msg)
 
void invalidateCollectionCache (qint64 collectionId)
 
void invalidateItemCache (qint64 itemId)
 
void invalidateTagCache (qint64 tagId)
 
bool isMonitored (Collection::Id colId) const
 
virtual void notificationsEnqueued (int)
 
virtual void notificationsErased ()
 
virtual int pipelineSize () const
 
void ref (Collection::Id id)
 
void serverStateChanged (Akonadi::ServerManager::State state)
 
void slotFlushRecentlyChangedCollections ()
 
virtual void slotNotify (const NotificationMessageV3::List &msgs)
 
void slotSessionDestroyed (QObject *object)
 
void slotStatisticsChangedFinished (KJob *job)
 
int translateAndCompress (QQueue< NotificationMessageV3 > &notificationQueue, const NotificationMessageV3 &msg)
 
void updatePendingStatistics (const NotificationMessageV3 &msg)
 

Public Attributes

CollectionCache * collectionCache
 
bool collectionMoveTranslationEnabled
 
Collection::List collections
 
ChangeNotificationDependenciesFactory * dependenciesFactory
 
bool fetchCollection
 
bool fetchCollectionStatistics
 
ItemListCache * itemCache
 
QSet< Item::Id > items
 
class AKONADI_TESTS_EXPORT Akonadi::MonitorPrivate::PurgeBuffer m_buffer
 
CollectionFetchScope mCollectionFetchScope
 
bool mFetchChangedOnly
 
QSet< QString > mimetypes
 
ItemFetchScope mItemFetchScope
 
bool monitorAll
 
TagFetchScope mTagFetchScope
 
NotificationSource * notificationSource
 
QQueue< NotificationMessageV3 > pendingNotifications
 
QQueue< NotificationMessageV3 > pipeline
 
Monitor * q_ptr
 
QHash< Collection::Id, int > refCountMap
 
QSet< QByteArray > resources
 
Session * session
 
QList< QByteArray > sessions
 
TagListCache * tagCache
 
QSet< Tag::Id > tags
 
QSet< Monitor::Type > types
 
bool useRefCounting
 

Detailed Description

Definition at line 51 of file monitor_p.h.

Constructor & Destructor Documentation

◆ ~MonitorPrivate()

virtual Akonadi::MonitorPrivate::~MonitorPrivate ( )
inlinevirtual

Definition at line 55 of file monitor_p.h.

Member Function Documentation

◆ emitCollectionNotification()

bool Akonadi::MonitorPrivate::emitCollectionNotification ( const NotificationMessageV3 &  msg,
const Collection &  col = Collection(),
const Collection &  par = Collection(),
const Collection &  dest = Collection() 
)

Sends out a change notification for a collection.

Returns
true if the notification was actually send to someone, false if no one was listening.

◆ emitItemsNotification()

bool Akonadi::MonitorPrivate::emitItemsNotification ( const NotificationMessageV3 &  msg,
const Item::List &  items = Item::List(),
const Collection &  collection = Collection(),
const Collection &  collectionDest = Collection() 
)

Sends out a change notification for an item.

Returns
true if the notification was actually send to someone, false if no one was listening.

◆ emitNotification()

virtual bool Akonadi::MonitorPrivate::emitNotification ( const NotificationMessageV3 &  msg)
virtual

Sends out the change notification msg.

Parameters
msgthe change notification to send
Returns
true if the notification was actually send to someone, false if no one was listening.

◆ invalidateCache()

void Akonadi::MonitorPrivate::invalidateCache ( const Collection &  col)

Used by ResourceBase to inform us about collection changes before the notifications are emitted, needed to avoid the missing RID race on change replay.

◆ invalidateCollectionCache()

void Akonadi::MonitorPrivate::invalidateCollectionCache ( qint64  collectionId)

This method is called by the ChangeMediator to enforce an invalidation of the passed collection.

◆ invalidateItemCache()

void Akonadi::MonitorPrivate::invalidateItemCache ( qint64  itemId)

This method is called by the ChangeMediator to enforce an invalidation of the passed item.

◆ invalidateTagCache()

void Akonadi::MonitorPrivate::invalidateTagCache ( qint64  tagId)

This method is called by the ChangeMediator to enforce an invalidation of the passed tag.

◆ isMonitored()

bool Akonadi::MonitorPrivate::isMonitored ( Collection::Id  colId) const

Returns true if the collection is monitored by monitor.

A collection is always monitored if useRefCounting is false. If ref counting is used, the collection is only monitored, if the collection is either in refCountMap or m_buffer. If ref counting is used and the collection is not in refCountMap or m_buffer, no updates for the contained items are emitted, because they are lazily ignored.

◆ notificationsEnqueued()

virtual void Akonadi::MonitorPrivate::notificationsEnqueued ( int  )
inlinevirtual

Definition at line 98 of file monitor_p.h.

◆ notificationsErased()

virtual void Akonadi::MonitorPrivate::notificationsErased ( )
inlinevirtual

Definition at line 101 of file monitor_p.h.

◆ pipelineSize()

virtual int Akonadi::MonitorPrivate::pipelineSize ( ) const
virtual

Virtual so that ChangeRecorder can set it to 0 and handle the pipeline itself.

◆ translateAndCompress()

int Akonadi::MonitorPrivate::translateAndCompress ( QQueue< NotificationMessageV3 > &  notificationQueue,
const NotificationMessageV3 &  msg 
)

Returns whether a message was appended to notificationQueue.

Member Data Documentation

◆ collectionCache

CollectionCache* Akonadi::MonitorPrivate::collectionCache

Definition at line 79 of file monitor_p.h.

◆ collectionMoveTranslationEnabled

bool Akonadi::MonitorPrivate::collectionMoveTranslationEnabled

Definition at line 95 of file monitor_p.h.

◆ collections

Collection::List Akonadi::MonitorPrivate::collections

Definition at line 66 of file monitor_p.h.

◆ dependenciesFactory

ChangeNotificationDependenciesFactory* Akonadi::MonitorPrivate::dependenciesFactory

Definition at line 64 of file monitor_p.h.

◆ fetchCollection

bool Akonadi::MonitorPrivate::fetchCollection

Definition at line 93 of file monitor_p.h.

◆ fetchCollectionStatistics

bool Akonadi::MonitorPrivate::fetchCollectionStatistics

Definition at line 94 of file monitor_p.h.

◆ itemCache

ItemListCache* Akonadi::MonitorPrivate::itemCache

Definition at line 80 of file monitor_p.h.

◆ items

QSet<Item::Id> Akonadi::MonitorPrivate::items

Definition at line 68 of file monitor_p.h.

◆ mCollectionFetchScope

CollectionFetchScope Akonadi::MonitorPrivate::mCollectionFetchScope

Definition at line 76 of file monitor_p.h.

◆ mFetchChangedOnly

bool Akonadi::MonitorPrivate::mFetchChangedOnly

Definition at line 77 of file monitor_p.h.

◆ mimetypes

QSet<QString> Akonadi::MonitorPrivate::mimetypes

Definition at line 71 of file monitor_p.h.

◆ mItemFetchScope

ItemFetchScope Akonadi::MonitorPrivate::mItemFetchScope

Definition at line 74 of file monitor_p.h.

◆ monitorAll

bool Akonadi::MonitorPrivate::monitorAll

Definition at line 72 of file monitor_p.h.

◆ mTagFetchScope

TagFetchScope Akonadi::MonitorPrivate::mTagFetchScope

Definition at line 75 of file monitor_p.h.

◆ notificationSource

NotificationSource* Akonadi::MonitorPrivate::notificationSource

Definition at line 65 of file monitor_p.h.

◆ pendingNotifications

QQueue<NotificationMessageV3> Akonadi::MonitorPrivate::pendingNotifications

Definition at line 84 of file monitor_p.h.

◆ pipeline

QQueue<NotificationMessageV3> Akonadi::MonitorPrivate::pipeline

Definition at line 86 of file monitor_p.h.

◆ q_ptr

Monitor* Akonadi::MonitorPrivate::q_ptr

Definition at line 62 of file monitor_p.h.

◆ refCountMap

QHash<Collection::Id, int> Akonadi::MonitorPrivate::refCountMap

Definition at line 222 of file monitor_p.h.

◆ resources

QSet<QByteArray> Akonadi::MonitorPrivate::resources

Definition at line 67 of file monitor_p.h.

◆ session

Session* Akonadi::MonitorPrivate::session

Definition at line 78 of file monitor_p.h.

◆ sessions

QList<QByteArray> Akonadi::MonitorPrivate::sessions

Definition at line 73 of file monitor_p.h.

◆ tagCache

TagListCache* Akonadi::MonitorPrivate::tagCache

Definition at line 81 of file monitor_p.h.

◆ tags

QSet<Tag::Id> Akonadi::MonitorPrivate::tags

Definition at line 69 of file monitor_p.h.

◆ types

QSet<Monitor::Type> Akonadi::MonitorPrivate::types

Definition at line 70 of file monitor_p.h.

◆ useRefCounting

bool Akonadi::MonitorPrivate::useRefCounting

Definition at line 223 of file monitor_p.h.


The documentation for this class was generated from the following file:
  • monitor_p.h
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Thu Jul 21 2022 00:00:00 by doxygen 1.9.5 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-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