QMqttPublishProperties Class
Die Klasse QMqttPublishProperties stellt Konfigurationsoptionen für das Senden oder Empfangen einer Nachricht dar. Mehr...
| Kopfzeile: | #include <QMqttPublishProperties> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS Mqtt)target_link_libraries(mytarget PRIVATE Qt6::Mqtt) |
| qmake: | QT += mqtt |
Öffentliche Typen
| enum | PublishPropertyDetail { None, PayloadFormatIndicator, MessageExpiryInterval, TopicAlias, ResponseTopic, …, ContentType } |
| flags | PublishPropertyDetails |
Öffentliche Funktionen
| 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 |
Detaillierte Beschreibung
Der Aufruf von QMqttClient::publish() zum Senden einer Nachricht an einen Broker kann QMqttPublishProperties enthalten, um zusätzliche Argumente dafür zu liefern, wie die Nachricht beim Broker behandelt werden soll.
Darüber hinaus kann der Empfang einer Nachricht durch ein instanziiertes Abonnement Veröffentlichungseigenschaften enthalten, die vom Server weitergeleitet oder angepasst wurden.
Hinweis: Publish-Properties sind Teil der MQTT 5.0-Spezifikation und können nicht verwendet werden, wenn eine Verbindung mit einer niedrigeren Protokollebene besteht. Siehe QMqttClient::ProtocolVersion für weitere Informationen.
Dokumentation der Mitgliedstypen
enum QMqttPublishProperties::PublishPropertyDetail
flags QMqttPublishProperties::PublishPropertyDetails
Dieser Enum-Typ gibt die verfügbaren Eigenschaften an, die vom Server oder vom Client bei der Erstellung einer Nachricht festgelegt werden.
| Konstante | Wert | Beschreibung |
|---|---|---|
QMqttPublishProperties::None | 0x00000000 | Es wurde keine Eigenschaft angegeben. |
QMqttPublishProperties::PayloadFormatIndicator | 0x00000001 | Die Art des Inhalts der Nachricht. |
QMqttPublishProperties::MessageExpiryInterval | 0x00000002 | Die Dauer, für die eine Nachricht gültig ist. |
QMqttPublishProperties::TopicAlias | 0x00000004 | Der Themenalias für diese Nachricht. |
QMqttPublishProperties::ResponseTopic | 0x00000008 | Das Thema, auf das der Empfänger antworten soll. |
QMqttPublishProperties::CorrelationData | 0x00000010 | Ein Identifikator für die Antwortnachricht. |
QMqttPublishProperties::UserProperty | 0x00000020 | Zusätzliche vom Benutzer festgelegte Eigenschaften. |
QMqttPublishProperties::SubscriptionIdentifier | 0x00000040 | Ein Identifikator von Abonnements, die der Veröffentlichung entsprechen. |
QMqttPublishProperties::ContentType | 0x00000080 | Eine Beschreibung des Inhalts der Nachricht. |
Der Typ PublishPropertyDetails ist ein Typedef für QFlags<PublishPropertyDetail>. Er speichert eine OR-Kombination von PublishPropertyDetail-Werten.
Dokumentation der Mitgliedsfunktionen
QMqttPublishProperties::PublishPropertyDetails QMqttPublishProperties::availableProperties() const
Gibt die in dieser Instanz angegebenen verfügbaren Eigenschaften zurück. Wenn eine Nachricht erstellt wird, muss sie nicht alle Eigenschaften enthalten. Diese Funktion dient als Indikator für die Eigenschaften, die explizit festgelegt wurden.
QString QMqttPublishProperties::contentType() const
Gibt den Inhaltstyp der Nachricht zurück.
Siehe auch setContentType().
QByteArray QMqttPublishProperties::correlationData() const
Gibt die Korrelationsdaten zurück.
Siehe auch setCorrelationData().
quint32 QMqttPublishProperties::messageExpiryInterval() const
Gibt das Ablaufintervall der Nachricht zurück. Dieser Wert gibt die Anzahl der Sekunden an, die ein Server die Nachricht weiterleiten darf. Wenn das Intervall abläuft, muss der Server die Nachricht löschen und ihre Veröffentlichung abbrechen.
Siehe auch setMessageExpiryInterval().
QMqtt::PayloadFormatIndicator QMqttPublishProperties::payloadFormatIndicator() const
Gibt den Indikator für das Nutzlastformat zurück.
Siehe auch setPayloadFormatIndicator().
QString QMqttPublishProperties::responseTopic() const
Gibt das Antwortthema zurück, das ein Benutzer als Antwort auf eine Anfrage verwenden sollte.
Siehe auch setResponseTopic().
void QMqttPublishProperties::setContentType(const QString &type)
Setzt den Inhaltstyp der Nachricht auf type.
Siehe auch contentType().
void QMqttPublishProperties::setCorrelationData(const QByteArray &correlation)
Setzt die Korrelationsdaten auf correlation.
Siehe auch correlationData().
void QMqttPublishProperties::setMessageExpiryInterval(quint32 interval)
Setzt das Verfallsintervall der Nachricht auf interval.
Siehe auch messageExpiryInterval().
void QMqttPublishProperties::setPayloadFormatIndicator(QMqtt::PayloadFormatIndicator indicator)
Setzt den Indikator für das Nutzlastformat auf indicator.
Siehe auch payloadFormatIndicator().
void QMqttPublishProperties::setResponseTopic(const QString &topic)
Setzt das Antwortthema auf topic.
Siehe auch responseTopic().
void QMqttPublishProperties::setSubscriptionIdentifiers(const QList<quint32> &ids)
Setzt die Abonnement-Kennungen auf ids.
Siehe auch subscriptionIdentifiers().
void QMqttPublishProperties::setTopicAlias(quint16 alias)
Legt den Themenalias für die Veröffentlichung einer Nachricht auf alias fest. Der Wert eines Themen-Alias muss größer als Null und kleiner als der vom Server angegebene maximale Themen-Alias sein.
Siehe auch topicAlias() und QMqttServerConnectionProperties::maximumTopicAlias().
void QMqttPublishProperties::setUserProperties(const QMqttUserProperties &properties)
Setzt die Benutzereigenschaften einer Nachricht auf properties.
Siehe auch userProperties().
QList<quint32> QMqttPublishProperties::subscriptionIdentifiers() const
Gibt die Abonnementkennungen der Abonnements zurück, die dem Themenfilter der Nachricht entsprechen.
Siehe auch setSubscriptionIdentifiers().
quint16 QMqttPublishProperties::topicAlias() const
Gibt den für die Veröffentlichung einer Nachricht verwendeten Themenalias zurück.
Siehe auch setTopicAlias().
QMqttUserProperties QMqttPublishProperties::userProperties() const
Gibt die Benutzereigenschaften einer Nachricht zurück.
Siehe auch setUserProperties().
© 2025 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.
