更新接口文档发

This commit is contained in:
wangsong 2021-09-10 14:42:29 +08:00
parent de5693fd20
commit 1c144a99b0
1 changed files with 81 additions and 0 deletions

81
interface.md Executable file
View File

@ -0,0 +1,81 @@
### DBUS接口
#### 描述
实现系统升级以python apt库和aptdeamon的形式
#### Dbus接口信息
| 名称 | 含义 |
| -------------- | ------------------------------------ |
| BUS类型 | SYSTEM BUS |
| DBUS名称 | org.freedesktop.UpdateManager |
| OBJECT路径 | /org/freedesktop/UpdateManagerObject |
| INTERFACES名称 | org.freedesktop.UpdateManagerIFace |
#### Method列表
| Method Name | Input Args | Output Args | means |
| --------------- | ---------- | ----------- | --------------------------------- |
| update | 无 | b | 更新cache产生组升级列表JSON文件 |
| all_upgrade | 无 | b | 全部升级 |
| partial_upgrade | as | b | 部分升级 |
| | | | |
| | | | |
#### Method分析
##### update
| method name | input args | out args |
| --------------------------------- | ---------- | ---------- |
| update | 无 | b |
| 更新cache产生组升级列表JSON文件 | | 成功或失败 |
##### all_upgrade
| method name | input args | out args |
| ----------- | ---------- | ---------- |
| all_upgrade | 无 | b |
| 全部升级 | | 成功或失败 |
##### partial_upgrade
| method name | input args | out args |
| --------------- | ------------ | ---------- |
| partial_upgrade | as | b |
| 部分升级 | (升级组列表) | 成功或失败 |
#### Signal列表
| Method Name | Output Args | means |
| ---------------------- | ----------- | ------------------------ |
| update_progress_signal | is | 更新进度信息以及状态信息 |
| update_finished_signal | basss | 更新完成信号 |
| | | |
| | | |
#### Signal分析
##### update_progress_signal
| method name | out args |
| ---------------------- | -------------------------------------------- |
| update_progress_signal | is |
| 部分升级 | i:进度状态0-100101为非预期状态 S状态信息 |
update_finished_signal
| method name | out args |
| ---------------------- | --------------------------------------------------- |
| update_progress_signal | basss |
| 部分升级 | b:成功或失败、as:可升级的组、s:错误结果、s:错误原因 |