QDBusConnection Class

Documentation des fonctions membres

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

Crée un objet `QDBusConnection` associé à la connexion nommée ` name`.

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

QDBusConnection::QDBusConnection(const QDBusConnection &other)

Crée une copie de la connexion « other ».

[noexcept] QDBusConnection::~QDBusConnection()

Supprime cet objet. Cela ne ferme pas la connexion : pour cela, vous devez appeler la méthode disconnectFromBus().

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

Envoie l'message via cette connexion et revient immédiatement. Cette fonction est réservée 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 un délai de timeout millisecondes, une erreur automatique sera générée pour signaler l’expiration de l’appel. La valeur par défaut de timeout est -1 ; elle sera remplacée par une valeur définie par l’implémentation, adaptée aux communications interprocessus (généralement 25 secondes). Ce délai d’expiration correspond également à la limite supérieure d’attente dans QDBusPendingCall::waitForFinished().

Consultez la fonction ` QDBusInterface::asyncCall()` pour une méthode plus conviviale d’exécution des appels.

QString QDBusConnection::baseService() const

Renvoie le nom de connexion unique correspondant à cette connexion, si l'objet ` QDBusConnection ` est connecté, ou une chaîne vide ` QString ` dans le cas contraire.

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

Cette fonction renvoie un objet QString vide pour les connexions pair à pair.

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

Envoie la requête message via cette connexion et reste en attente d'une réponse pendant timeout millisecondes au maximum. Cette fonction est réservée aux appels de méthode. Elle renvoie le message de réponse comme valeur de retour, qui sera de type QDBusMessage::ReplyMessage ou QDBusMessage::ErrorMessage.

Si aucune réponse n'est reçue dans un délai de timeout millisecondes, une erreur automatique sera générée, indiquant l'expiration de l'appel. La valeur par défaut de timeout est -1 ; elle sera remplacée par une valeur définie par l'implémentation et adaptée aux communications interprocessus (généralement 25 secondes).

Consultez la fonction QDBusInterface::call() pour une manière plus conviviale d'effectuer des appels.

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

Envoie l'message via cette connexion et revient immédiatement. Lorsque la réponse est reçue, la méthode returnMethod est appelée dans l'objet receiver. Si une erreur se produit, la méthode errorMethod sera appelée à la place.

Si aucune réponse n’est reçue dans un délai de timeout millisecondes, une erreur automatique sera générée, indiquant l’expiration de l’appel. La valeur par défaut de timeout est -1 ; elle sera remplacée par une valeur définie par l’implémentation et adaptée aux communications interprocessus (généralement 25 secondes).

Cette fonction est réservée aux appels de méthode. Il est garanti que le slot sera appelé exactement une fois avec la réponse, à condition que les types de paramètres correspondent et qu’aucune erreur ne se produise.

Renvoie ` 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)

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

Renvoie « true » si la connexion a abouti.

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

Relie le signal au slot slot de l'objet receiver. Contrairement à la surcharge précédente de la fonction connect(), cette fonction permet de spécifier la signature du paramètre à relier à l'aide de la variable signature. La fonction vérifie ensuite que cette signature peut être transmise au slot spécifié par slot et renvoie false dans le cas contraire.

Renvoie « true » si la connexion a abouti.

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)

Relie le signal au slot slot dans l’objet receiver. Contrairement à la surcharge précédente de la fonction connect(), cette fonction permet de spécifier la signature du paramètre à relier à l’aide de la variable signature. La fonction vérifie alors que cette signature peut être transmise au slot spécifié par slot et renvoie false dans le cas contraire.

Le paramètre argumentMatch répertorie, dans l’ordre séquentiel, les chaînes de caractères à faire correspondre. Notez que, pour faire correspondre une chaîne vide, vous devez passer un QString vide mais non nul (c’est-à-dire QString("")). Un QString nul ignore la correspondance à cette position.

Renvoie « true » si la connexion a abouti.

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

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

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

Ouvre une connexion vers un bus privé à l'adresse address et lui attribue le nom de connexion « name ». Renvoie un objet « QDBusConnection » associé à cette connexion.

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

Ouvre une connexion peer-to-peer à l'adresse address et lui attribue 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 le pair. Si cette « QDBusConnection » n’est pas connectée, 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 de l'emplacement slot de l'objet receiver. Les arguments doivent être identiques à ceux transmis à 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 QString &signature, QObject *receiver, const char *slot)

Déconnecte le signal spécifié par les paramètres service, path, interface, name et signature de l'emplacement slot de l'objet receiver. Les arguments doivent être identiques à ceux transmis à 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 de l'emplacement slot de l'objet receiver. Les arguments doivent être identiques à ceux transmis à la fonction connect().

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

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

Ferme la connexion au bus nommée « name ».

Notez que s'il reste des objets QDBusConnection associés à cette 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 nouvelle référence ne peut être créée à l'aide du constructeur QDBusConnection.

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

Ferme la connexion entre pairs portant le nom « name ».

Notez que s’il existe encore des objets QDBusConnection associés à cette 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 nouvelle 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 sur cette connexion.

Cette fonction est destinée au code de bas niveau. Si vous utilisez la fonction ` QDBusInterface::call()`, les codes d'erreur sont indiqués par sa valeur de retour.

Voir également QDBusInterface et QDBusMessage.

[static] QByteArray QDBusConnection::localMachineId()

Renvoie l'identifiant local de la machine tel qu'il est connu du système D-Bus. Chaque nœud ou hôte exécutant D-Bus dispose d'un identifiant unique permettant de le distinguer des autres hôtes lorsqu'ils partagent des ressources telles que le système de fichiers.

Notez que la persistance de l'identifiant de la machine locale n'est pas garantie d'un redémarrage à l'autre ; cet identifiant ne doit donc pas être stocké dans un support de stockage persistant (comme le système de fichiers). Sa constance n'est garantie que pendant la durée de cette session de démarrage.

QString QDBusConnection::name() const

Renvoie le nom de cette connexion, tel qu'il a été fourni en tant que paramètre « name » à la fonction connectToBus().

Le nom de connexion permet d’identifier de manière unique les connexions sous-jacentes réelles aux bus. Les copies créées à partir d’une même connexion partageront toujours implicitement la connexion sous-jacente et porteront donc le même nom de connexion.

À l'inverse, deux connexions ayant des noms différents seront toujours soit connectées à des bus différents, soit dotées d’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

Renvoie l'objet qui a été enregistré à l'aide de la fonction ` registerObject()` à l'emplacement indiqué par ` path`.

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

Enregistre l'objet object sous le chemin path et renvoie true si l'enregistrement a réussi. Le paramètre options spécifie la partie 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é à l’emplacement path, cette fonction renverra false. Utilisez unregisterObject() pour le désenregistrer au préalable.

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

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

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

Enregistre l'objet object sous le chemin path avec le nom d'interface interface et renvoie true si l'enregistrement a réussi. Le paramètre options spécifie la partie 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 unregisterObject() pour le désenregistrer au préalable.

L'indicateur ` ExportChildObjects ` exporte les objets enfants sur D-Bus en fonction du chemin d'accès des objets enregistrés et de la propriété ` QObject::objectName ` de l'enfant. Il est donc important que l'objet enfant dispose d'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 l’ serviceName sur le serveur D-Bus et renvoie true si l’enregistrement a réussi. L’enregistrement échouera si le nom est déjà enregistré par une autre application.

Voir également unregisterService() et QDBusConnectionInterface::registerService().

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

Envoie l’ message via cette connexion, sans attendre de réponse. Cette méthode convient aux erreurs, aux signaux et aux valeurs de retour, ainsi qu’aux appels dont les valeurs de retour ne sont pas nécessaires.

Renvoie ` 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 via le bus de session. La référence à l'objet renvoyée par cette fonction reste valide jusqu'à la fermeture de l'application ; à ce moment-là, 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 ne pose jamais de problème.

[static] QDBusConnection QDBusConnection::systemBus()

Renvoie un objet ` QDBusConnection ` ouvert via le bus système. La référence à l’objet renvoyée par cette fonction reste valide jusqu’à l’exécution du destructeur de ` QCoreApplication` ; à ce moment-là, la connexion sera fermée et l’objet supprimé.

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

Désenregistre un objet qui avait été enregistré via la fonction ` registerObject()` à l’emplacement indiqué par ` path ` et, si ` mode ` est défini sur ` QDBusConnection::UnregisterTree`, tous ses sous-objets également.

Notez qu’il n’est pas possible de désenregistrer des objets qui n’ont pas été enregistrés via la fonction registerObject().

bool QDBusConnection::unregisterService(const QString &serviceName)

Désenregistre le service serviceName qui avait été préalablement enregistré via registerService() et renvoie true en cas de réussite.

Voir également 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 à laquelle cet objet faisait référence avant la copie n'est pas automatiquement déconnectée.

Voir également disconnectFromBus().