akonadi
Akonadi::ChangeRecorder Class Reference
Records and replays change notification. More...
#include <changerecorder.h>

Public Slots | |
void | replayNext () |
Signals | |
void | changesAdded () |
void | nothingToReplay () |
Public Member Functions | |
ChangeRecorder (QObject *parent=0) | |
~ChangeRecorder () | |
void | changeProcessed () |
bool | isEmpty () const |
void | setChangeRecordingEnabled (bool enable) |
void | setConfig (QSettings *settings) |
Detailed Description
Records and replays change notification.
This class is responsible for recording change notification while an agent is not online and replaying the notifications when the agent is online again. Therefore the agent doesn't have to care about online/offline mode in its synchronization algorithm.
Definition at line 41 of file changerecorder.h.
Constructor & Destructor Documentation
ChangeRecorder::ChangeRecorder | ( | QObject * | parent = 0 |
) | [explicit] |
Creates a new change recorder.
Definition at line 122 of file changerecorder.cpp.
ChangeRecorder::~ChangeRecorder | ( | ) |
Destroys the change recorder.
All not yet processed changes are written back to the config file.
Definition at line 130 of file changerecorder.cpp.
Member Function Documentation
void ChangeRecorder::changeProcessed | ( | ) |
Removes the previously emitted change from the records.
Definition at line 173 of file changerecorder.cpp.
void Akonadi::ChangeRecorder::changesAdded | ( | ) | [signal] |
Emitted when new changes are recorded.
bool ChangeRecorder::isEmpty | ( | ) | const |
Returns whether there are recorded changes.
Definition at line 167 of file changerecorder.cpp.
void Akonadi::ChangeRecorder::nothingToReplay | ( | ) | [signal] |
Emitted when replayNext() was called, but there was no valid change to replay.
This can happen when all pending changes have been filtered out, for example. You only need to connect to this signal if you rely on one signal being emitted as a result of calling replayNext().
void ChangeRecorder::replayNext | ( | ) | [slot] |
Replay the next change notification and erase the previous one from the record.
Definition at line 149 of file changerecorder.cpp.
void ChangeRecorder::setChangeRecordingEnabled | ( | bool | enable | ) |
Enables change recording.
If change recording is disabled, this class behaves exactly like Akonadi::Monitor. Change recording is enabled by default.
Definition at line 181 of file changerecorder.cpp.
void ChangeRecorder::setConfig | ( | QSettings * | settings | ) |
Sets the QSettings object used for persistent recorded changes.
Definition at line 136 of file changerecorder.cpp.
The documentation for this class was generated from the following files: