• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdepimlibs 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.

Member Function Documentation

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.
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.
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.
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.

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

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

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

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

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

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

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.

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

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

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

Returns whether a message was appended to notificationQueue.


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-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:38:05 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