QMqttClient Class

Documentation des fonctions membres

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

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

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

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

void QMqttClient::authenticate(const QMqttAuthenticationProperties &prop)

Envoie une requête d'authentification au courtier. La variable ` prop ` spécifie les informations requises pour répondre à cette requête d'authentification.

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

Voir également authenticationRequested() et authenticationFinished().

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

Ce signal est émis une fois l'authentification étendue terminée. La méthode ` p ` fournit des informations détaillées sur le processus d'authentification.

Une fois l’authentification réussie, le signal « 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 appelé ` QMqttClient::connectToHost ` ou ` QMqttClient::connectToHostEncrypted `, et avant l’établissement de la connexion. Dans le cadre de l’authentification étendue, un courtier peut demander des informations supplémentaires qui doivent être fournies en appelant ` QMqttClient::authenticate`. ` p ` spécifie les propriétés fournies par le courtier.

Voir également authenticationFinished() et authenticate().

[signal] void QMqttClient::brokerSessionRestored()

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

Les sessions peuvent être rétablies si un client s'est déjà connecté en utilisant le même clientId.

[invokable] void QMqttClient::connectToHost()

Établit une connexion avec le serveur MQTT.

void QMqttClient::connectToHostEncrypted(const QSslConfiguration &conf)

Établit une connexion chiffrée avec le 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 WebSocket et établit une connexion avec le courtier MQTT. Le type de transport précédent est remplacé. Si webSocket est fourni, le nom d’hôte et le port sont ignorés, et la connexion s’effectue via ce WebSocket. webSocket appartient au code appelant et doit rester 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 établit une connexion avec le broker MQTT. Le type de transport précédent est remplacé. Si l'adresse webSocket est fournie, le nom d'hôte et le port sont ignorés, et la connexion s'effectue via ce WebSocket. L'objet `webSocket` appartient au code appelant et doit rester 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 au courtier les propriétés de connexion demandées par le client.

Voir également setConnectionProperties().

[invokable] void QMqttClient::disconnectFromHost()

Se déconnecte du broker MQTT.

[signal] void QMqttClient::disconnected()

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

QMqttLastWillProperties QMqttClient::lastWillProperties() const

Renvoie les propriétés de la dernière volonté.

Voir également 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 indiquée par topic, son contenu étant message.

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

Indique qu'un message envoyé via la fonction ` publish()` a été reçu par le courtier. L'id est identique à celui renvoyé par ` publish() `, ce qui facilite le suivi du statut du message.

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

Ce signal est émis lorsque le statut du message identifié par id change. s indique le nouveau statut du message, et properties précise les propriétés supplémentaires fournies par le serveur.

[signal] void QMqttClient::pingResponseReceived()

Ce signal est émis lorsque le courtier répond à un appel ` requestPing()` ou à un message de ping ` keepAlive()`, et que la connexion est toujours valide.

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

Publie un message de type « message » vers le broker avec l’ topic spécifiée. Le paramètre « qos » définit le niveau de qualité de service (QoS) requis pour le transfert du message.

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

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 « message » vers le courtier avec les paramètres properties et topic spécifiés. Le paramètre qos définit le niveau de qualité de service (QoS) requis pour le transfert du message.

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

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 la valeur de « autoKeepAlive » est « true », l'appel de cette fonction échouera, car c'est au client qu'il incombe de gérer ce processus.

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

Pour vérifier si le ping a abouti, abonnez-vous au signal ` pingResponseReceived()`.

Renvoie ` true ` si la requête de ping a pu être envoyée.

Voir également pingResponseReceived(), autoKeepAlive() et keepAlive().

QMqttServerConnectionProperties QMqttClient::serverConnectionProperties() const

Renvoie la méthode ` QMqttServerConnectionProperties ` fournie par le courtier après une tentative de connexion.

Cette fonction permet de vérifier que les propriétés de connexion côté client définies par ` QMqttClient::setConnectionProperties ` ont bien été acceptées par le courtier. De plus, en cas d'échec de la tentative de connexion, elle peut être utilisée à des fins de diagnostic.

Voir également connectionProperties().

void QMqttClient::setConnectionProperties(const QMqttConnectionProperties &prop)

Définit les propriétés de connexion sur « prop ». La méthode « QMqttConnectionProperties » permet de demander au serveur d'utiliser un ensemble de fonctionnalités spécifiques. Après une requête de connexion, la réponse du serveur peut être obtenue en appelant la méthode « QMqttClient::serverConnectionProperties ».

Voir également connectionProperties().

void QMqttClient::setLastWillProperties(const QMqttLastWillProperties &prop)

Définit les propriétés du message de dernière volonté sur « prop ». L'option « QMqttLastWillProperties » permet de définir des fonctionnalités supplémentaires pour le message de dernière volonté stocké chez le courtier.

Voir également lastWillProperties().

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

Définit le transport sur « device ». Un transport peut être soit de type socket, soit dérivé de « QIODevice », et est spécifié par « transport ».

Voir également 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 (QoS) disponibles, consultez la section « Qualité de service ».

Cette fonction renvoie un pointeur vers un objet ` QMqttSubscription`. Si le même sujet fait l'objet de deux abonnements, la valeur renvoyée 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 des propriétés d'abonnement supplémentaires qui doivent être validées par le courtier. 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 (QoS) disponibles, consultez la section Qualité de service.

Cette fonction renvoie un pointeur vers un objet ` QMqttSubscription`. Si le même sujet fait l’objet de deux abonnements, la valeur renvoyée pointe vers la même instance d’abonnement. Le client MQTT est le propriétaire de l’abonnement.

QIODevice *QMqttClient::transport() const

Renvoie 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 créés via l'appel de la fonction subscribe().

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

Se désabonne de topic. Aucune notification ne sera envoyée pour les abonnements effectués via l’appel de subscribe(). properties spécifie des propriétés utilisateur supplémentaires à transmettre au courtier.