QDBusConnection Class

Dokumentation der Mitgliedsfunktionen

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

Erzeugt ein QDBusConnection-Objekt, das an die Verbindung mit dem Namen name angehängt wird.

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

QDBusConnection::QDBusConnection(const QDBusConnection &other)

Erzeugt eine Kopie der Verbindung other.

[noexcept] QDBusConnection::~QDBusConnection()

Beseitigt dieses Objekt. Damit wird die Verbindung nicht geschlossen: Dazu müssen Sie 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 ist nur für Methodenaufrufe geeignet. Sie gibt ein Objekt vom Typ QDBusPendingCall zurück, das zur Verfolgung des Status der Antwort verwendet werden kann.

Wenn innerhalb von timeout Millisekunden keine Antwort empfangen wird, wird automatisch ein Fehler ausgegeben, der den Ablauf des Aufrufs anzeigt. Der Standardwert timeout ist -1, der durch einen von der Implementierung festgelegten Wert ersetzt wird, der für die Kommunikation zwischen Prozessen geeignet ist (im Allgemeinen 25 Sekunden). Dieser Timeout ist auch die Obergrenze für das Warten in QDBusPendingCall::waitForFinished().

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

QString QDBusConnection::baseService() const

Gibt den eindeutigen Verbindungsnamen für diese Verbindung zurück, wenn dieses QDBusConnection Objekt verbunden ist, oder andernfalls einen leeren QString.

Ein eindeutiger Verbindungsname ist eine Zeichenkette in der Form ":x.xxx" (wobei x Dezimalziffern sind), die vom D-Bus-Server-Daemon bei der Verbindung zugewiesen wird. Er identifiziert diesen Client eindeutig im Bus.

Bei Peer-to-Peer-Verbindungen gibt diese Funktion 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 blockiert für maximal timeout Millisekunden, um auf eine Antwort zu warten. Diese Funktion ist nur für Methodenaufrufe geeignet. Sie gibt die Antwortnachricht als Rückgabewert zurück, die entweder vom Typ QDBusMessage::ReplyMessage oder QDBusMessage::ErrorMessage ist.

Wenn innerhalb von timeout Millisekunden keine Antwort empfangen wird, wird automatisch ein Fehler ausgegeben, der den Ablauf des Aufrufs anzeigt. Der Standardwert timeout ist -1, der durch einen implementierungsdefinierten Wert ersetzt wird, der für die Kommunikation zwischen Prozessen geeignet ist (im Allgemeinen 25 Sekunden).

Siehe die Funktion QDBusInterface::call() für eine freundlichere 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. Wenn die Antwort empfangen wird, wird die Methode returnMethod im Objekt receiver aufgerufen. Wenn ein Fehler auftritt, wird stattdessen die Methode errorMethod aufgerufen.

Wenn innerhalb von timeout Millisekunden keine Antwort empfangen wird, wird automatisch ein Fehler ausgegeben, der den Ablauf des Aufrufs anzeigt. Der Standardwert timeout ist -1, der durch einen implementierungsdefinierten Wert ersetzt wird, der für die Kommunikation zwischen Prozessen geeignet ist (im Allgemeinen 25 Sekunden).

Diese Funktion ist nur für Methodenaufrufe geeignet. Es ist garantiert, dass der Slot genau einmal mit der Antwort aufgerufen wird, solange 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 entfernten Anwendung bedeutet.

Gibt true zurück, wenn die Verbindung erfolgreich war.

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

Dies ist eine überladene Funktion.

Verbindet das Signal mit dem Slot slot im Objekt receiver. Im Gegensatz zur vorherigen connect()-Überladung kann man bei dieser Funktion die Parametersignatur, die verbunden werden soll, mit der Variablen signature angeben. Die Funktion prüft dann, ob diese Signatur an den durch slot angegebenen Slot geliefert werden kann und gibt andernfalls false zurück.

Gibt true zurück, wenn die Verbindung erfolgreich war.

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)

Dies ist eine überladene Funktion.

Verbindet das Signal mit dem Slot slot im Objekt receiver. Im Gegensatz zur vorherigen connect()-Überladung kann man bei dieser Funktion die Parametersignatur, die verbunden werden soll, mit der Variablen signature angeben. Die Funktion prüft dann, ob diese Signatur an den durch slot angegebenen Slot geliefert werden kann und gibt andernfalls false zurück.

Der Parameter argumentMatch listet die abzugleichenden String-Parameter in sequentieller Reihenfolge auf. Beachten Sie, dass Sie für den Abgleich einer leeren Zeichenkette eine QString übergeben müssen, die leer, aber nicht null ist (d. h. QString("")). Eine Null QString überspringt den Abgleich an dieser Position.

Gibt true zurück, wenn die Verbindung erfolgreich war.

[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 mit dieser Verbindung verbunden ist.

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

Öffnet eine Verbindung zu einem privaten Bus an der Adresse address und ordnet ihr den Verbindungsnamen name zu. Gibt ein QDBusConnection Objekt zurück, das mit dieser Verbindung verbunden ist.

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

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

QDBusConnection::ConnectionCapabilities QDBusConnection::connectionCapabilities() const

Gibt die Fähigkeiten dieser Verbindung zurück, wie sie mit dem Busserver oder der Gegenstelle ausgehandelt wurden. Wenn diese QDBusConnection nicht verbunden ist, gibt diese Funktion keine Fähigkeiten 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 Steckplatz slot im Objekt receiver. Die Argumente müssen dieselben sein, die an die Funktion connect() übergeben wurden.

Gibt true zurück, wenn die Trennung der Verbindung 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)

Dies ist eine überladene Funktion.

Trennt das durch die Parameter service, path, interface, name und signature angegebene Signal vom Steckplatz slot im Objekt receiver. Die Argumente müssen dieselben sein, die an die Funktion connect() übergeben wurden.

Gibt true zurück, wenn die Trennung der Verbindung 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)

Dies ist eine überladene Funktion.

Trennt das durch die Parameter service, path, interface, name, argumentMatch und signature angegebene Signal vom Steckplatz slot im Objekt receiver. Die Argumente müssen dieselben sein, die an die Funktion connect() übergeben wurden.

Gibt true zurück, wenn die Trennung der Verbindung erfolgreich war.

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

Schließt die Busverbindung mit dem Namen name.

Beachten Sie, dass, wenn es noch QDBusConnection Objekte gibt, die mit der gleichen Verbindung verbunden sind, die Verbindung nicht geschlossen wird, bis alle Referenzen gelöscht sind. Mit dem Konstruktor QDBusConnection können jedoch keine weiteren Referenzen erstellt werden.

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

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

Beachten Sie, dass die Verbindung erst dann geschlossen wird, wenn alle Verweise gelöscht wurden, falls noch QDBusConnection Objekte mit derselben Verbindung verbunden sind. Es können jedoch keine weiteren Verweise mit dem Konstruktor QDBusConnection erstellt werden.

QDBusConnectionInterface *QDBusConnection::interface() const

Gibt ein QDBusConnectionInterface Objekt zurück, das die D-Bus-Server-Schnittstelle auf dieser 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 die Fehlercodes durch ihren Rückgabewert gemeldet.

Siehe auch QDBusInterface und QDBusMessage.

[static] QByteArray QDBusConnection::localMachineId()

Gibt die dem D-Bus-System bekannte lokale Rechner-ID zurück. Jeder Knoten oder Host, auf dem D-Bus läuft, hat einen eindeutigen Bezeichner, der verwendet werden kann, um ihn von anderen Hosts zu unterscheiden, wenn sie Ressourcen wie das Dateisystem gemeinsam nutzen.

Beachten Sie, dass die lokale Rechner-ID nicht garantiert ist, dass sie über mehrere Systemstarts hinweg bestehen bleibt, so dass diese Kennung nicht in einem dauerhaften Speicher (wie dem Dateisystem) abgelegt werden sollte. Sie bleibt garantiert nur während der Lebensdauer dieser Boot-Sitzung konstant.

QString QDBusConnection::name() const

Gibt den Verbindungsnamen für diese Verbindung zurück, der als Parameter name an connectToBus() übergeben wurde.

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

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

Siehe auch connectToBus() und disconnectFromBus().

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

Gibt das Objekt zurück, das mit registerObject() unter dem in 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 gibt an, wie viel von dem Objekt object über den D-Bus offengelegt werden soll.

Diese Funktion ersetzt keine vorhandenen Objekte: Wenn bereits ein Objekt unter dem Pfad path registriert ist, gibt diese Funktion false zurück. Verwenden Sie unregisterObject(), um die Registrierung zu löschen.

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

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

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

Dies ist eine überladene Funktion.

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 gibt an, wie viel von dem Objekt object über den D-Bus offengelegt wird.

Diese Funktion ersetzt keine bestehenden Objekte: Wenn bereits ein Objekt unter dem Pfad path registriert ist, gibt diese Funktion false zurück. Verwenden Sie unregisterObject(), um die Registrierung zu löschen.

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

Sie können kein Objekt als Kindobjekt 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 wurde.

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 erforderlich sind.

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 mit dem Sitzungsbus geöffnet wurde. Der von dieser Funktion zurückgegebene Objektverweis ist gültig, bis die Anwendung beendet wird; dann wird die Verbindung geschlossen und das Objekt gelöscht.

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

Tauscht diese Verbindung mit other aus. Dieser Vorgang ist sehr schnell und schlägt nie fehl.

[static] QDBusConnection QDBusConnection::systemBus()

Gibt ein mit dem Systembus geöffnetes QDBusConnection Objekt zurück. Die von dieser Funktion zurückgegebene Objektreferenz ist gültig, bis der Destruktor von QCoreApplication ausgeführt 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 registerObject() unter dem durch path angegebenen Objektpfad registriert wurde, und, falls mode QDBusConnection::UnregisterTree ist, auch alle seine Unterobjekte.

Beachten Sie, dass Sie keine Objekte abmelden können, die nicht mit registerObject() registriert wurden.

bool QDBusConnection::unregisterService(const QString &serviceName)

Hebt die Registrierung des Dienstes serviceName auf, der zuvor mit registerService() registriert wurde, und gibt true zurück, wenn dies erfolgreich war.

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

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

Erzeugt eine Kopie der Verbindung other in diesem Objekt. Beachten Sie, dass die Verbindung, auf die dieses Objekt vor der Kopie verwiesen hat, nicht spontan unterbrochen wird.

Siehe auch disconnectFromBus().