QDBusConnection Class

Documentation des fonctions membres

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

Crée un objet QDBusConnection attaché à la connexion portant le nom name.

Cela n'ouvre pas la connexion. Vous devez appeler connectToBus() pour l'ouvrir.

QDBusConnection::QDBusConnection(const QDBusConnection &other)

Crée une copie de la connexion other.

[noexcept] QDBusConnection::~QDBusConnection()

Se débarrasse de cet objet. Cela ne ferme pas la connexion : vous devez appeler disconnectFromBus() pour le faire.

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

Envoie l'adresse message via cette connexion et revient immédiatement. Cette fonction ne convient qu'aux appels de méthode. Elle renvoie un objet de type QDBusPendingCall qui peut être utilisé pour suivre l'état de la réponse.

Si aucune réponse n'est reçue dans les timeout millisecondes, une erreur automatique sera émise, indiquant l'expiration de l'appel. La valeur par défaut de timeout est -1, qui sera remplacée par une valeur définie par l'implémentation et adaptée aux communications inter-processus (en général, 25 secondes). Ce délai est également la limite supérieure de l'attente dans QDBusPendingCall::waitForFinished().

Voir la fonction QDBusInterface::asyncCall() pour une manière plus conviviale de passer des appels.

QString QDBusConnection::baseService() const

Renvoie le nom de connexion unique pour cette connexion, si cet objet QDBusConnection est connecté, ou un QString vide dans le cas contraire.

Un nom de connexion unique est une chaîne de caractères de la forme ":x.xxx" (où x sont des chiffres décimaux) qui est attribuée par le démon du serveur D-Bus lors de la connexion. Il identifie de manière unique ce client dans le bus.

Cette fonction renvoie une adresse QString vide pour les connexions d'égal à égal.

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

Envoie le message message sur cette connexion et bloque l'attente d'une réponse pendant au maximum timeout millisecondes. Cette fonction ne convient qu'aux appels de méthode. Elle renvoie le message de réponse comme valeur de retour, qui sera du type QDBusMessage::ReplyMessage ou QDBusMessage::ErrorMessage.

Si aucune réponse n'est reçue dans les timeout millisecondes, une erreur automatique sera émise, indiquant l'expiration de l'appel. La valeur par défaut de timeout est -1, qui sera remplacée par une valeur définie par l'implémentation et adaptée aux communications inter-processus (en général, 25 secondes).

Voir la fonction QDBusInterface::call() pour une manière plus conviviale de passer des appels.

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

Envoie le message message sur cette connexion et revient immédiatement. Lorsque la réponse est reçue, la méthode returnMethod est appelée dans l'objet receiver. En cas d'erreur, la méthode errorMethod sera appelée à la place.

Si aucune réponse n'est reçue dans les timeout millisecondes, une erreur automatique sera émise indiquant l'expiration de l'appel. La valeur par défaut de timeout est -1, qui sera remplacée par une valeur définie par l'implémentation et adaptée aux communications inter-processus (en général, 25 secondes).

Cette fonction ne convient qu'aux appels de méthodes. Il est garanti que le slot sera appelé exactement une fois avec la réponse, tant que les types de paramètres correspondent et qu'aucune erreur ne se produit.

Retourne true si le message a été envoyé, ou false si le message n'a pas pu être envoyé.

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

Connecte le signal spécifié par les paramètres service, path, interface et name au slot slot dans l'objet receiver. Les arguments service et path peuvent être vides, ce qui indique une connexion à n'importe quel signal de la paire (interface, name), à partir de n'importe quelle application distante.

Retourne true si la connexion est réussie.

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

Connecte le signal au slot slot dans l'objet receiver. Contrairement à la surcharge connect() précédente, cette fonction permet de spécifier la signature du paramètre à connecter à l'aide de la variable signature. La fonction vérifie alors que cette signature peut être délivrée à l'emplacement spécifié par slot et renvoie faux dans le cas contraire.

Renvoie true si la connexion est réussie.

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)

Connecte le signal au slot slot dans l'objet receiver. Contrairement à la surcharge connect() précédente, cette fonction permet de spécifier la signature du paramètre à connecter à l'aide de la variable signature. La fonction vérifie alors que cette signature peut être délivrée à l'emplacement spécifié par slot et renvoie un message faux dans le cas contraire.

Le paramètre argumentMatch dresse la liste des paramètres de type chaîne de caractères à faire correspondre, dans l'ordre séquentiel. Notez que, pour faire correspondre une chaîne vide, vous devez passer un QString qui est vide mais non nul (c'est-à-dire QString("")). Un QString nul ne permet pas d'établir une correspondance à cette position.

Renvoie true si la connexion a réussi.

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

Ouvre une connexion de type type à l'un des bus connus et lui associe le nom de connexion name. Renvoie un objet QDBusConnection associé à cette connexion.

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

Ouvre une connexion à un bus privé à l'adresse address et lui associe le nom de connexion name. Retourne un objet QDBusConnection associé à cette connexion.

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

Ouvre une connexion d'égal à égal sur l'adresse address et lui associe le nom de connexion name. Renvoie un objet QDBusConnection associé à cette connexion.

QDBusConnection::ConnectionCapabilities QDBusConnection::connectionCapabilities() const

Renvoie les capacités de cette connexion telles qu'elles ont été négociées avec le serveur de bus ou l'homologue. Si le site QDBusConnection n'est pas connecté, cette fonction ne renvoie aucune capacité.

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

Déconnecte le signal spécifié par les paramètres service, path, interface et name du slot slot dans l'objet receiver. Les arguments doivent être les mêmes que ceux passés à la fonction connect().

Retourne true si la déconnexion a réussi.

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

Déconnecte le signal spécifié par les paramètres service, path, interface, name, et signature du slot slot dans l'objet receiver. Les arguments doivent être les mêmes que ceux passés à la fonction connect().

Renvoie true si la déconnexion a réussi.

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)

Déconnecte le signal spécifié par les paramètres service, path, interface, name, argumentMatch, et signature du slot slot dans l'objet receiver. Les arguments doivent être les mêmes que ceux passés à la fonction connect().

Retourne true si la déconnexion a réussi.

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

Ferme la connexion de bus du nom name.

Notez que si des objets QDBusConnection sont encore associés à la même connexion, la connexion ne sera pas fermée tant que toutes les références n'auront pas été supprimées. Cependant, aucune autre référence ne peut être créée à l'aide du constructeur QDBusConnection.

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

Ferme la connexion homologue du nom name.

Notez que si des objets QDBusConnection sont encore associés à la même connexion, celle-ci ne sera pas fermée tant que toutes les références n'auront pas été supprimées. Cependant, aucune autre référence ne peut être créée à l'aide du constructeur QDBusConnection.

QDBusConnectionInterface *QDBusConnection::interface() const

Renvoie un objet QDBusConnectionInterface qui représente l'interface du serveur D-Bus sur cette connexion.

bool QDBusConnection::isConnected() const

Renvoie true si cet objet QDBusConnection est connecté.

QDBusError QDBusConnection::lastError() const

Renvoie la dernière erreur survenue dans cette connexion.

Cette fonction est fournie pour le code de bas niveau. Si vous utilisez QDBusInterface::call(), les codes d'erreur sont signalés par sa valeur de retour.

Voir aussi QDBusInterface et QDBusMessage.

[static] QByteArray QDBusConnection::localMachineId()

Renvoie l'identifiant de la machine locale tel qu'il est connu par le système D-Bus. Chaque nœud ou hôte qui exécute D-Bus a un identifiant unique qui peut être utilisé pour le distinguer des autres hôtes s'ils partagent des ressources comme le système de fichiers.

Notez que la persistance de l'identifiant de la machine locale n'est pas garantie d'un démarrage à l'autre du système, de sorte que cet identifiant ne doit pas être stocké dans une mémoire persistante (comme le système de fichiers). Il est garanti qu'il reste constant uniquement pendant la durée de vie de cette session de démarrage.

QString QDBusConnection::name() const

Renvoie le nom de la connexion pour cette connexion, tel qu'indiqué dans le paramètre name de connectToBus().

Le nom de la connexion peut être utilisé pour identifier de manière unique les connexions sous-jacentes aux bus. Les copies réalisées à partir d'une seule connexion partageront toujours implicitement la connexion sous-jacente, et auront donc le même nom de connexion.

Inversement, deux connexions ayant des noms de connexion différents seront toujours connectées à des bus différents ou auront un nom unique différent (tel que renvoyé par baseService()) sur ce bus.

Voir également connectToBus() et disconnectFromBus().

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

Retourne l'objet qui a été enregistré avec registerObject() au chemin d'accès de l'objet donné par path.

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

Enregistre l'objet object au chemin path et renvoie true si l'enregistrement a réussi. Le paramètre options indique la part de l'objet object qui sera exposée via D-Bus.

Cette fonction ne remplace pas les objets existants : si un objet est déjà enregistré sur le chemin path, cette fonction renverra false. Utilisez d'abord unregisterObject() pour le désenregistrer.

L'indicateur ExportChildObjects exporte des objets enfants sur D-Bus en fonction du chemin des objets enregistrés et de QObject::objectName de l'enfant. Il est donc important que l'objet enfant ait un nom d'objet.

Vous ne pouvez pas enregistrer un objet en tant qu'objet enfant d'un objet qui a été enregistré avec ExportChildObjects.

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

Enregistre l'objet object au chemin path avec le nom d'interface interface et renvoie true si l'enregistrement a réussi. Le paramètre options indique la part de l'objet object qui sera exposée via D-Bus.

Cette fonction ne remplace pas les objets existants : s'il existe déjà un objet enregistré au chemin path, cette fonction renverra false. Utilisez d'abord unregisterObject() pour le désenregistrer.

L'indicateur ExportChildObjects exporte des objets enfants sur D-Bus en fonction du chemin des objets enregistrés et de QObject::objectName de l'enfant. Il est donc important que l'objet enfant ait un nom d'objet.

Vous ne pouvez pas enregistrer un objet en tant qu'objet enfant d'un objet qui a été enregistré avec ExportChildObjects.

bool QDBusConnection::registerService(const QString &serviceName)

Tente d'enregistrer le site serviceName sur le serveur D-Bus et renvoie true si l'enregistrement a réussi. L'enregistrement échoue si le nom est déjà enregistré par une autre application.

Voir aussi unregisterService() et QDBusConnectionInterface::registerService().

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

Envoie l'adresse message sur cette connexion, sans attendre de réponse. Cela convient pour les erreurs, les signaux et les valeurs de retour, ainsi que pour les appels dont les valeurs de retour ne sont pas nécessaires.

Retourne true si le message a été mis en file d'attente avec succès, false dans le cas contraire.

[static] QDBusConnection QDBusConnection::sessionBus()

Renvoie un objet QDBusConnection ouvert avec le bus de session. La référence de l'objet renvoyé par cette fonction est valable jusqu'à la fin de l'application, date à laquelle la connexion sera fermée et l'objet supprimé.

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

Remplace cette connexion par other. Cette opération est très rapide et n'échoue jamais.

[static] QDBusConnection QDBusConnection::systemBus()

Renvoie un objet QDBusConnection ouvert avec le bus système. La référence de l'objet renvoyé par cette fonction est valide jusqu'à l'exécution du destructeur de QCoreApplication, lorsque la connexion sera fermée et l'objet supprimé.

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

Désenregistre un objet qui a été enregistré avec registerObject() au chemin d'accès de l'objet donné par path et, si mode est QDBusConnection::UnregisterTree, tous ses sous-objets également.

Notez que vous ne pouvez pas désenregistrer des objets qui n'ont pas été enregistrés avec registerObject().

bool QDBusConnection::unregisterService(const QString &serviceName)

Désenregistre le service serviceName précédemment enregistré avec registerService() et renvoie true en cas de succès.

Voir aussi registerService() et QDBusConnectionInterface::unregisterService().

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

Crée une copie de la connexion other dans cet objet. Notez que la connexion référencée par cet objet avant la copie n'est pas spontanément déconnectée.

Voir aussi disconnectFromBus().