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 COMPONENTS_SYNC_ENGINE_IMPL_COMMIT_CONTRIBUTION_H_ | 5 #ifndef COMPONENTS_SYNC_ENGINE_IMPL_COMMIT_CONTRIBUTION_H_ |
6 #define COMPONENTS_SYNC_ENGINE_IMPL_COMMIT_CONTRIBUTION_H_ | 6 #define COMPONENTS_SYNC_ENGINE_IMPL_COMMIT_CONTRIBUTION_H_ |
7 | 7 |
8 #include <stddef.h> | 8 #include <stddef.h> |
9 | 9 |
10 #include "components/sync/base/sync_export.h" | |
11 #include "components/sync/base/syncer_error.h" | 10 #include "components/sync/base/syncer_error.h" |
12 #include "components/sync/protocol/sync.pb.h" | 11 #include "components/sync/protocol/sync.pb.h" |
13 #include "components/sync/sessions_impl/status_controller.h" | 12 #include "components/sync/sessions_impl/status_controller.h" |
14 | 13 |
15 namespace syncer { | 14 namespace syncer { |
16 | 15 |
17 namespace sessions { | 16 namespace sessions { |
18 class StatusController; | 17 class StatusController; |
19 } // namespace sessions | 18 } // namespace sessions |
20 | 19 |
21 // This class represents a set of items belonging to a particular data type that | 20 // This class represents a set of items belonging to a particular data type that |
22 // have been selected from a CommitContributor and prepared for commit. | 21 // have been selected from a CommitContributor and prepared for commit. |
23 // | 22 // |
24 // This class handles the bookkeeping related to the commit of these items. | 23 // This class handles the bookkeeping related to the commit of these items. |
25 class SYNC_EXPORT CommitContribution { | 24 class CommitContribution { |
26 public: | 25 public: |
27 CommitContribution(); | 26 CommitContribution(); |
28 virtual ~CommitContribution() = 0; | 27 virtual ~CommitContribution() = 0; |
29 | 28 |
30 // Serialize this contribution's entries to the given commit request |msg|. | 29 // Serialize this contribution's entries to the given commit request |msg|. |
31 // | 30 // |
32 // This function is not const. It may update some state in this contribution | 31 // This function is not const. It may update some state in this contribution |
33 // that will be used when processing the associated commit response. This | 32 // that will be used when processing the associated commit response. This |
34 // function should not be called more than once. | 33 // function should not be called more than once. |
35 virtual void AddToCommitMessage(sync_pb::ClientToServerMessage* msg) = 0; | 34 virtual void AddToCommitMessage(sync_pb::ClientToServerMessage* msg) = 0; |
(...skipping 11 matching lines...) Expand all Loading... |
47 // before destruction. | 46 // before destruction. |
48 virtual void CleanUp() = 0; | 47 virtual void CleanUp() = 0; |
49 | 48 |
50 // Returns the number of entries included in this contribution. | 49 // Returns the number of entries included in this contribution. |
51 virtual size_t GetNumEntries() const = 0; | 50 virtual size_t GetNumEntries() const = 0; |
52 }; | 51 }; |
53 | 52 |
54 } // namespace syncer | 53 } // namespace syncer |
55 | 54 |
56 #endif // COMPONENTS_SYNC_ENGINE_IMPL_COMMIT_CONTRIBUTION_H_ | 55 #endif // COMPONENTS_SYNC_ENGINE_IMPL_COMMIT_CONTRIBUTION_H_ |
OLD | NEW |