blob: 1fc0801c8204e973b7352b615263097abf12092d (
plain)
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
|
// Copyright (c) 2012 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
//
// The AllStatus object watches various sync engine components and aggregates
// the status of all of them into one place.
#ifndef SYNC_ENGINE_ALL_STATUS_H_
#define SYNC_ENGINE_ALL_STATUS_H_
#include <map>
#include <string>
#include "base/compiler_specific.h"
#include "base/macros.h"
#include "base/synchronization/lock.h"
#include "sync/engine/nudge_source.h"
#include "sync/engine/sync_engine_event_listener.h"
#include "sync/engine/syncer_types.h"
#include "sync/internal_api/public/base/model_type.h"
#include "sync/internal_api/public/engine/sync_status.h"
namespace syncer {
class ScopedStatusLock;
struct ServerConnectionEvent;
struct SyncCycleEvent;
// This class collects data and uses it to update its internal state. It can
// return a snapshot of this state as a SyncerStatus object.
//
// Most of this data ends up on the about:sync page. But the page is only
// 'pinged' to update itself at the end of a sync cycle. A user could refresh
// manually, but unless their timing is excellent it's unlikely that a user will
// see any state in mid-sync cycle. We have no plans to change this. However,
// we will continue to collect data and update state mid-sync-cycle in case we
// need to debug slow or stuck sync cycles.
class AllStatus : public SyncEngineEventListener {
public:
AllStatus();
~AllStatus() override;
// SyncEngineEventListener implementation.
void OnSyncCycleEvent(const SyncCycleEvent& event) override;
void OnActionableError(const SyncProtocolError& error) override;
void OnRetryTimeChanged(base::Time retry_time) override;
void OnThrottledTypesChanged(ModelTypeSet throttled_types) override;
void OnMigrationRequested(ModelTypeSet types) override;
void OnProtocolEvent(const ProtocolEvent& event) override;
SyncStatus status() const;
void SetNotificationsEnabled(bool notifications_enabled);
void IncrementNotifiableCommits();
void IncrementNotificationsReceived();
void SetEncryptedTypes(ModelTypeSet types);
void SetCryptographerReady(bool ready);
void SetCryptoHasPendingKeys(bool has_pending_keys);
void SetPassphraseType(PassphraseType type);
void SetHasKeystoreKey(bool has_keystore_key);
void SetKeystoreMigrationTime(const base::Time& migration_time);
void SetSyncId(const std::string& sync_id);
void SetInvalidatorClientId(const std::string& invalidator_client_id);
void IncrementNudgeCounter(NudgeSource source);
protected:
// Examines syncer to calculate syncing and the unsynced count,
// and returns a Status with new values.
SyncStatus CalcSyncing(const SyncCycleEvent& event) const;
SyncStatus CreateBlankStatus() const;
SyncStatus status_;
mutable base::Lock mutex_; // Protects all data members.
private:
friend class ScopedStatusLock;
DISALLOW_COPY_AND_ASSIGN(AllStatus);
};
class ScopedStatusLock {
public:
explicit ScopedStatusLock(AllStatus* allstatus);
~ScopedStatusLock();
protected:
AllStatus* allstatus_;
};
} // namespace syncer
#endif // SYNC_ENGINE_ALL_STATUS_H_
|
