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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
|
/*
* This file is part of buteo-syncfw package
*
* Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
*
* Contact: Sateesh Kavuri <sateesh.kavuri@nokia.com>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public License
* version 2.1 as published by the Free Software Foundation.
*
* 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA
*
*/
#ifndef SYNCSCHEDULER_H
#define SYNCSCHEDULER_H
#if defined(USE_KEEPALIVE)
#include "BackgroundSync.h"
#include "ProfileManager.h"
#elif defined(USE_IPHB)
#include "SyncAlarmInventory.h"
#include "IPHeartBeat.h"
#endif
#include <QObject>
#include <QMap>
#include <QSet>
#include <QString>
#include <QDateTime>
#include <ctime>
class QDateTime;
#ifdef USE_KEEPALIVE
class BackgroundSync;
#elif defined(USE_IPHB)
class IPHeartBeat;
#endif
namespace Buteo {
class SyncSession;
class SyncSchedulerTest;
class SyncProfile;
/*! \brief SyncScheduler Object to be used to set Schedule via the framework */
class SyncScheduler : public QObject
{
Q_OBJECT
public:
//! \brief Constructor.
SyncScheduler(QObject *aParent = 0);
/**
* \brief Destructor
*/
virtual ~SyncScheduler();
/*! \brief Adds a profile to the scheduler.
*
* Verifies that the profile is enabled and it has schedule enabled
* before adding. If the profile is already added, removes the old schedule
* and then adds the profile again.
* A syncNow signal is sent when sync should be started based on the
* schedule settings of the profile. The signal is sent only once. Call
* this function again after the sync has finished to continue scheduling
* syncs for the profile.
* \param aProfile Profile to add to scheduler.
* \return Success indicator.
*/
bool addProfile(const SyncProfile *aProfile);
/* Schedule a retry for a failed sync if the profile has retries enabled
*
* @param aProfile sync profile
* @param aNExtSyncTime retry after this duration
*/
void addProfileForSyncRetry(const SyncProfile *aProfile, QDateTime aNextSyncTime);
/*! \brief Removes the profile with the given name from the scheduler.
*
* No new syncNow signals will be sent for the profile. Note that an
* already sent signal may still be waiting in the event queue of receiving
* thread.
* \param aProfileName Name of the profile to remove from the scheduler.
*/
void removeProfile(const QString &aProfileName);
public slots:
/*! \brief Handles the sync status change signal from the synchronizer
*
* This allows the SyncScheduler to appropriately wait() or stop() any background
* activity which is preventing device suspend.
*
* @param aProfileName Name of the profile
* @param aStatus Status of the sync
* @param aMessage Status message as a string
* @param aMoreDetails In case of failure, contains detailed reason
*/
void syncStatusChanged(const QString &aProfileName, int aStatus,
const QString &aMessage, int aMoreDetails);
private slots:
#if defined(USE_IPHB)
/**
* \brief Performs needed actions when scheduled alarm is triggered
*
* @param aAlarmEventID an ID that identifies the triggered alarm event
*/
void doAlarmActions(int aAlarmEventID);
#endif
/**
* \brief Performs needed actions when a IP heart beat is triggered
*
* @param aProfileName Name of the profile on which heart beat received
*/
void doIPHeartbeatActions(QString aProfileName);
#if defined(USE_KEEPALIVE)
/**
* \brief Reschedule backgroundActivity for a profile
*
* @param aProfileName Name of the profile to reschedule
*/
void rescheduleBackgroundActivity(const QString &aProfileName);
#endif
signals:
/*! \brief Signal emitted when a sync session should be launched based on
* the sync schedule settings of the profile.
*
* \param aProfileName Name of the profile.
*/
void syncNow(QString aProfileName);
/*! \brief Signal emitted when a sync session should be launched based on
* the sync schedule settings of the profile.
*
* \param aProfileName Name of the profile.
*/
void externalSyncChanged(QString aProfileName, bool aQuery = false);
private: // functions
/**
* \brief Programs next alarm event to alarmd.
*
* @param aProfile The profile for which the alarm is programmed
* @param aNextSyncTime use if provided, otherwise fetch the info from the profile
* @return Unique alarm event ID or 0 in failure case.
*/
int setNextAlarm(const SyncProfile *aProfile, QDateTime aNextSyncTime = QDateTime());
/**
* \brief Creates a DBUS adaptor for the scheduler
*/
void setupDBusAdaptor();
#if defined(USE_IPHB)
/**
* \brief Removes an alarm from alarmd queue
* @param aAlarmEventID ID of the alarm to be removed
*/
void removeAlarmEvent(int aAlarmEvent);
/**
* \brief A convenience method that removes all alarms from alarmd queue
*/
void removeAllAlarms();
#endif
private: // data
QSet<QString> iActiveBackgroundSyncProfiles;
#if defined(USE_KEEPALIVE)
/// BackgroundSync management object
BackgroundSync *iBackgroundActivity;
ProfileManager iProfileManager;
#elif defined(USE_IPHB)
/// A list of sync schedule profiles
QMap<QString, int> iSyncScheduleProfiles;
/// Alarm factory object
SyncAlarmInventory *iAlarmInventory;
/// IP Heartbeat management object
IPHeartBeat *iIPHeartBeatMan;
#endif
#ifdef SYNCFW_UNIT_TESTS
friend class SyncSchedulerTest;
#endif
};
}
#endif // SYNCSCHEDULER_H
|
