1 /*
2  * Copyright (c) 2024 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 OHOS_FILEMGMT_BACKUP_B_INCREMENTAL_BACKUP_BACKUP_H
17 #define OHOS_FILEMGMT_BACKUP_B_INCREMENTAL_BACKUP_BACKUP_H
18 
19 #include <functional>
20 #include <memory>
21 #include <vector>
22 
23 #include "b_file_info.h"
24 #include "b_incremental_data.h"
25 #include "errors.h"
26 #include "svc_death_recipient.h"
27 #include "unique_fd.h"
28 
29 namespace OHOS::FileManagement::Backup {
30 class BIncrementalBackupSession {
31 public:
32     struct Callbacks {
33         std::function<void(const BFileInfo &, UniqueFd, UniqueFd, ErrCode)> onFileReady; // 当备份服务有文件待发送时执行的回调
34         std::function<void(ErrCode, const BundleName)> onBundleStarted; // 当启动某个应用的备份流程结束时执行的回调函数
35         std::function<void(ErrCode, const BundleName)>
36             onBundleFinished; // 当某个应用的备份流程结束或意外中止时执行的回调函数
37         std::function<void(ErrCode)> onAllBundlesFinished; // 当整个备份流程结束或意外中止时执行的回调函数
38         std::function<void(const std::string, const std::string)> onResultReport; // 某个应用备份流程中自定义错误信息的上报的回调函数
39         std::function<void()> onBackupServiceDied;         // 当备份服务意外死亡时执行的回调函数
40         std::function<void(const std::string, const std::string)> onProcess; // 上报备份恢复过程中的进度和异常
41     };
42 
43 public:
44     /**
45      * @brief 获取一个用于控制备份流程的会话
46      *
47      * @param callbacks 注册回调
48      * @return std::unique_ptr<BIncrementalBackupSession> 指向会话的智能指针。失败时为空指针
49      */
50     static std::unique_ptr<BIncrementalBackupSession> Init(Callbacks callbacks);
51 
52     /**
53      * @brief 用于追加应用，现阶段仅支持在Start之前调用
54      *
55      * @param bundlesToBackup 待备份的应用清单
56      * @return ErrCode 规范错误码
57      */
58     ErrCode AppendBundles(std::vector<BIncrementalData> bundlesToBackup);
59 
60     /**
61      * @brief 用于追加应用，现阶段仅支持在Start之前调用, 携带应用扩展信息
62      *
63      * @param bundlesToBackup 待备份的应用清单
64      * @param infos 应用的扩展信息
65      * @return ErrCode 规范错误码
66      */
67     ErrCode AppendBundles(std::vector<BIncrementalData> bundlesToBackup, std::vector<std::string> infos);
68 
69     /**
70      * @brief 用于结束服务
71      *
72      * @return ErrCode 规范错误码
73      */
74     ErrCode Release();
75 
76     /**
77      * @brief 注册备份服务意外死亡时执行的回调函数
78      *
79      * @param functor 回调函数
80      */
81     void RegisterBackupServiceDied(std::function<void()> functor);
82 
83 public:
84     ~BIncrementalBackupSession();
85 
86 private:
87     sptr<SvcDeathRecipient> deathRecipient_;
88 };
89 } // namespace OHOS::FileManagement::Backup
90 
91 #endif // OHOS_FILEMGMT_BACKUP_B_INCREMENTAL_BACKUP_BACKUP_H