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> |
| 9 |
| 10 #include "base/stl_util.h" |
| 11 #include "sync/base/sync_export.h" |
| 12 #include "sync/engine/sync_directory_commit_contributor.h" |
8 #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" |
9 #include "sync/internal_api/public/util/syncer_error.h" | 15 #include "sync/internal_api/public/util/syncer_error.h" |
| 16 #include "sync/protocol/sync.pb.h" |
| 17 #include "sync/util/extensions_activity.h" |
10 | 18 |
11 namespace syncer { | 19 namespace syncer { |
12 | 20 |
13 namespace sessions { | 21 namespace sessions { |
| 22 class StatusController; |
14 class SyncSession; | 23 class SyncSession; |
15 } | 24 } |
16 | 25 |
| 26 class SyncDirectoryCommitContribution; |
17 class Syncer; | 27 class Syncer; |
18 | 28 |
19 // This function will commit batches of unsynced items to the server until the | 29 // This class wraps the actions related to building and executing a single |
20 // number of unsynced and ready to commit items reaches zero or an error is | 30 // commit operation. |
21 // encountered. A request to exit early will be treated as an error and will | |
22 // abort any blocking operations. | |
23 // | 31 // |
24 // The Syncer parameter is provided only for access to its ExitRequested() | 32 // This class' most important responsibility is to manage the ContributionsMap. |
25 // method. This is technically unnecessary since an early exit request should | 33 // This class serves as a container for those objects. Although it would have |
26 // be detected as we attempt to contact the sync server. | 34 // been acceptable to let this class be a dumb container object, it turns out |
27 // | 35 // that there was no other convenient place to put the Init() and |
28 // The SyncSession parameter contains pointers to various bits of state, | 36 // PostAndProcessCommitResponse() functions. So they ended up here. |
29 // including the syncable::Directory that contains all sync items and the | 37 class SYNC_EXPORT_PRIVATE Commit { |
30 // ServerConnectionManager used to contact the server. | 38 public: |
31 SyncerError BuildAndPostCommits( | 39 static Commit* Init( |
32 ModelTypeSet request_types, | 40 ModelTypeSet requested_types, |
33 Syncer* syncer, | 41 size_t max_entries, |
34 sessions::SyncSession* session); | 42 const std::string& account_name, |
| 43 const std::string& cache_guid, |
| 44 CommitContributorMap* contributor_map, |
| 45 ExtensionsActivity* extensions_activity); |
| 46 |
| 47 Commit( |
| 48 const std::map<ModelType, SyncDirectoryCommitContribution*>& |
| 49 contributions, |
| 50 const sync_pb::ClientToServerMessage& message, |
| 51 ExtensionsActivity::Records extensions_activity_buffer); |
| 52 ~Commit(); |
| 53 |
| 54 SyncerError PostAndProcessResponse( |
| 55 sessions::SyncSession* session, |
| 56 sessions::StatusController* status, |
| 57 ExtensionsActivity* extensions_activity); |
| 58 |
| 59 private: |
| 60 typedef std::map<ModelType, SyncDirectoryCommitContribution*> ContributionMap; |
| 61 |
| 62 ContributionMap contributions_; |
| 63 STLValueDeleter<ContributionMap> deleter_; |
| 64 |
| 65 sync_pb::ClientToServerMessage message_; |
| 66 sync_pb::ClientToServerResponse response_; |
| 67 ExtensionsActivity::Records extensions_activity_buffer_; |
| 68 }; |
35 | 69 |
36 } // namespace syncer | 70 } // namespace syncer |
37 | 71 |
38 #endif // SYNC_ENGINE_COMMIT_H_ | 72 #endif // SYNC_ENGINE_COMMIT_H_ |
OLD | NEW |