blob: 6eadc6dcad66a2459987b8e50a34db3b2672a3ba [file] [log] [blame]
// 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.
#include <map>
#include <string>
#include "base/compiler_specific.h"
#include "base/synchronization/lock.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"
#include "sync/engine/nudge_source.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 {
friend class ScopedStatusLock;
~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);
// 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.
class ScopedStatusLock {
explicit ScopedStatusLock(AllStatus* allstatus);
AllStatus* allstatus_;
} // namespace syncer