QMqttServerConnectionProperties Class
La classe QMqttServerConnectionProperties représente les options de configuration d'un serveur auquel QMqttClient est connecté. Plus d'informations...
| En-tête : | #include <QMqttServerConnectionProperties> |
| CMake : | find_package(Qt6 REQUIRED COMPONENTS Mqtt)target_link_libraries(mytarget PRIVATE Qt6::Mqtt) |
| qmake : | QT += mqtt |
| Héritages : | QMqttConnectionProperties |
Types publics
| enum | ServerPropertyDetail { None, SessionExpiryInterval, MaximumReceive, MaximumQoS, RetainAvailable, …, AuthenticationData } |
| flags | ServerPropertyDetails |
Fonctions publiques
| QMqttServerConnectionProperties::ServerPropertyDetails | availableProperties() const |
| bool | clientIdAssigned() const |
| bool | isValid() const |
| quint8 | maximumQoS() const |
| QString | reason() const |
| QMqtt::ReasonCode | reasonCode() const |
| QString | responseInformation() const |
| bool | retainAvailable() const |
| quint16 | serverKeepAlive() const |
| QString | serverReference() const |
| bool | sharedSubscriptionSupported() const |
| bool | subscriptionIdentifierSupported() const |
| bool | wildcardSupported() const |
Description détaillée
Lorsqu'une connexion a été établie, le serveur peut envoyer des détails supplémentaires sur les propriétés de la connexion. Utilisez availableProperties() pour identifier les propriétés définies par le serveur. Si une propriété n'est pas définie par le serveur, les valeurs par défaut sont supposées et peuvent être obtenues en invoquant les fonctions d'accès de cette instance.
Remarque : les propriétés de 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 types de membres
enum QMqttServerConnectionProperties::ServerPropertyDetail
flags QMqttServerConnectionProperties::ServerPropertyDetails
Ce type d'énumération spécifie les propriétés disponibles définies par le serveur ou le client après l'établissement d'une connexion.
| Constante | Valeur | Description de la propriété |
|---|---|---|
QMqttServerConnectionProperties::None | 0x00000000 | Aucune propriété n'a été spécifiée. |
QMqttServerConnectionProperties::SessionExpiryInterval | 0x00000001 | Le nombre de secondes pendant lesquelles le serveur conserve la session après une déconnexion. |
QMqttServerConnectionProperties::MaximumReceive | 0x00000002 | Le nombre maximum de messages QoS 1 et 2 que le serveur est capable de gérer simultanément. |
QMqttServerConnectionProperties::MaximumQoS | 0x00000004 | Le niveau maximum de qualité de service que le serveur peut comprendre. |
QMqttServerConnectionProperties::RetainAvailable | 0x00000010 | Spécifie si les messages conservés sont pris en charge. |
QMqttServerConnectionProperties::MaximumPacketSize | 0x00000020 | Spécifie la taille maximale des paquets, y compris l'en-tête et les propriétés du message. |
QMqttServerConnectionProperties::AssignedClientId | 0x00000040 | Indique si le serveur a attribué un identificateur de client. |
QMqttServerConnectionProperties::MaximumTopicAlias | 0x00000080 | Spécifie le nombre maximum d'alias de sujets. |
QMqttServerConnectionProperties::ReasonString | 0x00000100 | Spécifie une chaîne de caractères fournissant plus de détails sur l'état de la connexion. |
QMqttServerConnectionProperties::UserProperty | 0x00000200 | Spécifie des propriétés supplémentaires pour l'utilisateur. |
QMqttServerConnectionProperties::WildCardSupported | 0x00000400 | Indique si le serveur prend en charge les abonnements avec caractères génériques. |
QMqttServerConnectionProperties::SubscriptionIdentifierSupport | 0x00000800 | Indique si le serveur prend en charge les identifiants d'abonnement. |
QMqttServerConnectionProperties::SharedSubscriptionSupport | 0x00001000 | Indique si le serveur prend en charge les abonnements partagés. |
QMqttServerConnectionProperties::ServerKeepAlive | 0x00002000 | Indique le nombre de secondes pendant lesquelles le serveur attend un paquet de maintien en vie de la part du client. |
QMqttServerConnectionProperties::ResponseInformation | 0x00004000 | Spécifie les informations de réponse. |
QMqttServerConnectionProperties::ServerReference | 0x00008000 | Spécifie une autre adresse de serveur à laquelle le client peut se connecter. |
QMqttServerConnectionProperties::AuthenticationMethod | 0x00010000 | Spécifie la méthode d'authentification. |
QMqttServerConnectionProperties::AuthenticationData | 0x00020000 | Spécifie les données d'authentification. |
Le type ServerPropertyDetails est un typedef pour QFlags<ServerPropertyDetail>. Il stocke une combinaison OR de valeurs ServerPropertyDetail.
Documentation des fonctions membres
QMqttServerConnectionProperties::ServerPropertyDetails QMqttServerConnectionProperties::availableProperties() const
Renvoie les propriétés disponibles spécifiées par le serveur.
bool QMqttServerConnectionProperties::clientIdAssigned() const
Renvoie true si le serveur a attribué un nouvel identifiant au client.
Voir aussi QMqttClient::clientId().
bool QMqttServerConnectionProperties::isValid() const
Renvoie true si le serveur a fourni des propriétés dans le cadre de l'accusé de réception de la connexion. Renvoie false si aucune propriété n'a été fournie.
quint8 QMqttServerConnectionProperties::maximumQoS() const
Renvoie le niveau maximal de qualité de service pris en charge par le serveur pour la publication des messages. La publication de messages dont le niveau de qualité de service dépasse le niveau maximal indiqué par le serveur constitue une violation du protocole.
Si le client n'a pas besoin de prendre en charge QoS 1 ou QoS 2, il doit limiter le niveau maximal de QoS dans tout abonnement à une valeur qu'il peut prendre en charge ; le serveur publiera alors des messages avec le maximum des niveaux de QoS pris en charge et restreints.
La valeur par défaut est 2.
Voir également QMqttClient::publish() et QMqttClient::subscribe().
QString QMqttServerConnectionProperties::reason() const
Renvoie la chaîne de motifs associée à cette réponse.
QMqtt::ReasonCode QMqttServerConnectionProperties::reasonCode() const
Renvoie le code de motif associé à cette réponse.
QString QMqttServerConnectionProperties::responseInformation() const
Renvoie les informations de la réponse.
bool QMqttServerConnectionProperties::retainAvailable() const
Renvoie true si le serveur accepte les messages conservés. La valeur par défaut est true.
quint16 QMqttServerConnectionProperties::serverKeepAlive() const
Renvoie le nombre de secondes pendant lesquelles le serveur a demandé à être maintenu en vie. Ceci écrase le maintien en vie défini par le client.
Voir aussi QMqttClient::setKeepAlive().
QString QMqttServerConnectionProperties::serverReference() const
Renvoie une adresse de serveur que le client peut utiliser comme alternative pour se connecter. Généralement, cette adresse est utilisée avec le code de raison 0x9c (Utiliser un autre serveur) ou 0x9c (Le serveur a été déplacé).
bool QMqttServerConnectionProperties::sharedSubscriptionSupported() const
Renvoie true si le serveur accepte les abonnements partagés. La valeur par défaut est true.
bool QMqttServerConnectionProperties::subscriptionIdentifierSupported() const
Renvoie true si le serveur accepte les identifiants d'abonnement. Les identifiants d'abonnement peuvent être transmis au serveur lors de la création d'un nouvel abonnement.
La valeur par défaut est true.
Voir aussi QMqttSubscriptionProperties::setSubscriptionIdentifier().
bool QMqttServerConnectionProperties::wildcardSupported() const
Renvoie true si le serveur accepte les abonnements comprenant des caractères génériques. La valeur par défaut est true.
© 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.
