| OLD | NEW |
| 1 // Copyright 2014 The Chromium Authors. All rights reserved. | 1 // Copyright 2014 The Chromium Authors. All rights reserved. |
| 2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
| 3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
| 4 | 4 |
| 5 #ifndef SYNC_ENGINE_COMMIT_PROCESSOR_H_ | 5 #ifndef SYNC_ENGINE_COMMIT_PROCESSOR_H_ |
| 6 #define SYNC_ENGINE_COMMIT_PROCESSOR_H_ | 6 #define SYNC_ENGINE_COMMIT_PROCESSOR_H_ |
| 7 | 7 |
| 8 #include <map> | 8 #include <map> |
| 9 #include <vector> | 9 #include <vector> |
| 10 | 10 |
| 11 #include "base/basictypes.h" | 11 #include "base/basictypes.h" |
| 12 #include "sync/base/sync_export.h" | 12 #include "sync/base/sync_export.h" |
| 13 #include "sync/internal_api/public/base/model_type.h" | 13 #include "sync/internal_api/public/base/model_type.h" |
| 14 #include "sync/internal_api/public/engine/model_safe_worker.h" | 14 #include "sync/internal_api/public/engine/model_safe_worker.h" |
| 15 #include "sync/sessions/model_type_registry.h" | 15 #include "sync/sessions/model_type_registry.h" |
| 16 | 16 |
| 17 namespace syncer { | 17 namespace syncer { |
| 18 | 18 |
| 19 namespace syncable { | 19 namespace syncable { |
| 20 class Directory; | 20 class Directory; |
| 21 } // namespace syncable | 21 } // namespace syncable |
| 22 | 22 |
| 23 class SyncDirectoryCommitContributor; | 23 class CommitContributor; |
| 24 class SyncDirectoryCommitContribution; | 24 class CommitContribution; |
| 25 | 25 |
| 26 // This class manages the set of per-type committer objects. | 26 // This class manages the set of per-type committer objects. |
| 27 // | 27 // |
| 28 // It owns these types and hides the details of iterating over all of them. | 28 // It owns these types and hides the details of iterating over all of them. |
| 29 // Many methods allow the caller to specify a subset of types on which the | 29 // Many methods allow the caller to specify a subset of types on which the |
| 30 // operation is to be applied. It is a logic error if the supplied set of types | 30 // operation is to be applied. It is a logic error if the supplied set of types |
| 31 // contains a type which was not previously registered. | 31 // contains a type which was not previously registered. |
| 32 class SYNC_EXPORT_PRIVATE CommitProcessor { | 32 class SYNC_EXPORT_PRIVATE CommitProcessor { |
| 33 public: | 33 public: |
| 34 typedef std::map<ModelType, SyncDirectoryCommitContribution*> ContributionMap; | 34 typedef std::map<ModelType, CommitContribution*> ContributionMap; |
| 35 | 35 |
| 36 // Contructs a CommitProcessor from a map of CommitContributors. |
| 37 // The CommitProcessor does not own this map. |
| 36 explicit CommitProcessor(CommitContributorMap* commit_contributor_map); | 38 explicit CommitProcessor(CommitContributorMap* commit_contributor_map); |
| 37 ~CommitProcessor(); | 39 ~CommitProcessor(); |
| 38 | 40 |
| 39 // Gathers a set of contributions to be used to populate a commit message. | 41 // Gathers a set of contributions to be used to populate a commit message. |
| 42 // |
| 43 // For each of the |commit_types| in this CommitProcessor's CommitContributor |
| 44 // map, gather any entries queued for commit into CommitContributions. The |
| 45 // total number of entries in all the returned CommitContributions shall not |
| 46 // exceed |max_entries|. |
| 40 void GatherCommitContributions( | 47 void GatherCommitContributions( |
| 41 ModelTypeSet commit_types, | 48 ModelTypeSet commit_types, |
| 42 size_t max_entries, | 49 size_t max_entries, |
| 43 ContributionMap* contributions); | 50 ContributionMap* contributions); |
| 44 | 51 |
| 45 private: | 52 private: |
| 46 // A map of 'commit contributors', one for each enabled type. | 53 // A map of 'commit contributors', one for each enabled type. |
| 47 CommitContributorMap* commit_contributor_map_; | 54 CommitContributorMap* commit_contributor_map_; |
| 48 | 55 |
| 49 DISALLOW_COPY_AND_ASSIGN(CommitProcessor); | 56 DISALLOW_COPY_AND_ASSIGN(CommitProcessor); |
| 50 }; | 57 }; |
| 51 | 58 |
| 52 } // namespace syncer | 59 } // namespace syncer |
| 53 | 60 |
| 54 #endif // SYNC_ENGINE_COMMIT_PROCESSOR_H_ | 61 #endif // SYNC_ENGINE_COMMIT_PROCESSOR_H_ |
| OLD | NEW |