OLD | NEW |
1 // Copyright 2015 The Chromium Authors. All rights reserved. | 1 // Copyright 2015 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_API_METADATA_CHANGE_LIST_H_ | 5 #ifndef SYNC_API_METADATA_CHANGE_LIST_H_ |
6 #define SYNC_API_METADATA_CHANGE_LIST_H_ | 6 #define SYNC_API_METADATA_CHANGE_LIST_H_ |
7 | 7 |
8 #include <string> | 8 #include <string> |
9 | 9 |
10 #include "sync/base/sync_export.h" | 10 #include "sync/base/sync_export.h" |
11 | 11 |
12 namespace sync_pb { | 12 namespace sync_pb { |
| 13 class DataTypeState; |
13 class EntityMetadata; | 14 class EntityMetadata; |
14 } // namespace sync_pb | 15 } // namespace sync_pb |
15 | 16 |
16 namespace syncer_v2 { | 17 namespace syncer_v2 { |
17 struct DataTypeState; | |
18 | 18 |
19 // Interface used by the processor and service to communicate about metadata. | 19 // Interface used by the processor and service to communicate about metadata. |
20 // The purpose of the interface is to record changes to data type global and | 20 // The purpose of the interface is to record changes to data type global and |
21 // per entity metadata for the purpose of propagating changes to the datatype | 21 // per entity metadata for the purpose of propagating changes to the datatype |
22 // specific storage implementation. | 22 // specific storage implementation. |
23 // The implementation of the interface is supposed to keep the record of all | 23 // The implementation of the interface is supposed to keep the record of all |
24 // updated / deleted metadata records and provide a mechanism to enumerate | 24 // updated / deleted metadata records and provide a mechanism to enumerate |
25 // them. If there are multiple UpdateMetadata / ClearMetadata calls made for the | 25 // them. If there are multiple UpdateMetadata / ClearMetadata calls made for the |
26 // same metadata record the last one is supposed to win. | 26 // same metadata record the last one is supposed to win. |
27 class SYNC_EXPORT MetadataChangeList { | 27 class SYNC_EXPORT MetadataChangeList { |
28 public: | 28 public: |
29 MetadataChangeList() {} | 29 MetadataChangeList() {} |
30 virtual ~MetadataChangeList() {} | 30 virtual ~MetadataChangeList() {} |
31 | 31 |
32 // Requests DataTypeState to be updated in the storage. | 32 // Requests DataTypeState to be updated in the storage. |
33 virtual void UpdateDataTypeState(const DataTypeState& data_type_state) = 0; | 33 virtual void UpdateDataTypeState( |
| 34 const sync_pb::DataTypeState& data_type_state) = 0; |
34 | 35 |
35 // Requests DataTypeState to be cleared from the storage. | 36 // Requests DataTypeState to be cleared from the storage. |
36 virtual void ClearDataTypeState() = 0; | 37 virtual void ClearDataTypeState() = 0; |
37 | 38 |
38 // Requests metadata entry to be updated in the storage. | 39 // Requests metadata entry to be updated in the storage. |
39 // Please note that the update might contain a deleted entry if | 40 // Please note that the update might contain a deleted entry if |
40 // metadata.is_deleted() is true (as opposed to clearing the entry from the | 41 // metadata.is_deleted() is true (as opposed to clearing the entry from the |
41 // storage completely by calling the Clear method). | 42 // storage completely by calling the Clear method). |
42 virtual void UpdateMetadata(const std::string& client_tag, | 43 virtual void UpdateMetadata(const std::string& client_tag, |
43 const sync_pb::EntityMetadata& metadata) = 0; | 44 const sync_pb::EntityMetadata& metadata) = 0; |
44 | 45 |
45 // Requests metadata entry to be cleared from the storage. | 46 // Requests metadata entry to be cleared from the storage. |
46 virtual void ClearMetadata(const std::string& client_tag) = 0; | 47 virtual void ClearMetadata(const std::string& client_tag) = 0; |
47 }; | 48 }; |
48 | 49 |
49 } // namespace syncer_v2 | 50 } // namespace syncer_v2 |
50 | 51 |
51 #endif // SYNC_API_METADATA_CHANGE_LIST_H_ | 52 #endif // SYNC_API_METADATA_CHANGE_LIST_H_ |
OLD | NEW |