Sur cette page

QMqttConnectionProperties Class

La classe QMqttConnectionProperties représente les options de configuration qu'un QMqttClient e peut transmettre au serveur lors de l'appel de la fonction QMqttClient::connectToHost(). En savoir plus...

En-tête : #include <QMqttConnectionProperties>
CMake : find_package(Qt6 REQUIRED COMPONENTS Mqtt)
target_link_libraries(mytarget PRIVATE Qt6::Mqtt)
qmake : QT += mqtt
Hérité par :

QMqttServerConnectionProperties

Fonctions publiques

QByteArray authenticationData() const
QString authenticationMethod() const
quint32 maximumPacketSize() const
quint16 maximumReceive() const
quint16 maximumTopicAlias() const
bool requestProblemInformation() const
bool requestResponseInformation() const
quint32 sessionExpiryInterval() const
void setAuthenticationData(const QByteArray &authData)
void setAuthenticationMethod(const QString &authMethod)
void setMaximumPacketSize(quint32 packetSize)
void setMaximumReceive(quint16 maximumReceive)
void setMaximumTopicAlias(quint16 alias)
void setRequestProblemInformation(bool problem)
void setRequestResponseInformation(bool response)
void setSessionExpiryInterval(quint32 expiry)
void setUserProperties(const QMqttUserProperties &properties)
QMqttUserProperties userProperties() const

Description détaillée

Remarque : les propriétésde connexion font partie de la spécification MQTT 5.0 et ne peuvent pas être utilisées lors d'une connexion avec un niveau de protocole inférieur. Voir QMqttClient::ProtocolVersion pour plus d'informations.

Documentation des fonctions membres

QByteArray QMqttConnectionProperties::authenticationData() const

Renvoie les données d'authentification.

Voir aussi setAuthenticationData().

QString QMqttConnectionProperties::authenticationMethod() const

Renvoie la méthode d'authentification.

Voir aussi setAuthenticationMethod().

quint32 QMqttConnectionProperties::maximumPacketSize() const

Renvoie la taille maximale de paquet que le client peut recevoir.

Voir aussi setMaximumPacketSize().

quint16 QMqttConnectionProperties::maximumReceive() const

Renvoie le nombre maximal de publications QoS 1 et QoS 2 que le client (lorsqu'il est obtenu via QMqttClient::connectionProperties()) ou le serveur (lorsqu'il est obtenu via QMqttClient::serverConnectionProperties()) est prêt à traiter simultanément pour cette session.

Voir également setMaximumReceive().

quint16 QMqttConnectionProperties::maximumTopicAlias() const

Renvoie l'ID d'alias de sujet maximal que le client peut utiliser.

Voir également setMaximumTopicAlias().

bool QMqttConnectionProperties::requestProblemInformation() const

Indique si le client doit recevoir des informations relatives aux problèmes.

Voir également setRequestProblemInformation().

bool QMqttConnectionProperties::requestResponseInformation() const

Indique si le client doit recevoir les informations de réponse.

Voir également setRequestResponseInformation().

quint32 QMqttConnectionProperties::sessionExpiryInterval() const

Renvoie la durée de validité de la session.

Voir aussi setSessionExpiryInterval().

void QMqttConnectionProperties::setAuthenticationData(const QByteArray &authData)

Définit les données d'authentification sur authData.

Les données d'authentification ne peuvent être utilisées que si une méthode d'authentification a été spécifiée.

Voir également authenticationData() et authenticationMethod().

void QMqttConnectionProperties::setAuthenticationMethod(const QString &authMethod)

Définit la méthode d'authentification sur authMethod.

Voir également authenticationMethod() et authenticationData().

void QMqttConnectionProperties::setMaximumPacketSize(quint32 packetSize)

Définit la taille maximale des paquets à packetSize. La taille maximale des paquets correspond à la taille maximale qu'un paquet peut contenir. Cela inclut l'en-tête du paquet et ses propriétés.

Si aucune taille maximale de paquet n’est spécifiée, aucune limite n’est imposée au-delà des contraintes du protocole lui-même.

Voir également maximumPacketSize().

void QMqttConnectionProperties::setMaximumReceive(quint16 maximumReceive)

Définit le nombre maximal de publications QoS 1 et QoS 2 que le client est prêt à traiter simultanément pour cette session, à l'adresse maximumReceive.

Une valeur maximale de réception égale à 0 n'est pas autorisée.

Voir également maximumReceive().

void QMqttConnectionProperties::setMaximumTopicAlias(quint16 alias)

Définit l'alias de sujet maximal sur alias. L'alias de sujet maximal spécifie la valeur la plus élevée que le client acceptera de la part du serveur. Le client utilise cette valeur pour limiter le nombre d'alias de sujet qu'il est prêt à conserver pour la connexion.

La valeur par défaut est 0. La valeur 0 indique que le client n’accepte aucun alias de sujet sur cette connexion.

Voir également maximumTopicAlias().

void QMqttConnectionProperties::setRequestProblemInformation(bool problem)

Définit les informations relatives aux problèmes de requête sur « problem ». Un client utilise cette option pour demander au serveur de renvoyer des informations supplémentaires en cas d'échec. Les types d'échec incluent la gestion des connexions et des messages côté serveur.

La valeur par défaut est false, ce qui indique que le client ne doit recevoir aucune information relative aux problèmes, sauf en ce qui concerne la gestion de la connexion. Le serveur peut toutefois envoyer des informations relatives aux problèmes liés à la gestion de la connexion. Si la valeur est true, le serveur peut renvoyer des informations relatives aux problèmes.

Les informations de problème sont disponibles dans les propriétés utilisateur ou dans les chaînes de motif des classes de propriétés.

Voir également requestProblemInformation().

void QMqttConnectionProperties::setRequestResponseInformation(bool response)

Définit les informations de réponse à la requête sur response. Un client utilise cette option pour demander au serveur de renvoyer des informations de réponse une fois la requête de connexion traitée.

La valeur par défaut est false, ce qui indique que le client ne doit renvoyer aucune information de réponse. Si la valeur est true, le serveur peut renvoyer des informations de réponse, mais n’est pas obligé de le faire.

Voir également requestResponseInformation().

void QMqttConnectionProperties::setSessionExpiryInterval(quint32 expiry)

Définit l'intervalle d'expiration de la session sur expiry. L'intervalle d'expiration de la session spécifie le nombre de secondes pendant lesquelles un serveur conserve les informations relatives à l'état du client après la fermeture d'une connexion.

La valeur par défaut est 0, ce qui signifie que la session est fermée dès la fin de la connexion réseau. Si la valeur spécifiée est inférieure ou égale à la valeur maximale de type quint32, la session n'expire pas.

Voir également sessionExpiryInterval().

void QMqttConnectionProperties::setUserProperties(const QMqttUserProperties &properties)

Définit les propriétés utilisateur de la connexion à properties.

Par défaut, aucune information utilisateur n'est envoyée.

Voir aussi userProperties().

QMqttUserProperties QMqttConnectionProperties::userProperties() const

Renvoie les propriétés utilisateur de la connexion.

Voir également setUserProperties().

© 2026 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.