QMqttPublishProperties Class
La classe QMqttPublishProperties représente les options de configuration pour l'envoi ou la réception d'un message. En savoir plus...
| En-tête : | #include <QMqttPublishProperties> |
| CMake : | find_package(Qt6 REQUIRED COMPONENTS Mqtt) target_link_libraries(mytarget PRIVATE Qt6::Mqtt) |
| qmake : | QT += mqtt |
Types publics
| enum | PublishPropertyDetail { None, PayloadFormatIndicator, MessageExpiryInterval, TopicAlias, ResponseTopic, …, ContentType } |
| flags | PublishPropertyDetails |
Fonctions publiques
| QMqttPublishProperties::PublishPropertyDetails | availableProperties() const |
| QString | contentType() const |
| QByteArray | correlationData() const |
| quint32 | messageExpiryInterval() const |
| QMqtt::PayloadFormatIndicator | payloadFormatIndicator() const |
| QString | responseTopic() const |
| void | setContentType(const QString &type) |
| void | setCorrelationData(const QByteArray &correlation) |
| void | setMessageExpiryInterval(quint32 interval) |
| void | setPayloadFormatIndicator(QMqtt::PayloadFormatIndicator indicator) |
| void | setResponseTopic(const QString &topic) |
| void | setSubscriptionIdentifiers(const QList<quint32> &ids) |
| void | setTopicAlias(quint16 alias) |
| void | setUserProperties(const QMqttUserProperties &properties) |
| QList<quint32> | subscriptionIdentifiers() const |
| quint16 | topicAlias() const |
| QMqttUserProperties | userProperties() const |
Description détaillée
L'appel de la fonction ` QMqttClient::publish()` pour envoyer un message à un courtier peut inclure `QMqttPublishProperties` afin de fournir des arguments supplémentaires sur la manière dont le message doit être traité par le courtier.
De plus, la réception d'un message par un abonnement instancié peut contenir des propriétés de publication qui ont été transmises ou adaptées par le serveur.
Remarque : les propriétésde publication 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 QMqttPublishProperties::PublishPropertyDetail
flags QMqttPublishProperties::PublishPropertyDetails
Ce type d'énumération spécifie les propriétés disponibles définies par le serveur ou le client lors de la création d'un message.
| Constante | Valeur | Description |
|---|---|---|
QMqttPublishProperties::None | 0x00000000 | Aucune propriété n’a été spécifiée. |
QMqttPublishProperties::PayloadFormatIndicator | 0x00000001 | Le type de contenu du message. |
QMqttPublishProperties::MessageExpiryInterval | 0x00000002 | Durée de validité d’un message. |
QMqttPublishProperties::TopicAlias | 0x00000004 | L'alias du sujet de ce message. |
QMqttPublishProperties::ResponseTopic | 0x00000008 | Le sujet auquel le destinataire doit répondre. |
QMqttPublishProperties::CorrelationData | 0x00000010 | Un identifiant du message de réponse. |
QMqttPublishProperties::UserProperty | 0x00000020 | Propriétés supplémentaires définies par l'utilisateur. |
QMqttPublishProperties::SubscriptionIdentifier | 0x00000040 | Un identifiant des abonnements correspondant à la publication. |
QMqttPublishProperties::ContentType | 0x00000080 | Une description du contenu du message. |
Le type `PublishPropertyDetails` est un `typedef` pour ` QFlags<PublishPropertyDetail>`. Il stocke une combinaison « ou » de valeurs `PublishPropertyDetail`.
Documentation des fonctions membres
QMqttPublishProperties::PublishPropertyDetails QMqttPublishProperties::availableProperties() const
Renvoie les propriétés disponibles spécifiées dans cette instance. Lors de la création d'un message, il n'est pas nécessaire d'inclure toutes les propriétés. Cette fonction permet d'identifier les propriétés qui ont été explicitement définies.
QString QMqttPublishProperties::contentType() const
Renvoie le type de contenu du message.
Voir aussi setContentType().
QByteArray QMqttPublishProperties::correlationData() const
Renvoie les données de corrélation.
Voir également setCorrelationData().
quint32 QMqttPublishProperties::messageExpiryInterval() const
Renvoie l'intervalle d'expiration du message. Cette valeur indique le nombre de secondes pendant lesquelles un serveur est autorisé à transférer le message. Si cet intervalle arrive à expiration, le serveur doit supprimer le message et interrompre sa publication.
Voir également setMessageExpiryInterval().
QMqtt::PayloadFormatIndicator QMqttPublishProperties::payloadFormatIndicator() const
Renvoie l'indicateur de format de la charge utile.
Voir également setPayloadFormatIndicator().
QString QMqttPublishProperties::responseTopic() const
Renvoie le sujet de réponse qu'un utilisateur doit utiliser pour donner suite à une demande.
Voir également setResponseTopic().
void QMqttPublishProperties::setContentType(const QString &type)
Définit le type de contenu du message sur « type ».
Voir également contentType().
void QMqttPublishProperties::setCorrelationData(const QByteArray &correlation)
Définit les données de corrélation sur correlation.
Voir également correlationData().
void QMqttPublishProperties::setMessageExpiryInterval(quint32 interval)
Définit l'intervalle d'expiration des messages sur interval.
Voir également messageExpiryInterval().
void QMqttPublishProperties::setPayloadFormatIndicator(QMqtt::PayloadFormatIndicator indicator)
Définit l'indicateur de format de la charge utile sur « indicator ».
Voir également payloadFormatIndicator().
void QMqttPublishProperties::setResponseTopic(const QString &topic)
Définit le sujet de la réponse sur « topic ».
Voir également responseTopic().
void QMqttPublishProperties::setSubscriptionIdentifiers(const QList<quint32> &ids)
Définit les identifiants d'abonnement sur ids.
Voir également subscriptionIdentifiers().
void QMqttPublishProperties::setTopicAlias(quint16 alias)
Définit l'alias de sujet pour la publication d'un message sur alias. La valeur de l'alias de sujet doit être supérieure à zéro et inférieure à l'alias de sujet maximal spécifié par le serveur.
Voir également topicAlias() et QMqttServerConnectionProperties::maximumTopicAlias().
void QMqttPublishProperties::setUserProperties(const QMqttUserProperties &properties)
Définit les propriétés utilisateur d'un message sur properties.
Voir également userProperties().
QList<quint32> QMqttPublishProperties::subscriptionIdentifiers() const
Renvoie les identifiants des abonnements correspondant au filtre de sujet du message.
Voir également setSubscriptionIdentifiers().
quint16 QMqttPublishProperties::topicAlias() const
Renvoie l'alias du sujet utilisé pour publier un message.
Voir aussi setTopicAlias().
QMqttUserProperties QMqttPublishProperties::userProperties() const
Renvoie les propriétés utilisateur d'un message.
Voir aussi 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.
