QMqttServerConnectionProperties Class
La classe `QMqttServerConnectionProperties` représente les options de configuration d'un serveur auquel une instance ` QMqttClient ` est connectée. En savoir plus...
| En-tête : | #include <QMqttServerConnectionProperties> |
| CMake : | find_package(Qt6 REQUIRED COMPONENTS Mqtt) target_link_libraries(mytarget PRIVATE Qt6::Mqtt) |
| qmake : | QT += mqtt |
| Hérite de : | 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
Une fois la connexion établie, le serveur peut envoyer des informations supplémentaires sur les propriétés de la connexion. Utilisez la méthode availableProperties() pour identifier les propriétés définies par le serveur. Si une propriété n’est pas définie par le serveur, des valeurs par défaut sont utilisées et peuvent être obtenues en appelant les fonctions d’accès de cette instance.
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 sur les 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 |
|---|---|---|
QMqttServerConnectionProperties::None | 0x00000000 | Aucune propriété n’a été spécifiée. |
QMqttServerConnectionProperties::SessionExpiryInterval | 0x00000001 | Nombre de secondes pendant lesquelles le serveur conserve la session après une déconnexion. |
QMqttServerConnectionProperties::MaximumReceive | 0x00000002 | Nombre maximal de messages QoS 1 et 2 que le serveur est capable de gérer simultanément. |
QMqttServerConnectionProperties::MaximumQoS | 0x00000004 | Le niveau de qualité de service (QoS) maximal que le serveur peut prendre en charge. |
QMqttServerConnectionProperties::RetainAvailable | 0x00000010 | Indique 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 identifiant client. |
QMqttServerConnectionProperties::MaximumTopicAlias | 0x00000080 | Spécifie le nombre maximal d’alias de sujet. |
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 utilisateur supplémentaires. |
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 | Spécifie si le serveur prend en charge les abonnements partagés. |
QMqttServerConnectionProperties::ServerKeepAlive | 0x00002000 | Spécifie le nombre de secondes pendant lesquelles le serveur attend un paquet de maintien de connexion 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 client au client.
Voir également 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 de qualité de service (QoS) maximal pris en charge par le serveur pour la publication de messages. La publication de messages dont le niveau de QoS 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 les niveaux de qualité de service 1 ou 2, il doit limiter le niveau de qualité de service maximal de tout abonnement qu'il souscrit à une valeur qu'il est en mesure de prendre en charge ; le serveur publiera alors des messages dont le niveau de qualité de service correspondra à la valeur la plus élevée entre le niveau maximal pris en charge et le niveau limité.
La valeur par défaut est 2.
Voir également QMqttClient::publish() et QMqttClient::subscribe().
QString QMqttServerConnectionProperties::reason() const
Renvoie la chaîne de caractères indiquant le motif associé à cette réponse.
QMqtt::ReasonCode QMqttServerConnectionProperties::reasonCode() const
Renvoie le code de motif associé à cette réponse.
QString QMqttServerConnectionProperties::responseInformation() const
Renvoie les informations relatives à 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 demandé par le serveur pour le « keep alive ». Cela remplace le « keep alive » défini côté client.
Voir également QMqttClient::setKeepAlive().
QString QMqttServerConnectionProperties::serverReference() const
Renvoie une adresse de serveur à laquelle le client peut se connecter à défaut. En général, cette fonction est utilisée conjointement avec le code de motif « 0x9c » (Utiliser un autre serveur) ou « 0x9c » (Serveur 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 également QMqttSubscriptionProperties::setSubscriptionIdentifier().
bool QMqttServerConnectionProperties::wildcardSupported() const
Renvoie « true » si le serveur accepte les abonnements contenant 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.
