QMqttClient Class

Fonction membre Documentation

[explicit] QMqttClient::QMqttClient(QObject *parent = nullptr)

Crée une nouvelle instance de client MQTT avec l'adresse parent.

[override virtual noexcept] QMqttClient::~QMqttClient()

Supprime un client MQTT. Si le client MQTT n'était pas déjà déconnecté du courtier MQTT, il le sera automatiquement.

void QMqttClient::authenticate(const QMqttAuthenticationProperties &prop)

Envoie une demande d'authentification au courtier. prop spécifie les informations requises pour répondre à la demande d'authentification.

Cette fonction ne doit être appelée qu'après l'émission d'un signal QMqttClient::authenticationRequested.

Voir aussi authenticationRequested() et authenticationFinished().

[signal] void QMqttClient::authenticationFinished(const QMqttAuthenticationProperties &p)

Ce signal est émis après la fin de l'authentification étendue. p précise les détails disponibles sur le processus d'authentification.

Après une authentification réussie, QMqttClient::connected est émis.

Voir également authenticationRequested() et authenticate().

[signal] void QMqttClient::authenticationRequested(const QMqttAuthenticationProperties &p)

Ce signal est émis après qu'un client a invoqué QMqttClient::connectToHost ou QMqttClient::connectToHostEncrypted et avant que la connexion ne soit établie. Dans le cadre de l'authentification étendue, un courtier peut demander des détails supplémentaires qui doivent être fournis en invoquant QMqttClient::authenticate. p spécifie les propriétés fournies par le courtier.

Voir aussi authenticationFinished() et authenticate().

[signal] void QMqttClient::brokerSessionRestored()

Ce signal est émis après qu'un client s'est connecté avec succès à un courtier avec la propriété cleanSession définie sur false, et que le courtier a restauré la session.

Les sessions peuvent être restaurées si un client s'est connecté précédemment en utilisant la même propriété clientId.

[invokable] void QMqttClient::connectToHost()

Établit une connexion avec le courtier MQTT.

void QMqttClient::connectToHostEncrypted(const QSslConfiguration &conf)

Initie une connexion cryptée au courtier MQTT.

conf spécifie la configuration SSL à utiliser pour la connexion

[invokable, since 6.10] void QMqttClient::connectToHostWebSocket(QWebSocket *webSocket = nullptr)

Définit un type de transport de socket web et initie une connexion au courtier MQTT. Le type de transport précédent est remplacé. Si webSocket est donné, le nom d'hôte et le port sont ignorés, et la connexion se fait avec ce websocket. webSocket appartient au code appelant, et doit être valide pendant toute la durée de vie de l'objet QMqttClient.

Cette fonction a été introduite dans Qt 6.10.

[invokable, since 6.10] void QMqttClient::connectToHostWebSocketEncrypted(QWebSocket *webSocket = nullptr)

Définit un type de transport websocket sécurisé et initie une connexion au courtier MQTT. Le type de transport précédent est remplacé. Si webSocket est donné, le nom d'hôte et le port sont ignorés, et la connexion se fait avec cette websocket. webSocket appartient au code appelant, et doit être valide pendant toute la durée de vie de l'objet QMqttClient.

Cette fonction a été introduite dans Qt 6.10.

[signal] void QMqttClient::connected()

Ce signal est émis lorsqu'une connexion a été établie.

QMqttConnectionProperties QMqttClient::connectionProperties() const

Renvoie les propriétés de connexion que le client demande au courtier.

Voir aussi setConnectionProperties().

[invokable] void QMqttClient::disconnectFromHost()

Se déconnecte du courtier MQTT.

[signal] void QMqttClient::disconnected()

Ce signal est émis lorsqu'une connexion a été fermée. Une connexion peut être fermée lorsque disconnectFromHost() est appelé ou lorsque le courtier se déconnecte.

QMqttLastWillProperties QMqttClient::lastWillProperties() const

Renvoie les propriétés du dernier testament.

Voir aussi setLastWillProperties().

[signal] void QMqttClient::messageReceived(const QByteArray &message, const QMqttTopicName &topic = QMqttTopicName())

Ce signal est émis lorsqu'un nouveau message a été reçu. La catégorie du message est spécifiée par topic et son contenu par message.

[signal] void QMqttClient::messageSent(qint32 id)

Indique qu'un message envoyé via la fonction publish() a été reçu par le courtier. L'adresse id est la même que celle renvoyée par publish() afin de faciliter le suivi de l'état du message.

[signal] void QMqttClient::messageStatusChanged(qint32 id, QMqtt::MessageStatus s, const QMqttMessageStatusProperties &properties)

Ce signal est émis lorsque l'état du message identifié par id change. s spécifie le nouvel état du message et properties spécifie les propriétés supplémentaires fournies par le serveur.

[signal] void QMqttClient::pingResponseReceived()

Ce signal est émis après que le courtier ait répondu à un appel requestPing() ou à un message ping keepAlive(), et que la connexion soit toujours valide.

[invokable] qint32 QMqttClient::publish(const QMqttTopicName &topic, const QByteArray &message = QByteArray(), quint8 qos = 0, bool retain = false)

Publie un message sur le courtier avec le topic spécifié. qos spécifie le niveau de qualité de service requis pour le transfert du message.

Si retain est défini sur true, le message restera sur le courtier pour que d'autres clients puissent se connecter et recevoir le message.

Renvoie un identifiant utilisé en interne pour identifier le message.

[invokable] qint32 QMqttClient::publish(const QMqttTopicName &topic, const QMqttPublishProperties &properties, const QByteArray &message = QByteArray(), quint8 qos = 0, bool retain = false)

Publie un message sur le courtier avec les adresses properties et topic spécifiées. qos spécifie le niveau de qualité de service requis pour le transfert du message.

Si retain est défini sur true, le message restera sur le broker pour que d'autres clients puissent se connecter et recevoir le message.

Renvoie un identifiant utilisé en interne pour identifier le message.

bool QMqttClient::requestPing()

Envoie un message ping au courtier et attend une réponse.

Si la connexion est active et que autoKeepAlive est true, l'appel à cette fonction échouera car le client est responsable de la gestion de ce processus.

L'utilisation manuelle de requestPing() nécessite un appel à chaque fois dans l'intervalle keepAlive tant que la connexion est active.

Pour vérifier si le ping est réussi, connectez-vous au signal pingResponseReceived().

Retourne true si la requête ping a pu être envoyée.

Voir aussi pingResponseReceived(), autoKeepAlive() et keepAlive().

QMqttServerConnectionProperties QMqttClient::serverConnectionProperties() const

Renvoie l'adresse QMqttServerConnectionProperties que le courtier a renvoyée après une tentative de connexion.

Ceci peut être utilisé pour vérifier que les propriétés de connexion côté client définies par QMqttClient::setConnectionProperties ont été acceptées par le courtier. De plus, en cas d'échec d'une tentative de connexion, il peut être utilisé pour le diagnostic de la connexion.

Voir aussi connectionProperties().

void QMqttClient::setConnectionProperties(const QMqttConnectionProperties &prop)

Définit les propriétés de connexion à prop. QMqttConnectionProperties peut être utilisé pour demander au serveur d'utiliser un ensemble de fonctionnalités spécifique. Après une demande de connexion, la réponse du serveur peut être obtenue en appelant QMqttClient::serverConnectionProperties.

Voir aussi connectionProperties().

void QMqttClient::setLastWillProperties(const QMqttLastWillProperties &prop)

Définit les propriétés de la dernière volonté à prop. QMqttLastWillProperties permet de définir des caractéristiques supplémentaires pour le message de dernière volonté stocké dans le courtier.

Voir aussi lastWillProperties().

void QMqttClient::setTransport(QIODevice *device, QMqttClient::TransportType transport)

Définit le transport à device. Un transport peut être un type de socket ou dérivé de QIODevice et est spécifié par transport.

Voir aussi transport().

QMqttSubscription *QMqttClient::subscribe(const QMqttTopicFilter &topic, quint8 qos = 0)

Ajoute un nouvel abonnement pour recevoir des notifications sur topic. Le paramètre qos spécifie le niveau auquel les messages de sécurité sont reçus. Pour plus d'informations sur les niveaux de qualité de service disponibles, voir Qualité de service.

Cette fonction renvoie un pointeur vers QMqttSubscription. Si le même sujet est souscrit deux fois, la valeur de retour pointe vers la même instance d'abonnement. Le client MQTT est le propriétaire de l'abonnement.

QMqttSubscription *QMqttClient::subscribe(const QMqttTopicFilter &topic, const QMqttSubscriptionProperties &properties, quint8 qos = 0)

Ajoute un nouvel abonnement pour recevoir des notifications sur topic. Le paramètre properties spécifie les propriétés supplémentaires de l'abonnement qui doivent être validées par le courtier. Le paramètre qos spécifie le niveau de réception des messages de sécurité. Pour plus d'informations sur les niveaux de qualité de service disponibles, voir Qualité de service.

Cette fonction renvoie un pointeur vers un QMqttSubscription. Si le même sujet est souscrit deux fois, la valeur de retour pointe vers la même instance d'abonnement. Le client MQTT est le propriétaire de l'abonnement.

QIODevice *QMqttClient::transport() const

Retourne le transport utilisé pour la communication avec le courtier.

Voir aussi setTransport().

void QMqttClient::unsubscribe(const QMqttTopicFilter &topic)

Se désabonne de topic. Aucune notification ne sera envoyée aux abonnements effectués en appelant subscribe().

void QMqttClient::unsubscribe(const QMqttTopicFilter &topic, const QMqttUnsubscriptionProperties &properties)

Se désabonne de topic. Aucune notification ne sera envoyée aux abonnements effectués en appelant subscribe(). properties spécifie les propriétés supplémentaires de l'utilisateur à transmettre au courtier.