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> |
| 9 |
8 #include "sync/base/sync_export.h" | 10 #include "sync/base/sync_export.h" |
9 | 11 |
| 12 namespace sync_pb { |
| 13 class EntityMetadata; |
| 14 } // namespace sync_pb |
| 15 |
10 namespace syncer_v2 { | 16 namespace syncer_v2 { |
| 17 struct DataTypeState; |
11 | 18 |
12 // 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 |
| 21 // per entity metadata for the purpose of propagating changes to the datatype |
| 22 // specific storage implementation. |
| 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 |
| 25 // them. If there are multiple UpdateMetadata / ClearMetadata calls made for the |
| 26 // same metadata record the last one is supposed to win. |
13 class SYNC_EXPORT MetadataChangeList { | 27 class SYNC_EXPORT MetadataChangeList { |
14 public: | 28 public: |
15 MetadataChangeList() {} | 29 MetadataChangeList() {} |
16 virtual ~MetadataChangeList() {} | 30 virtual ~MetadataChangeList() {} |
| 31 |
| 32 // Requests DataTypeState to be updated in the storage. |
| 33 virtual void UpdateDataTypeState(const DataTypeState& data_type_state) = 0; |
| 34 |
| 35 // Requests DataTypeState to be cleared from the storage. |
| 36 virtual void ClearDataTypeState() = 0; |
| 37 |
| 38 // Requests metadata entry to be updated in the storage. |
| 39 // 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 // storage completely by calling the Clear method). |
| 42 virtual void UpdateMetadata(const std::string& client_tag, |
| 43 const sync_pb::EntityMetadata& metadata) = 0; |
| 44 |
| 45 // Requests metadata entry to be cleared from the storage. |
| 46 virtual void ClearMetadata(const std::string& client_tag) = 0; |
17 }; | 47 }; |
18 | 48 |
19 } // namespace syncer_v2 | 49 } // namespace syncer_v2 |
20 | 50 |
21 #endif // SYNC_API_METADATA_CHANGE_LIST_H_ | 51 #endif // SYNC_API_METADATA_CHANGE_LIST_H_ |
OLD | NEW |