QMqttPublishProperties Class
La classe QMqttPublishProperties représente les options de configuration pour l'envoi ou la réception d'un message. Plus d'informations...
| 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 à QMqttClient::publish() pour envoyer un message à un courtier peut inclure des QMqttPublishProperties pour fournir des arguments supplémentaires sur la manière dont le message doit être traité par le courtier.
En outre, 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.
Note : Les propriétés de 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 des 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 de la propriété |
|---|---|---|
QMqttPublishProperties::None | 0x00000000 | Aucune propriété n'a été spécifiée. |
QMqttPublishProperties::PayloadFormatIndicator | 0x00000001 | Le type de contenu du message. |
QMqttPublishProperties::MessageExpiryInterval | 0x00000002 | La durée de validité du message. |
QMqttPublishProperties::TopicAlias | 0x00000004 | L'alias du sujet pour 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 OR de valeurs PublishPropertyDetail.
Documentation des fonctions membres
QMqttPublishProperties::PublishPropertyDetails QMqttPublishProperties::availableProperties() const
Renvoie les propriétés disponibles spécifiées dans cette instance. Lorsqu'un message est créé, il n'est pas nécessaire qu'il contienne toutes les propriétés. Cette fonction sert d'indicateur des 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é à transmettre le message. Si l'intervalle expire, le serveur doit supprimer le message et interrompre sa publication.
Voir aussi setMessageExpiryInterval().
QMqtt::PayloadFormatIndicator QMqttPublishProperties::payloadFormatIndicator() const
Renvoie l'indicateur de format de la charge utile.
Voir aussi setPayloadFormatIndicator().
QString QMqttPublishProperties::responseTopic() const
Renvoie le sujet de la réponse qu'un utilisateur doit utiliser pour donner suite à une demande.
Voir aussi setResponseTopic().
void QMqttPublishProperties::setContentType(const QString &type)
Définit le type de contenu du message à type.
Voir aussi contentType().
void QMqttPublishProperties::setCorrelationData(const QByteArray &correlation)
Définit les données de corrélation à correlation.
Voir aussi correlationData().
void QMqttPublishProperties::setMessageExpiryInterval(quint32 interval)
Fixe l'intervalle d'expiration des messages à interval.
Voir aussi messageExpiryInterval().
void QMqttPublishProperties::setPayloadFormatIndicator(QMqtt::PayloadFormatIndicator indicator)
Définit l'indicateur de format de la charge utile à indicator.
Voir aussi payloadFormatIndicator().
void QMqttPublishProperties::setResponseTopic(const QString &topic)
Définit le sujet de la réponse à topic.
Voir aussi responseTopic().
void QMqttPublishProperties::setSubscriptionIdentifiers(const QList<quint32> &ids)
Définit les identifiants d'abonnement à ids.
Voir aussi subscriptionIdentifiers().
void QMqttPublishProperties::setTopicAlias(quint16 alias)
Définit l'alias du sujet pour la publication d'un message sur alias. La valeur d'un alias de rubrique doit être supérieure à zéro et inférieure à l'alias de rubrique maximal spécifié par le serveur.
Voir aussi topicAlias() et QMqttServerConnectionProperties::maximumTopicAlias().
void QMqttPublishProperties::setUserProperties(const QMqttUserProperties &properties)
Définit les propriétés utilisateur d'un message à properties.
Voir aussi userProperties().
QList<quint32> QMqttPublishProperties::subscriptionIdentifiers() const
Renvoie les identifiants des abonnements correspondant au filtre thématique du message.
Voir aussi setSubscriptionIdentifiers().
quint16 QMqttPublishProperties::topicAlias() const
Renvoie l'alias du sujet utilisé pour la publication d'un message.
Voir aussi setTopicAlias().
QMqttUserProperties QMqttPublishProperties::userProperties() const
Renvoie les propriétés de l'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.
