1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
|
/*
Copyright (c) 2007 Volker Krause <vkrause@kde.org>
This library is free software; you can redistribute it and/or modify it
under the terms of the GNU Library General Public License as published by
the Free Software Foundation; either version 2 of the License, or (at your
option) any later version.
This library is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301, USA.
*/
#ifndef AKONADI_CHANGERECORDER_H
#define AKONADI_CHANGERECORDER_H
#include <akonadi/monitor.h>
class QSettings;
namespace Akonadi {
class ChangeRecorderPrivate;
/**
* @short 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.
*
* Unlike Akonadi::Monitor this class only emits one change signal at a
* time. To receive the next one you need to explicitly call replayNext().
* If a signal is emitted that has no receivers, it's automatically skipped,
* which means you only need to connect to signals you are actually interested
* in.
*
* @author Volker Krause <vkrause@kde.org>
*/
class AKONADI_EXPORT ChangeRecorder : public Monitor
{
Q_OBJECT
public:
/**
* Creates a new change recorder.
*/
explicit ChangeRecorder( QObject *parent = 0 );
/**
* Destroys the change recorder.
* All not yet processed changes are written back to the config file.
*/
~ChangeRecorder();
/**
* Sets the QSettings object used for persistent recorded changes.
*/
void setConfig( QSettings *settings );
/**
* Returns whether there are recorded changes.
*/
bool isEmpty() const;
/**
* Removes the previously emitted change from the records.
*/
void changeProcessed();
/**
* Enables change recording. If change recording is disabled, this class
* behaves exactly like Akonadi::Monitor.
* Change recording is enabled by default.
*/
void setChangeRecordingEnabled( bool enable );
/**
* Debugging: dump current list of notifications, as saved on disk.
*/
QString dumpNotificationListToString() const;
public Q_SLOTS:
/**
* Replay the next change notification and erase the previous one from the record.
*/
void replayNext();
Q_SIGNALS:
/**
* Emitted when new changes are recorded.
*/
void changesAdded();
/**
* 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 nothingToReplay();
protected:
//@cond PRIVATE
explicit ChangeRecorder( ChangeRecorderPrivate *d, QObject *parent = 0 );
//@endcond
private:
//@cond PRIVATE
Q_DECLARE_PRIVATE( ChangeRecorder )
//@endcond
};
}
#endif
|