Debian Codegraph @

docs/util/ddbussender.zh_CN.dox

raw
1 /*!
2 @~chinese
3 @ingroup dutil
4 @file include/util/ddbussender.h
5
6 本文件包含了DDBusSender类和相对应的工具类
7
8 @class DDBusData
9 @brief DBus数据存储类
10 @details 该类用来存储DBus连接的相关信息
11
12 @var DDBusData::service
13 @brief 请求调用服务名
14
15 @var DDBusData::path
16 @brief 请求调用对象路径
17
18 @var DDBusData::interface
19 @brief 请求调用接口名
20
21 @var DDBusData::queryName
22 @brief 请求调用函数名
23
24 @var DDBusData::connection
25 @brief 进行调用的维护的DBus连接
26
27 @class DDBusCaller
28 @brief DBus接口调用工具类
29 @details 该类用于完成实际的DBus接口调用
30
31 @fn template <typename T> DDBusCaller DDBusCaller::arg(const T &argument)
32 @brief 添加调用参数
33 @details 改接口符合链式编程规则
34 @param[in] argument 调用参数
35 @return DDBusCaller 添加参数之后的caller
36
37 @fn QDBusPendingCall DDBusCaller::call()
38 @brief 发起实际调用
39 @return QDBusPendingCall 异步调用对象
40
41 @class DDBusProperty
42 @brief DBus属性操作对象
43 @details 该类的作用和DDBusCaller类似, 用于完成实际的调用, 其封装了org.freedesktop.DBus.Properties的接口, 提供方便快捷地属性访问方法set和get
44
45 @fn QDBusPendingCall DDBusProperty::get()
46 @brief 获取属性值
47 @return QDBusPendingCall 异步调用对象, 在完成之后可用于获取属性值
48
49 @fn template <typename T> QDBusPendingCall DDBusProperty::set(const T &value)
50 @brief 设置属性值
51 @param[in] value 需要设置的值
52 @return QDBusPendingCall 异步调用对象, 在完成之后可用于判断设置操作是否成功
53
54 @class DDBusSender
55 @brief DBus请求工具类
56 @details 通过该类的方法可以方便地调用某个服务的某个方法. 该类的设计采用链式编程, 多个api都会返回操作之后的对象, 这使得原本需要使用QDBusMessage多行代码完成的调用只需要一行代码即可完成.
57
58 @fn DDBusSender DDBusSender::service(const QString &service)
59 @brief 设置请求服务名
60 @param[in] service 请求服务名
61 @return DDBusSender 设置之后的sender
62
63 @fn DDBusSender DDBusSender::interface(const QString &interface)
64 @brief 设置请求接口名
65 @param[in] interface 请求接口名
66 @return DDBusSender 设置之后的sender
67
68 @fn DDBusSender DDBusSender::path(const QString &path)
69 @brief 设置请求对象路径
70 @param[in] path 请求对象路径
71 @return DDBusSender 设置之后的sender
72
73 @fn DDBusCaller DDBusSender::method(const QString &method)
74 @brief 设置请求方法名并获取请求调用对象
75 @details 确保在调用该方法之前, service, path和interface都已经被正确设置
76 @param[in] method 请求方法名
77 @return DDBusCaller 方法调用工具对象, 调用该对象的call函数即可完成最终调用
78
79 @fn DDBusProperty DDBusSender::property(const QString &property)
80 @brief 设置访问的属性名并获得属性操作对象
81 @details 确保在调用该方法之前, service, path和interface都已经被正确设置
82 @param[in] property 访问属性名
83 @return DDBusProperty 属性操作对象
84
85 @fn static DDBusSender DDBusSender::system()
86 @brief 获取 systembus 访问的能力
87 @details DDBusSender 默认使用 sessionbus ,此接口提供 systembus 的访问能力
88 @return DDBusSender 可以访问 systembus 的 sender 对象
89 */