QDBusConnection Class

成员函数文档

[explicit] QDBusConnection::QDBusConnection(const QString &name)

创建一个 QDBusConnection 对象，该对象连接到名称为name 的连接。

这不会打开连接。您必须调用connectToBus() 才能打开它。

QDBusConnection::QDBusConnection(const QDBusConnection &other)

创建other 连接的副本。

[noexcept] QDBusConnection::~QDBusConnection()

处理该对象。这不会关闭连接：必须调用disconnectFromBus() 才能关闭连接。

QDBusPendingCall QDBusConnection::asyncCall(const QDBusMessage &message, int timeout = -1) const

通过此连接发送message 并立即返回。该函数仅适用于方法调用。它返回一个QDBusPendingCall 类型的对象，可用于跟踪回复状态。

如果在timeout 毫秒内未收到回复，则会自动发送错误信息，说明调用已过期。timeout 的默认值是-1，它将被一个适合进程间通信的实现定义值（一般为 25 秒）所取代。该超时也是 QDBusPendingCall::waitForFinished() 中等待的上限。

请参阅QDBusInterface::asyncCall() 函数，了解更友好的调用方式。

QString QDBusConnection::baseService() const

如果QDBusConnection 对象已连接，则返回此连接的唯一连接名，否则返回空QString 。

唯一连接名称是一个字符串，格式为":x.xxx"（其中 x 为十进制数字），由 D-Bus 服务器守护进程在连接时分配。它在总线中唯一标识该客户机。

对于点对点连接，该函数返回空QString 。

QDBusMessage QDBusConnection::call(const QDBusMessage &message, QDBus::CallMode mode = QDBus::Block, int timeout = -1) const

通过此连接发送message ，并阻塞至多timeout 毫秒，等待回复。该函数仅适用于方法调用。它的返回值是回复消息，类型为QDBusMessage::ReplyMessage 或QDBusMessage::ErrorMessage 。

如果在timeout 毫秒内未收到回复，则会自动发送错误信息，说明调用已过期。timeout 的默认值是-1，它将被一个适合进程间通信的实现定义值（一般为 25 秒）所取代。

有关更友好的调用方式，请参阅QDBusInterface::call() 函数。

bool QDBusConnection::callWithCallback(const QDBusMessage &message, QObject *receiver, const char *returnMethod, const char *errorMethod, int timeout = -1) const

通过此连接发送message 并立即返回。收到回复后，receiver 对象中的方法returnMethod 将被调用。如果出现错误，将调用errorMethod 方法。

如果在timeout 毫秒内未收到回复，将自动发送错误信息，说明调用已过期。timeout 的默认值为-1，它将被一个适合进程间通信的实现定义值（一般为 25 秒）所取代。

该函数仅适用于方法调用。只要参数类型匹配且不出错，就能保证该槽与回复一起被调用一次。

如果信息已发送，则返回true ；如果信息无法发送，则返回 false。

bool QDBusConnection::connect(const QString &service, const QString &path, const QString &interface, const QString &name, QObject *receiver, const char *slot)

将service,path,interface 和name 参数指定的信号连接到对象receiver 中的槽slot 。参数service 和path 可以为空，表示连接到任何远程应用程序的 (interface,name) 信号对中的任何信号。

如果连接成功，则返回true 。

bool QDBusConnection::connect(const QString &service, const QString &path, const QString &interface, const QString &name, const QString &signature, QObject *receiver, const char *slot)

这是一个重载函数。

将信号连接到对象receiver 中的槽slot 。与之前的 connect() 重载不同，该函数允许使用signature 变量指定要连接的参数签名。然后，函数将验证该签名是否能被传送到slot 指定的插槽，否则将返回 false。

如果连接成功，则返回true 。

bool QDBusConnection::connect(const QString &service, const QString &path, const QString &interface, const QString &name, const QStringList &argumentMatch, const QString &signature, QObject *receiver, const char *slot)

这是一个重载函数。

将信号连接到对象receiver 中的槽slot 。与之前的 connect() 重载不同，该函数允许使用signature 变量指定要连接的参数签名。然后，函数将验证该签名是否能被传送到slot 指定的插槽，否则将返回 false。

argumentMatch 参数按顺序列出了要匹配的字符串参数。请注意，要匹配空字符串，需要传递一个空但不为空的QString （即QString("") ）。空QString 会跳过该位置的匹配。

如果连接成功，则返回true 。

[static] QDBusConnection QDBusConnection::connectToBus(QDBusConnection::BusType type, const QString &name)

打开一个与已知总线之一相连的type 类型的连接，并将连接名称name 与之关联。返回与该连接相关联的QDBusConnection 对象。

[static] QDBusConnection QDBusConnection::connectToBus(const QString &address, const QString &name)

打开与地址为address 的私有总线的连接，并将连接名称name 与之关联。返回与该连接相关联的QDBusConnection 对象。

[static] QDBusConnection QDBusConnection::connectToPeer(const QString &address, const QString &name)

在address 地址上打开点对点连接，并将连接名称name 与之关联。返回与该连接相关联的QDBusConnection 对象。

QDBusConnection::ConnectionCapabilities QDBusConnection::connectionCapabilities() const

返回与总线服务器或对等设备协商确定的此连接功能。如果QDBusConnection 未连接，则该函数不返回任何功能。

bool QDBusConnection::disconnect(const QString &service, const QString &path, const QString &interface, const QString &name, QObject *receiver, const char *slot)

断开service 、path 、interface 和name 参数指定的信号与对象receiver 中插槽slot 的连接。参数必须与传递给connect() 函数的参数相同。

如果断开成功，则返回true 。

bool QDBusConnection::disconnect(const QString &service, const QString &path, const QString &interface, const QString &name, const QString &signature, QObject *receiver, const char *slot)

这是一个重载函数。

断开service,path,interface,name, 和signature 参数指定的信号与对象receiver 中插槽slot 的连接。参数必须与传递给connect() 函数的参数相同。

如果断开成功，则返回true 。

bool QDBusConnection::disconnect(const QString &service, const QString &path, const QString &interface, const QString &name, const QStringList &argumentMatch, const QString &signature, QObject *receiver, const char *slot)

这是一个重载函数。

断开service,path,interface,name,argumentMatch, 和signature 参数指定的信号与对象receiver 中插槽slot 的连接。参数必须与传递给connect() 函数的参数相同。

如果断开连接成功，则返回true 。

[static] void QDBusConnection::disconnectFromBus(const QString &name)

关闭名称为name 的总线连接。

请注意，如果仍有QDBusConnection 对象与同一连接相关联，则在删除所有引用之前不会关闭该连接。但是，不能再使用QDBusConnection 构造函数创建其他引用。

[static] void QDBusConnection::disconnectFromPeer(const QString &name)

关闭名称为name 的对等连接。

请注意，如果仍有QDBusConnection 对象与同一连接相关联，则在删除所有引用之前不会关闭连接。但是，不能再使用QDBusConnection 构造函数创建其他引用。

QDBusConnectionInterface *QDBusConnection::interface() const

返回QDBusConnectionInterface 对象，该对象表示此连接上的 D-Bus 服务器接口。

bool QDBusConnection::isConnected() const

如果QDBusConnection 对象已连接，则返回true 。

QDBusError QDBusConnection::lastError() const

返回此连接中发生的最后一次错误。

该函数用于底层代码。如果使用QDBusInterface::call()，错误代码将通过其返回值报告。

另请参阅 QDBusInterface 和QDBusMessage 。

[static] QByteArray QDBusConnection::localMachineId()

返回 D-Bus 系统已知的本地机器 ID。运行 D-Bus 的每个节点或主机都有一个唯一的标识符，如果它们共享文件系统等资源，该标识符可用于将其与其他主机区分开来。

请注意，本地机器 ID 无法保证在系统启动时保持不变，因此不应将此标识符存储在持久存储（如文件系统）中。它只能在本次启动会话期间保持不变。

QString QDBusConnection::name() const

返回此连接的连接名称，如connectToBus() 的 name 参数所示。

连接名称可用于唯一标识总线的实际底层连接。从单个连接复制的连接将始终隐式共享底层连接，因此将具有相同的连接名称。

反之，具有不同连接名称的两个连接要么连接到不同的总线，要么在该总线上具有不同的唯一名称（如baseService() 所返回）。

另请参阅 connectToBus() 和disconnectFromBus()。

QObject *QDBusConnection::objectRegisteredAt(const QString &path) const

返回registerObject() 在path 给定的对象路径下注册的对象。

bool QDBusConnection::registerObject(const QString &path, QObject *object, QDBusConnection::RegisterOptions options = ExportAdaptors)

在路径path 注册对象object ，如果注册成功，则返回true 。options 参数指定通过 D-Bus 公开对象object 的程度。

此函数不会替换现有对象：如果已有对象在路径path 注册，此函数将返回 false。请先使用unregisterObject() 取消注册。

ExportChildObjects 标志根据已注册对象的路径和子对象的QObject::objectName 在 D-Bus 上导出子对象。因此，子对象必须有一个对象名称。

您不能将一个对象注册为通过ExportChildObjects 注册的对象的子对象。

bool QDBusConnection::registerObject(const QString &path, const QString &interface, QObject *object, QDBusConnection::RegisterOptions options = ExportAdaptors)

这是一个重载函数。

以接口名interface 注册路径path 上的对象object ，如果注册成功，则返回true 。options 参数指定通过 D-Bus 公开对象object 的程度。

此函数不会替换现有对象：如果已有对象在路径path 注册，此函数将返回 false。请先使用unregisterObject() 取消注册。

ExportChildObjects 标志根据已注册对象的路径和子对象的QObject::objectName 在 D-Bus 上导出子对象。因此，子对象必须有一个对象名称。

您不能将一个对象注册为通过ExportChildObjects 注册的对象的子对象。

bool QDBusConnection::registerService(const QString &serviceName)

尝试在 D-Bus 服务器上注册serviceName ，如果注册成功，则返回true 。如果该名称已被其他应用程序注册，则注册失败。

另请参阅 unregisterService() 和QDBusConnectionInterface::registerService()。

bool QDBusConnection::send(const QDBusMessage &message) const

通过该连接发送message ，无需等待回复。这适用于错误、信号、返回值以及不需要返回值的调用。

如果信息排队成功，则返回true ，否则返回 false。

[static] QDBusConnection QDBusConnection::sessionBus()

返回通过会话总线打开的QDBusConnection 对象。此函数返回的对象引用在应用程序终止前一直有效，应用程序终止后连接将被关闭，对象也将被删除。

[noexcept] void QDBusConnection::swap(QDBusConnection &other)

将此连接与other 互换。该操作速度非常快，从未出现过故障。

[static] QDBusConnection QDBusConnection::systemBus()

返回通过系统总线打开的QDBusConnection 对象。该函数返回的对象引用在QCoreApplication 的析构函数运行前一直有效，届时连接将被关闭，对象也将被删除。

void QDBusConnection::unregisterObject(const QString &path, QDBusConnection::UnregisterMode mode = UnregisterNode)

在path 给定的对象路径上取消注册registerObject() 注册的对象，如果mode 是QDBusConnection::UnregisterTree ，则也取消注册其所有子对象。

请注意，不能解除注册未通过registerObject() 注册的对象。

bool QDBusConnection::unregisterService(const QString &serviceName)

取消注册之前通过registerService() 注册的服务serviceName ，如果成功则返回true 。

另请参阅 registerService() 和QDBusConnectionInterface::unregisterService()。

QDBusConnection &QDBusConnection::operator=(const QDBusConnection &other)

创建该对象中连接other 的副本。请注意，该对象在复制之前引用的连接不会自动断开。

另请参阅 disconnectFromBus()。