QMqttPublishProperties Class
Die Klasse „QMqttPublishProperties“ stellt Konfigurationsoptionen für das Senden oder Empfangen einer Nachricht dar. Mehr...
| Header: | #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 |
Ausführliche Beschreibung
Beim Aufruf von ` QMqttClient::publish()` zum Senden einer Nachricht an einen Broker können `QMqttPublishProperties` übergeben werden, um zusätzliche Argumente dafür bereitzustellen, wie die Nachricht auf dem 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: Veröffentlichungseigenschaften sind Teil der MQTT 5.0-Spezifikation und können bei einer Verbindung auf einer niedrigeren Protokollebene nicht verwendet werden. Weitere Informationen finden Sie unter QMqttClient::ProtocolVersion.
Dokumentation zu Mitgliedstypen
enum QMqttPublishProperties::PublishPropertyDetail
flags QMqttPublishProperties::PublishPropertyDetails
Dieser Enum-Typ gibt die verfügbaren Eigenschaften an, die beim Erstellen einer Nachricht vom Server oder vom Client festgelegt werden.
| Konstante | Wert | Beschreibung |
|---|---|---|
QMqttPublishProperties::None | 0x00000000 | Es wurde keine Eigenschaft angegeben. |
QMqttPublishProperties::PayloadFormatIndicator | 0x00000001 | Der Inhaltstyp der Nachricht. |
QMqttPublishProperties::MessageExpiryInterval | 0x00000002 | Die Gültigkeitsdauer einer Nachricht. |
QMqttPublishProperties::TopicAlias | 0x00000004 | Der Themenalias für diese Nachricht. |
QMqttPublishProperties::ResponseTopic | 0x00000008 | Das Thema, auf das der Empfänger antworten soll. |
QMqttPublishProperties::CorrelationData | 0x00000010 | Eine Kennung der Antwortnachricht. |
QMqttPublishProperties::UserProperty | 0x00000020 | Vom Benutzer festgelegte zusätzliche Eigenschaften. |
QMqttPublishProperties::SubscriptionIdentifier | 0x00000040 | Eine Kennung der 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 ODER-Kombination von „PublishPropertyDetail“-Werten.
Dokumentation der Mitgliedsfunktionen
QMqttPublishProperties::PublishPropertyDetails QMqttPublishProperties::availableProperties() const
Gibt die in dieser Instanz angegebenen verfügbaren Eigenschaften zurück. Beim Erstellen einer Nachricht müssen nicht alle Eigenschaften enthalten sein. 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, während der ein Server die Nachricht weiterleiten darf. Nach Ablauf dieses Intervalls muss der Server die Nachricht löschen und die Veröffentlichung abbrechen.
Siehe auch ` setMessageExpiryInterval()`.
QMqtt::PayloadFormatIndicator QMqttPublishProperties::payloadFormatIndicator() const
Gibt den Indikator für das Payload-Format zurück.
Siehe auch „ setPayloadFormatIndicator()“.
QString QMqttPublishProperties::responseTopic() const
Gibt das Antwort-Topic zurück, das ein Benutzer als Folge einer Anfrage verwenden sollte.
Siehe auch „ setResponseTopic()“.
void QMqttPublishProperties::setContentType(const QString &type)
Legt den Inhaltstyp der Nachricht auf „ type “ fest.
Siehe auch ` contentType()`.
void QMqttPublishProperties::setCorrelationData(const QByteArray &correlation)
Setzt die Korrelationsdaten auf „ correlation “.
Siehe auch correlationData().
void QMqttPublishProperties::setMessageExpiryInterval(quint32 interval)
Legt das Ablaufintervall für Nachrichten auf interval fest.
Siehe auch messageExpiryInterval().
void QMqttPublishProperties::setPayloadFormatIndicator(QMqtt::PayloadFormatIndicator indicator)
Setzt den Indikator für das Payload-Format auf „ indicator “.
Siehe auch ` payloadFormatIndicator()`.
void QMqttPublishProperties::setResponseTopic(const QString &topic)
Legt das Antwortthema auf „ topic “ fest.
Siehe auch responseTopic().
void QMqttPublishProperties::setSubscriptionIdentifiers(const QList<quint32> &ids)
Setzt die Abonnement-IDs auf „ ids “.
Siehe auch subscriptionIdentifiers().
void QMqttPublishProperties::setTopicAlias(quint16 alias)
Legt den Themenalias für die Veröffentlichung einer Nachricht an alias fest. Der Wert des Themenalias muss größer als Null und kleiner als der vom Server festgelegte maximale Themenalias 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 Abonnement-IDs der Abonnements zurück, die dem Themenfilter der Nachricht entsprechen.
Siehe auch „ setSubscriptionIdentifiers()“.
quint16 QMqttPublishProperties::topicAlias() const
Gibt den Themenalias zurück, der zum Veröffentlichen einer Nachricht verwendet wurde.
Siehe auch „ setTopicAlias()“.
QMqttUserProperties QMqttPublishProperties::userProperties() const
Gibt die Benutzereigenschaften einer Nachricht zurück.
Siehe auch „ 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.
