File: sync_service_observer.h

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (46 lines) | stat: -rw-r--r-- 1,909 bytes parent folder | download | duplicates (6)
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
// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef COMPONENTS_SYNC_SERVICE_SYNC_SERVICE_OBSERVER_H_
#define COMPONENTS_SYNC_SERVICE_SYNC_SERVICE_OBSERVER_H_

namespace syncer {

class SyncService;

// An observer that gets notified whenever any state in the SyncService changes.
// IMPORTANT: Observers must be removed before SyncService::Shutdown() gets
// called (during the KeyedServices shutdown sequence). If your observer is tied
// to a KeyedService itself, declare an appropriate DependsOn() relation and
// remove the observer in your service's Shutdown(). Otherwise, implement
// SyncServiceObserver::OnSyncShutdown() and remove the observer there.
class SyncServiceObserver {
 public:
  // When one of the following events occurs, OnStateChanged() is called.
  // Observers should query the service to determine what happened.
  // - The sync service initialized successfully.
  // - The sync servers are unavailable at this time.
  // - Credentials are now in flight for authentication.
  // - The data type configuration has started or ended.
  // - Sync shut down.
  // - Sync errors (passphrase, auth, unrecoverable, actionable, etc.).
  // - Encryption changes.
  virtual void OnStateChanged(SyncService* sync) {}

  // If a client wishes to handle sync cycle completed events in a special way,
  // they can use this function.  By default, it re-routes to OnStateChanged().
  virtual void OnSyncCycleCompleted(SyncService* sync);

  // Called when the sync service is being shutdown permanently, so that
  // longer-lived observers can drop references to it.
  virtual void OnSyncShutdown(SyncService* sync) {}

 protected:
  SyncServiceObserver() = default;
  virtual ~SyncServiceObserver() = default;
};

}  // namespace syncer

#endif  // COMPONENTS_SYNC_SERVICE_SYNC_SERVICE_OBSERVER_H_