OLD | NEW |
1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. | 1 // Copyright (c) 2012 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_H_ | 5 #ifndef SYNC_ENGINE_COMMIT_H_ |
6 #define SYNC_ENGINE_COMMIT_H_ | 6 #define SYNC_ENGINE_COMMIT_H_ |
7 | 7 |
8 #include <map> | 8 #include "base/containers/scoped_ptr_map.h" |
9 | 9 #include "base/memory/scoped_ptr.h" |
10 #include "base/stl_util.h" | |
11 #include "sync/base/sync_export.h" | 10 #include "sync/base/sync_export.h" |
12 #include "sync/engine/commit_contribution.h" | 11 #include "sync/engine/commit_contribution.h" |
13 #include "sync/internal_api/public/base/model_type.h" | 12 #include "sync/internal_api/public/base/model_type.h" |
14 #include "sync/internal_api/public/engine/model_safe_worker.h" | 13 #include "sync/internal_api/public/engine/model_safe_worker.h" |
15 #include "sync/internal_api/public/util/syncer_error.h" | 14 #include "sync/internal_api/public/util/syncer_error.h" |
16 #include "sync/protocol/sync.pb.h" | 15 #include "sync/protocol/sync.pb.h" |
17 #include "sync/sessions/nudge_tracker.h" | 16 #include "sync/sessions/nudge_tracker.h" |
18 #include "sync/util/extensions_activity.h" | 17 #include "sync/util/extensions_activity.h" |
19 | 18 |
20 namespace syncer { | 19 namespace syncer { |
21 | 20 |
22 namespace sessions { | 21 namespace sessions { |
23 class StatusController; | 22 class StatusController; |
24 class SyncSession; | 23 class SyncSession; |
25 } | 24 } |
26 | 25 |
27 class CommitProcessor; | 26 class CommitProcessor; |
28 class Syncer; | 27 class Syncer; |
29 | 28 |
30 // This class wraps the actions related to building and executing a single | 29 // This class wraps the actions related to building and executing a single |
31 // commit operation. | 30 // commit operation. |
32 // | 31 // |
33 // This class' most important responsibility is to manage the ContributionsMap. | 32 // This class' most important responsibility is to manage the ContributionsMap. |
34 // This class serves as a container for those objects. Although it would have | 33 // This class serves as a container for those objects. Although it would have |
35 // been acceptable to let this class be a dumb container object, it turns out | 34 // been acceptable to let this class be a dumb container object, it turns out |
36 // that there was no other convenient place to put the Init() and | 35 // that there was no other convenient place to put the Init() and |
37 // PostAndProcessCommitResponse() functions. So they ended up here. | 36 // PostAndProcessCommitResponse() functions. So they ended up here. |
38 class SYNC_EXPORT_PRIVATE Commit { | 37 class SYNC_EXPORT_PRIVATE Commit { |
39 public: | 38 public: |
40 Commit( | 39 typedef base::ScopedPtrMap<ModelType, scoped_ptr<CommitContribution>> |
41 const std::map<ModelType, CommitContribution*>& | 40 ContributionMap; |
42 contributions, | 41 |
43 const sync_pb::ClientToServerMessage& message, | 42 Commit(ContributionMap contributions, |
44 ExtensionsActivity::Records extensions_activity_buffer); | 43 const sync_pb::ClientToServerMessage& message, |
| 44 ExtensionsActivity::Records extensions_activity_buffer); |
45 | 45 |
46 // This destructor will DCHECK if CleanUp() has not been called. | 46 // This destructor will DCHECK if CleanUp() has not been called. |
47 ~Commit(); | 47 ~Commit(); |
48 | 48 |
49 static Commit* Init( | 49 static Commit* Init( |
50 ModelTypeSet requested_types, | 50 ModelTypeSet requested_types, |
51 ModelTypeSet enabled_types, | 51 ModelTypeSet enabled_types, |
52 size_t max_entries, | 52 size_t max_entries, |
53 const std::string& account_name, | 53 const std::string& account_name, |
54 const std::string& cache_guid, | 54 const std::string& cache_guid, |
55 CommitProcessor* commit_processor, | 55 CommitProcessor* commit_processor, |
56 ExtensionsActivity* extensions_activity); | 56 ExtensionsActivity* extensions_activity); |
57 | 57 |
58 SyncerError PostAndProcessResponse(sessions::NudgeTracker* nudge_tracker, | 58 SyncerError PostAndProcessResponse(sessions::NudgeTracker* nudge_tracker, |
59 sessions::SyncSession* session, | 59 sessions::SyncSession* session, |
60 sessions::StatusController* status, | 60 sessions::StatusController* status, |
61 ExtensionsActivity* extensions_activity); | 61 ExtensionsActivity* extensions_activity); |
62 | 62 |
63 // Cleans up state associated with this commit. Must be called before the | 63 // Cleans up state associated with this commit. Must be called before the |
64 // destructor. | 64 // destructor. |
65 void CleanUp(); | 65 void CleanUp(); |
66 | 66 |
67 private: | 67 private: |
68 typedef std::map<ModelType, CommitContribution*> ContributionMap; | |
69 | |
70 ContributionMap contributions_; | 68 ContributionMap contributions_; |
71 STLValueDeleter<ContributionMap> deleter_; | |
72 | 69 |
73 sync_pb::ClientToServerMessage message_; | 70 sync_pb::ClientToServerMessage message_; |
74 sync_pb::ClientToServerResponse response_; | 71 sync_pb::ClientToServerResponse response_; |
75 ExtensionsActivity::Records extensions_activity_buffer_; | 72 ExtensionsActivity::Records extensions_activity_buffer_; |
76 | 73 |
77 // Debug only flag used to indicate if it's safe to destruct the object. | 74 // Debug only flag used to indicate if it's safe to destruct the object. |
78 bool cleaned_up_; | 75 bool cleaned_up_; |
79 }; | 76 }; |
80 | 77 |
81 } // namespace syncer | 78 } // namespace syncer |
82 | 79 |
83 #endif // SYNC_ENGINE_COMMIT_H_ | 80 #endif // SYNC_ENGINE_COMMIT_H_ |
OLD | NEW |