1 /*
2  * Copyright (c) 2021 Huawei Device Co., Ltd.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 
16 #ifndef KVSTORE_SYNC_CALLBACK_H
17 #define KVSTORE_SYNC_CALLBACK_H
18 
19 #include <map>
20 #include "types.h"
21 
22 namespace OHOS {
23 namespace DistributedKv {
24 // client implement this class to watch kvstore change.
25 class KvStoreSyncCallback {
26 public:
27     /**
28      * @brief Constructor.
29      */
30     API_EXPORT KvStoreSyncCallback() = default;
31 
32     /**
33      * @brief Destructor.
34      */
~KvStoreSyncCallback()35     API_EXPORT virtual ~KvStoreSyncCallback()  {}
36 
37     /**
38      * @brief This virtual function will be called on sync callback.
39      *
40      * client should override this function to receive sync results.
41      *
42      * @param results sync results for devices set in sync function.
43     */
44     API_EXPORT virtual void SyncCompleted(const std::map<std::string, Status> &results) = 0;
45 
46     /**
47      * @brief This virtual function will be called on sync callback.
48      *
49      * @param results sync results for devices set in sync function.
50      * @param sequenceId sequence Id of current synchronization.
51     */
SyncCompleted(const std::map<std::string,Status> & results,uint64_t sequenceId)52     API_EXPORT virtual void SyncCompleted(const std::map<std::string, Status> &results, uint64_t sequenceId) {}
53 };
54 }  // namespace DistributedKv
55 }  // namespace OHOS
56 #endif  // KVSTORE_SYNC_CALLBACK_H
57