/usr/include/buteosyncfw5/SyncProfile.h is in libbuteosyncfw5-dev 0.7.21+16.04.20151216.1-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 | /*
* This file is part of buteo-syncfw package
*
* Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
* Copyright (C) 2014-2015 Jolla Ltd
*
* 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 SYNCPROFILE_H
#define SYNCPROFILE_H
#include "Profile.h"
#include "SyncLog.h"
#include "SyncSchedule.h"
namespace Buteo {
class SyncProfilePrivate;
/*! \brief A top level synchronization profile.
*
* SyncProfile is derived from Profile. It represents a top level
* synchronization profile, which contains all settings needed for a
* synchronization session. A SyncProfile typically has sub-profiles for the
* used service, client/server plug-in and storage plug-ins. SyncProfile
* extends the Profile inteface with functions for accessing information about
* synchronization schedule and history of finished synchronization sessions
* with this profile.
*/
class SyncProfile : public Profile
{
public:
//! Synchronization types.
enum SyncType
{
//! Synchronization is started manually.
SYNC_MANUAL,
//! Synchronization is triggered automatically based on a defined
//! schedule.
SYNC_SCHEDULED
};
//! Sync destination type.
enum DestinationType
{
//! Destination is a device (N95, Harmattan, OviSuite etc.)
DESTINATION_TYPE_DEVICE,
//! Destination is an online service.
DESTINATION_TYPE_ONLINE,
//! Destination type is not defined.
DESTINATION_TYPE_UNDEFINED
};
//! Sync direction for device-to-device syncs.
enum SyncDirection
{
//! Two way sync.
SYNC_DIRECTION_TWO_WAY,
//! Data is copied from remote device only.
SYNC_DIRECTION_FROM_REMOTE,
//! Data is copied to remote device only.
SYNC_DIRECTION_TO_REMOTE,
//! Sync direction is not defined.
SYNC_DIRECTION_UNDEFINED
};
//! Conflict resolution policy for device-to-device syncs.
enum ConflictResolutionPolicy
{
//! Prefer local data in conflict situation.
CR_POLICY_PREFER_LOCAL_CHANGES,
//! Prefer remote data in conflict situation.
CR_POLICY_PREFER_REMOTE_CHANGES,
//! Conflict resolution policy is undefined.
CR_POLICY_UNDEFINED
};
//! Current status enum
enum CurrentSyncStatus
{
//! NOT_SYNCED - no sync has been done for the profile yet
SYNC_NEVER_HAPPENED,
//! SYNC_SUCCESS - the last sync has been successful
SYNC_SUCCESS,
//! SYNC_FAILED - the last sync has failed
SYNC_FAILED,
//! SYNC_CANCELLED - the last sync has been cancelled
SYNC_CANCLLED
};
/*! \brief Constructs an empty SyncProfile with the given name.
*
* \param aName Name of the profile to create.
*/
explicit SyncProfile(const QString &aName);
/*! \brief Constructs a SyncProfile from the given XML.
*
* \param aRoot Root element of the XML node tree.
*/
explicit SyncProfile(const QDomElement &aRoot);
/*! \brief Copy constructor.
*
* \param aSource Copy source.
*/
SyncProfile(const SyncProfile &aSource);
//! \brief Destructor.
~SyncProfile();
/*! \brief Creates a clone of the sync profile.
*
* \return The clone.
*/
virtual SyncProfile *clone() const;
/*! \brief Sets the name for the profile and associated log.
*/
virtual void setName(const QString &aName);
/*! \brief Sets the name for the profile and associated log.
*/
virtual void setName(const QStringList &aKeys);
//! \see Profile::toXml
virtual QDomElement toXml(QDomDocument &aDoc, bool aLocalOnly = true) const;
/*! \brief Checks if schedule is controlled by a external process (e.g always-up-to-date).
*
* \return True if schedule is controlled by a external process. External process will control the sync,
* buteo schedule is disabled in this case.
*/
virtual bool syncExternallyEnabled() const;
/*! \brief Checks if rush/off-rush schedule is enabled.
*
* \return True if rush/off-rush schedule is enabled. False, if rush/off-rush scheduling is off.
*/
virtual bool rushEnabled() const;
/*! \brief Checks if external rush schedule is to be obeyed.
*
* \return True if rush hour schedule is to be used by a external process, The external process will control the sync, buteo will just call
* the corresponding plugins when a switch from rush to offRush or vice-versa is necessary, corresponding plugins should be prepared to do any needed
* changes.
* False, if rush hour scheduling is controlled by this process or if rush hour scheduling is off (i.e. manual mode).
*/
virtual bool syncExternallyDuringRush() const;
/*! \brief Checks if a given time is inside rush hour and if the sync is controlled by a external process.
*
* \param aDateTime DateTime to check, current DateTime used by default.
*/
virtual bool inExternalSyncRushPeriod(QDateTime aDateTime = QDateTime::currentDateTime()) const;
/*! \brief Gets the time of last completed sync session with this profile.
*
* \return Last sync time. Null object if this could not be determined.
*/
QDateTime lastSyncTime() const;
/*! \brief Gets the time of the last successful sync session for
* this profile
* \return Sync time of the last successful session. Null if this
* could not be determined
*/
QDateTime lastSuccessfulSyncTime() const;
/*! \brief Gets the next scheduled sync time.
*
* \return Next sync time. Null object if the sync type is manual or the
* time could not be determined for some other reason.
*/
virtual QDateTime nextSyncTime(QDateTime aDateTime = QDateTime::currentDateTime()) const;
/*! \brief Gets next time to switch rush/off-rush schedule intervals.
*
* \param aFromTime From time to calculate next switch, usually current time.
* \return Next time to switch rush/off-rush schedule intervals. Null object if schedule is not defined for rush/off-rush
* or if the rush and off-rush intervals are the same.
*/
QDateTime nextRushSwitchTime(const QDateTime& aFromTime) const;
/*! \brief Gets the results of the last sync from the sync log.
*
* \return The results. NULL if not available.
*/
const SyncResults *lastResults() const;
/*! \brief Gets the synchronization log associated with this profile.
*
* \return The sync log. NULL if no log is set.
*/
SyncLog *log() const;
/*! \brief Sets the synchronization log for this profile.
*
* The ownership of the given log object is transferred to this object.
* If a log is already set, the old log object is deleted first.
* \param aLog The log.
*/
void setLog(SyncLog *aLog);
/*! \brief Adds synchronization results to the log.
*
* If a log does not exist yet, an empty log is created first.
* \param aResults Results to add.
*/
void addResults(const SyncResults &aResults);
/*! \brief Gets the sync type of this profile.
*
* \return The sync type.
*/
SyncType syncType() const;
/*! \brief Sets the sync type of this profile (manual/scheduled).
*
* \param aType The new sync type.
*/
void setSyncType(SyncType aType);
/*! \brief Gets the names of storage backends used by this profile.
*
* \return List of storage backend names.
*/
QStringList storageBackendNames() const;
/*! \brief Gets sync schedule settings.
*
* \return Sync schedule.
*/
SyncSchedule syncSchedule() const;
/*! \brief Sets sync schedule settings.
*
* \param aSchedule New schedule.
*/
void setSyncSchedule(const SyncSchedule &aSchedule);
/*! \brief Get the first service sub-profile.
*
* \return Service profile. NULL if not found.
*/
//const Profile *serviceProfile() const;
/*! \brief Get the first service sub-profile.
*
* \return Service profile. NULL if not found.
*/
//Profile *serviceProfile();
/*! \brief Get the first client sub-profile.
*
* \return Client profile. NULL if not found.
*/
const Profile *clientProfile() const;
/*! \brief Get the first client sub-profile.
*
* \return Client profile. NULL if not found.
*/
Profile *clientProfile();
/*! \brief Get the first server sub-profile.
*
* \return Server profile. NULL if not found.
*/
const Profile *serverProfile() const;
/*! \brief Get the first server sub-profile.
*
* \return Server profile. NULL if not found.
*/
Profile *serverProfile();
/*! \brief Get the storage sub-profiles.
*
* \return Storage profiles.
*/
QList<const Profile*> storageProfiles() const;
/*! \brief Get the storage sub-profiles.
*
* \return Storage profiles.
*/
QList<Profile*> storageProfilesNonConst();
/*! \brief Gets sync destination type (device or online).
*
* \return Destination type.
*/
DestinationType destinationType() const;
/*! \brief Gets sync direction (two way, to destination, from destination).
*
* \return Sync direction.
*/
SyncDirection syncDirection() const;
/*! \brief Sets sync direction.
*
* \return New sync direction.
*/
void setSyncDirection(SyncDirection aDirection);
/*! \brief Gets conflict resolution policy.
*
* \return Conflict resolution policy.
*/
ConflictResolutionPolicy conflictResolutionPolicy() const;
/*! \brief Set conflict resolution policy.
*
* \return Conflict resolution policy.
*/
void setConflictResolutionPolicy(ConflictResolutionPolicy aPolicy);
/*! \brief Get the service name of profile.
*
* \return Service name associated with profile.
*/
QString serviceName() const;
/*! \brief If a profiles is interested in SOC, this
* gets the the SOC after time from that profile.
* The time should be in seconds and a value of 0 means
* sync immediately afer change
*
* @return SOC after time or -1 if none is specified
*/
quint32 syncOnChangeAfter() const;
/*! \brief checks if a profile has SOC enabled
*
* @return true if SOC enabled for this profile, false otherwise
*/
bool isSOCProfile() const;
bool hasRetries() const;
QList<quint32> retryIntervals() const;
/*! \brief Gives the current status of the sync as an enum value
* If the current status of ongoing syncs is required, check the
* d-bus API "runningSyncs" which returns the list of currently running
* sync sessions. The current sync sessions cannot be part of a profiel,
*
* @return CurrentSyncStatus
*/
CurrentSyncStatus currentSyncStatus() const;
private:
SyncProfile& operator=(const SyncProfile &aRhs);
SyncProfilePrivate *d_ptr;
};
}
#endif // SYNCPROFILE_H
|