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
|
// Copyright 2014 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_ENGINE_COMMIT_PROCESSOR_H_
#define COMPONENTS_SYNC_ENGINE_COMMIT_PROCESSOR_H_
#include <stddef.h>
#include "base/memory/raw_ptr.h"
#include "components/sync/base/data_type.h"
#include "components/sync/engine/commit.h"
#include "components/sync/engine/data_type_registry.h"
namespace syncer {
class CommitContributor;
// This class manages the set of per-type committer objects.
//
// It owns these types and hides the details of iterating over all of them.
// It is a logic error if the supplied set of types contains a type which was
// not previously registered.
class CommitProcessor {
public:
// `commit_types` must contain NIGORI. `commit_contributor_map` must be not
// null and must outlive this object.
CommitProcessor(DataTypeSet commit_types,
CommitContributorMap* commit_contributor_map);
CommitProcessor(const CommitProcessor&) = delete;
CommitProcessor& operator=(const CommitProcessor&) = delete;
~CommitProcessor();
// Gathers a set of contributions to be used to populate a commit message.
//
// For each of the `commit_types` in this CommitProcessor's CommitContributor
// map, gather any entries queued for commit into CommitContributions. The
// total number of entries in all the returned CommitContributions shall not
// exceed `max_entries`.
// Returns no contribution if previous call collected them from all datatypes
// and total number of collected entries was less than `max_entries`.
Commit::ContributionMap GatherCommitContributions(size_t max_entries);
private:
// Gathering is split into phases for 2 reasons: 1) to provide prioritization,
// and 2) to avoid infinite commit cycles when some data type generates
// updates at very high speed.
enum class GatheringPhase { kHighPriority, kRegular, kLowPriority, kDone };
// Increments `phase` (in the order given above in GatheringPhase).
static GatheringPhase IncrementGatheringPhase(GatheringPhase phase);
// Returns user data types that should be gathered for committing in the
// current phase.
DataTypeSet GetUserTypesForCurrentCommitPhase() const;
// Gathers commit contributions for an individual datatype and populates
// `*contributions`. Returns the number of entries added.
size_t GatherCommitContributionsForType(
DataType type,
size_t max_entries,
Commit::ContributionMap* contributions);
// Gathers commit contributions for `types` and populates `*contributions`.
// Returns the number of entries added.
size_t GatherCommitContributionsForTypes(
DataTypeSet types,
size_t max_entries,
Commit::ContributionMap* contributions);
const DataTypeSet commit_types_;
// A map of 'commit contributors', one for each enabled type.
const raw_ptr<CommitContributorMap> commit_contributor_map_;
GatheringPhase phase_;
};
} // namespace syncer
#endif // COMPONENTS_SYNC_ENGINE_COMMIT_PROCESSOR_H_
|
