Update To 11.40.268.0
[platform/framework/web/crosswalk.git] / src / chrome / browser / sync / profile_sync_service_base.h
index c73ae31..57f1ba6 100644 (file)
@@ -24,15 +24,25 @@ class ProfileSyncServiceBase {
 
   virtual ~ProfileSyncServiceBase() {}
 
-  // Whether sync is enabled by user or not.
+  // Whether sync is enabled by user or not. This does not necessarily mean
+  // that sync is currently running (due to delayed startup, unrecoverable
+  // errors, or shutdown). See SyncActive below for checking whether sync
+  // is actually running.
   virtual bool HasSyncSetupCompleted() const = 0;
 
-  // Returns whether processing changes is allowed.  Check this before doing
-  // any model-modifying operations.
-  virtual bool ShouldPushChanges() = 0;
+  // Returns true if sync is fully initialized and active. This implies that
+  // an initial configuration has successfully completed, although there may
+  // be datatype specific, auth, or other transient errors. To see which
+  // datetypes are actually syncing, see GetActiveTypes() below.
+  // Note that if sync is in backup or rollback mode, SyncActive() will be
+  // false.
+  virtual bool SyncActive() const = 0;
 
   // Get the set of current active data types (those chosen or configured by
   // the user which have not also encountered a runtime error).
+  // Note that if the Sync engine is in the middle of a configuration, this
+  // will the the empty set. Once the configuration completes the set will
+  // be updated.
   virtual syncer::ModelTypeSet GetActiveDataTypes() const = 0;
 
   // Adds/removes an observer. ProfileSyncServiceBase does not take