QDBusConnection Class

Dokumentation der Mitgliedsfunktionen

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

Erstellt ein QDBusConnection-Objekt, das mit der Verbindung namens „ name “ verknüpft ist.

Dadurch wird die Verbindung nicht geöffnet. Sie müssen connectToBus() aufrufen, um sie zu öffnen.

QDBusConnection::QDBusConnection(const QDBusConnection &other)

Erstellt eine Kopie der Verbindung „ other “.

[noexcept] QDBusConnection::~QDBusConnection()

Entsorgt dieses Objekt. Die Verbindung wird dabei nicht geschlossen: Dazu müssen Sie die Funktion „ disconnectFromBus()“ aufrufen.

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

Sendet die „ message “ über diese Verbindung und kehrt sofort zurück. Diese Funktion eignet sich ausschließlich für Methodenaufrufe. Sie gibt ein Objekt vom Typ „ QDBusPendingCall “ zurück, mit dem sich der Status der Antwort verfolgen lässt.

Wird innerhalb von timeout Millisekunden keine Antwort empfangen, wird automatisch ein Fehler ausgelöst, der das Ablaufen des Aufrufs anzeigt. Der Standardwert für ` timeout ` ist -1; dieser wird durch einen implementierungsabhängigen Wert ersetzt, der für die Kommunikation zwischen Prozessen geeignet ist (in der Regel 25 Sekunden). Diese Zeitüberschreitung ist auch die Obergrenze für die Wartezeit in `QDBusPendingCall::waitForFinished()`.

Siehe die Funktion „ QDBusInterface::asyncCall()“ für eine benutzerfreundlichere Art, Aufrufe zu platzieren.

QString QDBusConnection::baseService() const

Gibt den eindeutigen Verbindungsnamen für diese Verbindung zurück, sofern dieses „ QDBusConnection “-Objekt verbunden ist; andernfalls wird ein leeres „ QString “ zurückgegeben.

Ein eindeutiger Verbindungsname ist eine Zeichenkette im Format „:x.xxx“ (wobei x für Dezimalziffern steht), die vom D-Bus-Server-Daemon bei der Herstellung der Verbindung zugewiesen wird. Er identifiziert diesen Client eindeutig im Bus.

Diese Funktion gibt bei Peer-to-Peer-Verbindungen ein leeres ` QString ` zurück.

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

Sendet die „ message “ über diese Verbindung und wartet maximal timeout Millisekunden lang auf eine Antwort. Diese Funktion eignet sich ausschließlich für Methodenaufrufe. Sie gibt die Antwortnachricht als Rückgabewert zurück, die entweder vom Typ „ QDBusMessage::ReplyMessage “ oder „ QDBusMessage::ErrorMessage “ ist.

Wird innerhalb von timeout Millisekunden keine Antwort empfangen, wird automatisch ein Fehler ausgegeben, der das Ablaufen des Aufrufs signalisiert. Der Standardwert für timeout ist -1; dieser wird durch einen implementierungsabhängigen Wert ersetzt, der für die Kommunikation zwischen Prozessen geeignet ist (in der Regel 25 Sekunden).

Siehe die Funktion QDBusInterface::call() für eine benutzerfreundlichere Art, Aufrufe zu platzieren.

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

Sendet die „ message “ über diese Verbindung und kehrt sofort zurück. Sobald die Antwort empfangen wurde, wird die Methode „ returnMethod “ im Objekt „ receiver “ aufgerufen. Tritt ein Fehler auf, wird stattdessen die Methode „ errorMethod “ aufgerufen.

Wird innerhalb von timeout Millisekunden keine Antwort empfangen, wird automatisch ein Fehler ausgelöst, der das Ablaufen des Aufrufs anzeigt. Der Standardwert für timeout ist -1; dieser wird durch einen implementierungsabhängigen Wert ersetzt, der für die Kommunikation zwischen Prozessen geeignet ist (in der Regel 25 Sekunden).

Diese Funktion eignet sich ausschließlich für Methodenaufrufe. Es wird garantiert, dass der Slot genau einmal mit der Antwort aufgerufen wird, sofern die Parametertypen übereinstimmen und kein Fehler auftritt.

Gibt „ true “ zurück, wenn die Nachricht gesendet wurde, oder „false“, wenn die Nachricht nicht gesendet werden konnte.

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

Verbindet das durch die Parameter „ service “, „ path “, „ interface “ und „ name “ angegebene Signal mit dem Slot „ slot “ im Objekt „ receiver “. Die Argumente „ service “ und „ path “ können leer sein, was eine Verbindung zu einem beliebigen Signal des Paares „(interface, name)“ von einer beliebigen Remote-Anwendung aus bedeutet.

Gibt „ true “ zurück, wenn die Verbindung erfolgreich hergestellt wurde.

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

Verbindet das Signal mit dem Slot „ slot “ im Objekt „ receiver “. Im Gegensatz zur vorherigen Überladung von `connect()` ermöglicht diese Funktion die Angabe der zu verbindenden Parametersignatur mithilfe der Variablen ` signature `. Die Funktion überprüft anschließend, ob diese Signatur an den durch ` slot ` angegebenen Slot übergeben werden kann, und gibt andernfalls `false` zurück.

Gibt „ true “ zurück, wenn die Verbindung erfolgreich hergestellt wurde.

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)

Verbindet das Signal mit dem Slot „ slot “ im Objekt „ receiver “. Im Gegensatz zur vorherigen Überladung von „connect()“ ermöglicht diese Funktion die Angabe der zu verbindenden Parametersignatur mithilfe der Variablen „ signature “. Die Funktion überprüft dann, ob diese Signatur an den durch „ slot “ angegebenen Slot übergeben werden kann, und gibt andernfalls „false“ zurück.

Der Parameter ` argumentMatch ` listet die abzugleichenden Zeichenfolgenparameter in sequenzieller Reihenfolge auf. Beachten Sie, dass Sie zum Abgleichen einer leeren Zeichenfolge ein ` QString ` übergeben müssen, das leer, aber nicht null ist (d. h. ` QString("")`). Ein nullwertiges ` QString ` überspringt den Abgleich an dieser Position.

Gibt „ true “ zurück, wenn die Verbindung erfolgreich hergestellt wurde.

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

Öffnet eine Verbindung vom Typ „ type “ zu einem der bekannten Busse und ordnet ihr den Verbindungsnamen „ name “ zu. Gibt ein „ QDBusConnection “-Objekt zurück, das dieser Verbindung zugeordnet ist.

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

Öffnet eine Verbindung zu einem privaten Bus unter der Adresse address und ordnet ihr den Verbindungsnamen name zu. Gibt ein „ QDBusConnection “-Objekt zurück, das dieser Verbindung zugeordnet ist.

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

Öffnet eine Peer-to-Peer-Verbindung unter der Adresse address und ordnet ihr den Verbindungsnamen name zu. Gibt ein QDBusConnection -Objekt zurück, das dieser Verbindung zugeordnet ist.

QDBusConnection::ConnectionCapabilities QDBusConnection::connectionCapabilities() const

Gibt die Funktionen dieser Verbindung zurück, wie sie mit dem Bus-Server oder dem Peer ausgehandelt wurden. Ist dieser „ QDBusConnection “ nicht verbunden, gibt diese Funktion keine Funktionen zurück.

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

Trennt das durch die Parameter ` service`, ` path`, ` interface ` und ` name ` angegebene Signal vom Slot ` slot ` im Objekt ` receiver`. Die Argumente müssen mit denen übereinstimmen, die an die Funktion ` connect()` übergeben werden.

Gibt „ true “ zurück, wenn die Trennung erfolgreich war.

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

Trennt das durch die Parameter „ service “, „ path “, „ interface “, „ name “ und „ signature “ angegebene Signal vom Slot „ slot “ im Objekt „ receiver “. Die Argumente müssen mit denen übereinstimmen, die an die Funktion „ connect()“ übergeben wurden.

Gibt „ true “ zurück, wenn die Trennung erfolgreich war.

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)

Trennt das durch die Parameter „ service “, „ path “, „ interface “, „ name “, „ argumentMatch “ und „ signature “ angegebene Signal vom Slot „ slot “ im Objekt „ receiver “. Die Argumente müssen mit denen übereinstimmen, die an die Funktion „ connect()“ übergeben wurden.

Gibt „ true “ zurück, wenn die Trennung erfolgreich war.

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

Schließt die Busverbindung mit dem Namen „ name “.

Beachten Sie, dass die Verbindung erst geschlossen wird, wenn alle Verweise auf Objekte des Typs „ QDBusConnection “, die noch mit derselben Verbindung verknüpft sind, aufgehoben wurden. Es können jedoch keine weiteren Verweise mithilfe des Konstruktors „ QDBusConnection “ erstellt werden.

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

Schließt die Peer-Verbindung mit dem Namen „ name “.

Beachten Sie, dass die Verbindung erst geschlossen wird, wenn alle Verweise auf die Verbindung aufgehoben wurden, sofern noch QDBusConnection -Objekte mit derselben Verbindung verknüpft sind. Es können jedoch keine weiteren Verweise mithilfe des Konstruktors „ QDBusConnection “ erstellt werden.

QDBusConnectionInterface *QDBusConnection::interface() const

Gibt ein ` QDBusConnectionInterface `-Objekt zurück, das die D-Bus-Server-Schnittstelle für diese Verbindung darstellt.

bool QDBusConnection::isConnected() const

Gibt „ true “ zurück, wenn dieses „ QDBusConnection “-Objekt verbunden ist.

QDBusError QDBusConnection::lastError() const

Gibt den letzten Fehler zurück, der bei dieser Verbindung aufgetreten ist.

Diese Funktion ist für Low-Level-Code vorgesehen. Wenn Sie ` QDBusInterface::call()` verwenden, werden Fehlercodes über den Rückgabewert gemeldet.

Siehe auch ` QDBusInterface ` und ` QDBusMessage`.

[static] QByteArray QDBusConnection::localMachineId()

Gibt die lokale Maschinen-ID zurück, wie sie dem D-Bus-System bekannt ist. Jeder Knoten oder Host, auf dem D-Bus ausgeführt wird, verfügt über eine eindeutige Kennung, mit der er von anderen Hosts unterschieden werden kann, wenn diese Ressourcen wie das Dateisystem gemeinsam nutzen.

Beachten Sie, dass die lokale Maschinen-ID nicht garantiert über mehrere Systemstarts hinweg bestehen bleibt; daher sollte diese Kennung nicht in einem persistenten Speicher (wie dem Dateisystem) abgelegt werden. Es ist nur während der Laufzeit dieser Boot-Sitzung gewährleistet, dass sie konstant bleibt.

QString QDBusConnection::name() const

Gibt den Verbindungsnamen für diese Verbindung zurück, wie er als Parameter „name“ an die Funktion „ connectToBus()“ übergeben wurde.

Der Verbindungsname kann verwendet werden, um die tatsächlich zugrunde liegenden Verbindungen zu Bussen eindeutig zu identifizieren. Kopien, die von einer einzelnen Verbindung erstellt werden, teilen sich immer implizit die zugrunde liegende Verbindung und haben daher denselben Verbindungsnamen.

Umgekehrt sind zwei Verbindungen mit unterschiedlichen Verbindungsnamen immer entweder mit unterschiedlichen Bussen verbunden oder haben auf diesem Bus einen unterschiedlichen eindeutigen Namen (wie von baseService() zurückgegeben).

Siehe auch connectToBus() und disconnectFromBus().

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

Gibt das Objekt zurück, das mit der Funktion ` registerObject()` unter dem durch ` path` angegebenen Objektpfad registriert wurde.

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

Registriert das Objekt object unter dem Pfad path und gibt true zurück, wenn die Registrierung erfolgreich war. Der Parameter options legt fest, in welchem Umfang das Objekt object über D-Bus verfügbar gemacht wird.

Diese Funktion ersetzt keine bereits vorhandenen Objekte: Wenn unter dem Pfad path bereits ein Objekt registriert ist, gibt diese Funktion „false“ zurück. Verwenden Sie zunächst unregisterObject(), um die Registrierung aufzuheben.

Das Flag „ ExportChildObjects “ exportiert untergeordnete Objekte über D-Bus basierend auf dem Pfad der registrierten Objekte und dem „ QObject::objectName “ des untergeordneten Objekts. Daher ist es wichtig, dass das untergeordnete Objekt über einen Objektnamen verfügt.

Sie können kein Objekt als untergeordnetes Objekt eines Objekts registrieren, das mit „ ExportChildObjects “ registriert wurde.

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

Registriert das Objekt object unter dem Pfad path mit dem Schnittstellennamen interface und gibt true zurück, wenn die Registrierung erfolgreich war. Der Parameter options legt fest, in welchem Umfang das Objekt object über D-Bus verfügbar gemacht wird.

Diese Funktion ersetzt keine bereits vorhandenen Objekte: Wenn unter dem Pfad path bereits ein Objekt registriert ist, gibt diese Funktion „false“ zurück. Verwenden Sie unregisterObject(), um die Registrierung zunächst aufzuheben.

Das Flag „ ExportChildObjects “ exportiert untergeordnete Objekte über D-Bus basierend auf dem Pfad der registrierten Objekte und dem „ QObject::objectName “ des untergeordneten Objekts. Daher ist es wichtig, dass das untergeordnete Objekt über einen Objektnamen verfügt.

Sie können ein Objekt nicht als untergeordnetes Objekt eines Objekts registrieren, das mit „ ExportChildObjects “ registriert wurde.

bool QDBusConnection::registerService(const QString &serviceName)

Versucht, den „ serviceName “ auf dem D-Bus-Server zu registrieren, und gibt „ true “ zurück, wenn die Registrierung erfolgreich war. Die Registrierung schlägt fehl, wenn der Name bereits von einer anderen Anwendung registriert ist.

Siehe auch „ unregisterService()“ und „ QDBusConnectionInterface::registerService()“.

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

Sendet die ` message ` über diese Verbindung, ohne auf eine Antwort zu warten. Dies eignet sich für Fehler, Signale und Rückgabewerte sowie für Aufrufe, deren Rückgabewerte nicht benötigt werden.

Gibt ` true ` zurück, wenn die Nachricht erfolgreich in die Warteschlange gestellt wurde, andernfalls `false`.

[static] QDBusConnection QDBusConnection::sessionBus()

Gibt ein „ QDBusConnection “-Objekt zurück, das über den Session-Bus geöffnet wurde. Die von dieser Funktion zurückgegebene Objektreferenz ist bis zum Beenden der Anwendung gültig; zu diesem Zeitpunkt wird die Verbindung geschlossen und das Objekt gelöscht.

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

Ersetzt diese Verbindung durch other. Dieser Vorgang ist sehr schnell und schlägt niemals fehl.

[static] QDBusConnection QDBusConnection::systemBus()

Gibt ein „ QDBusConnection “-Objekt zurück, das über den Systembus geöffnet wurde. Die von dieser Funktion zurückgegebene Objektreferenz ist gültig, bis der Destruktor von „ QCoreApplication “ aufgerufen wird; dann wird die Verbindung geschlossen und das Objekt gelöscht.

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

Hebt die Registrierung eines Objekts auf, das mit der Funktion ` registerObject()` unter dem durch ` path ` angegebenen Objektpfad registriert wurde, und – sofern ` mode ` den Wert ` QDBusConnection::UnregisterTree` hat – auch die Registrierung aller seiner Unterobjekte.

Beachten Sie, dass Sie keine Objekte deregistrieren können, die nicht mit der Funktion „ registerObject()“ registriert wurden.

bool QDBusConnection::unregisterService(const QString &serviceName)

Hebt die Registrierung des Dienstes „ serviceName “ auf, der zuvor mit „ registerService “ () registriert wurde, und gibt bei Erfolg „ true “ zurück.

Siehe auch registerService() und QDBusConnectionInterface::unregisterService().

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

Erstellt eine Kopie der Verbindung other in diesem Objekt. Beachten Sie, dass die Verbindung, auf die dieses Objekt vor dem Kopieren verwiesen hat, nicht automatisch getrennt wird.

Siehe auch disconnectFromBus().