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
|
// Copyright 2014 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.
#ifndef COMPONENTS_SYNC_DRIVER_BACKEND_DATA_TYPE_CONFIGURER_H_
#define COMPONENTS_SYNC_DRIVER_BACKEND_DATA_TYPE_CONFIGURER_H_
#include <map>
#include "base/callback.h"
#include "sync/internal_api/public/base/model_type.h"
#include "sync/internal_api/public/configure_reason.h"
#include "sync/internal_api/public/engine/model_safe_worker.h"
namespace sync_driver {
class ChangeProcessor;
// The DataTypeConfigurer interface abstracts out the action of
// configuring a set of new data types and cleaning up after a set of
// removed data types.
class BackendDataTypeConfigurer {
public:
enum DataTypeConfigState {
CONFIGURE_ACTIVE, // Actively being configured. Data of such types
// will be downloaded if not present locally.
CONFIGURE_INACTIVE, // Already configured or to be configured in future.
// Data of such types is left as it is, no
// downloading or purging.
CONFIGURE_CLEAN, // Actively being configured but requiring unapply
// and GetUpdates first (e.g. for persistence errors).
DISABLED, // Not syncing. Disabled by user.
FATAL, // Not syncing due to unrecoverable error.
CRYPTO, // Not syncing due to a cryptographer error.
UNREADY, // Not syncing due to transient error.
};
typedef std::map<syncer::ModelType, DataTypeConfigState>
DataTypeConfigStateMap;
// Configures sync for data types in config_state_map according to the states.
// |ready_task| is called on the same thread as ConfigureDataTypes
// is called when configuration is done with the set of data types
// that succeeded/failed configuration (i.e., configuration succeeded iff
// the failed set is empty).
// Returns: the set of types that are already configured and are ready to
// start.
//
// TODO(akalin): Use a Delegate class with
// OnConfigureSuccess/OnConfigureFailure/OnConfigureRetry instead of
// a pair of callbacks. The awkward part is handling when
// SyncBackendHost calls ConfigureDataTypes on itself to configure
// Nigori.
virtual syncer::ModelTypeSet ConfigureDataTypes(
syncer::ConfigureReason reason,
const DataTypeConfigStateMap& config_state_map,
const base::Callback<void(syncer::ModelTypeSet, syncer::ModelTypeSet)>&
ready_task,
const base::Callback<void()>& retry_callback) = 0;
// Return model types in |state_map| that match |state|.
static syncer::ModelTypeSet GetDataTypesInState(
DataTypeConfigState state, const DataTypeConfigStateMap& state_map);
// Activates change processing for the given data type. This must
// be called synchronously with the data type's model association so
// no changes are dropped between model association and change
// processor activation.
virtual void ActivateDataType(
syncer::ModelType type, syncer::ModelSafeGroup group,
ChangeProcessor* change_processor) = 0;
// Deactivates change processing for the given data type.
virtual void DeactivateDataType(syncer::ModelType type) = 0;
// Set state of |types| in |state_map| to |state|.
static void SetDataTypesState(DataTypeConfigState state,
syncer::ModelTypeSet types,
DataTypeConfigStateMap* state_map);
protected:
virtual ~BackendDataTypeConfigurer() {}
};
} // namespace sync_driver
#endif // COMPONENTS_SYNC_DRIVER_BACKEND_DATA_TYPE_CONFIGURER_H_
|
