QMqttServerConnectionProperties Class
Die Klasse QMqttServerConnectionProperties stellt Konfigurationsoptionen eines Servers dar, mit dem QMqttClient verbunden ist. Mehr...
| Kopfzeile: | #include <QMqttServerConnectionProperties> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS Mqtt)target_link_libraries(mytarget PRIVATE Qt6::Mqtt) |
| qmake: | QT += mqtt |
| Vererbungen: | QMqttConnectionProperties |
Öffentliche Typen
| enum | ServerPropertyDetail { None, SessionExpiryInterval, MaximumReceive, MaximumQoS, RetainAvailable, …, AuthenticationData } |
| flags | ServerPropertyDetails |
Öffentliche Funktionen
| 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 |
Detaillierte Beschreibung
Wenn eine Verbindung hergestellt wurde, sendet der Server möglicherweise zusätzliche Details über die Verbindungseigenschaften. Verwenden Sie availableProperties(), um vom Server festgelegte Eigenschaften zu identifizieren. Wenn eine Eigenschaft nicht vom Server gesetzt ist, werden Standardwerte angenommen und können durch den Aufruf von Zugriffsfunktionen dieser Instanz erhalten werden.
Hinweis: Verbindungseigenschaften sind Teil der MQTT 5.0-Spezifikation und können nicht verwendet werden, wenn eine Verbindung mit einer niedrigeren Protokollebene hergestellt wird. Siehe QMqttClient::ProtocolVersion für weitere Informationen.
Dokumentation der Mitgliedstypen
enum QMqttServerConnectionProperties::ServerPropertyDetail
flags QMqttServerConnectionProperties::ServerPropertyDetails
Dieser Enum-Typ gibt die verfügbaren Eigenschaften an, die vom Server oder vom Client nach dem Aufbau einer Verbindung gesetzt werden.
| Konstante | Wert | Beschreibung |
|---|---|---|
QMqttServerConnectionProperties::None | 0x00000000 | Es wurde keine Eigenschaft angegeben. |
QMqttServerConnectionProperties::SessionExpiryInterval | 0x00000001 | Die Anzahl der Sekunden, die der Server die Sitzung nach einem Verbindungsabbruch aufrechterhält. |
QMqttServerConnectionProperties::MaximumReceive | 0x00000002 | Die maximale Anzahl von QoS 1 und 2 Nachrichten, die der Server gleichzeitig verwalten kann. |
QMqttServerConnectionProperties::MaximumQoS | 0x00000004 | Die maximale QoS-Stufe, die der Server verstehen kann. |
QMqttServerConnectionProperties::RetainAvailable | 0x00000010 | Gibt an, ob zurückgehaltene Nachrichten unterstützt werden. |
QMqttServerConnectionProperties::MaximumPacketSize | 0x00000020 | Gibt die maximale Paketgröße einschließlich des Nachrichtenkopfes und der Eigenschaften an. |
QMqttServerConnectionProperties::AssignedClientId | 0x00000040 | Gibt an, ob der Server einen Client-Identifier zugewiesen hat. |
QMqttServerConnectionProperties::MaximumTopicAlias | 0x00000080 | Gibt die maximale Anzahl der Themen-Aliase an. |
QMqttServerConnectionProperties::ReasonString | 0x00000100 | Gibt eine Zeichenkette an, die weitere Details zum Verbindungsstatus liefert. |
QMqttServerConnectionProperties::UserProperty | 0x00000200 | Legt zusätzliche Benutzereigenschaften fest. |
QMqttServerConnectionProperties::WildCardSupported | 0x00000400 | Gibt an, ob der Server Wildcard-Abonnements unterstützt. |
QMqttServerConnectionProperties::SubscriptionIdentifierSupport | 0x00000800 | Gibt an, ob der Server Abonnementbezeichner unterstützt. |
QMqttServerConnectionProperties::SharedSubscriptionSupport | 0x00001000 | Gibt an, ob der Server gemeinsame Abonnements unterstützt. |
QMqttServerConnectionProperties::ServerKeepAlive | 0x00002000 | Gibt die Anzahl der Sekunden an, die der Server ein Keep-Alive-Paket vom Client erwartet. |
QMqttServerConnectionProperties::ResponseInformation | 0x00004000 | Gibt die Antwortinformationen an. |
QMqttServerConnectionProperties::ServerReference | 0x00008000 | Gibt eine alternative Serveradresse an, mit der sich der Client verbinden soll. |
QMqttServerConnectionProperties::AuthenticationMethod | 0x00010000 | Legt die Authentifizierungsmethode fest. |
QMqttServerConnectionProperties::AuthenticationData | 0x00020000 | Legt die Authentifizierungsdaten fest. |
Der Typ ServerPropertyDetails ist ein Typedef für QFlags<ServerPropertyDetail>. Er speichert eine OR-Kombination von ServerPropertyDetail-Werten.
Dokumentation der Mitgliedsfunktionen
QMqttServerConnectionProperties::ServerPropertyDetails QMqttServerConnectionProperties::availableProperties() const
Gibt die vom Server angegebenen verfügbaren Eigenschaften zurück.
bool QMqttServerConnectionProperties::clientIdAssigned() const
Gibt true zurück, wenn der Server dem Client eine neue Client-Kennung zugewiesen hat.
Siehe auch QMqttClient::clientId().
bool QMqttServerConnectionProperties::isValid() const
Gibt true zurück, wenn der Server Eigenschaften als Teil der Verbindungsbestätigung bereitgestellt hat. Gibt false zurück, wenn keine Eigenschaften bereitgestellt wurden.
quint8 QMqttServerConnectionProperties::maximumQoS() const
Gibt die maximale QoS-Stufe zurück, die der Server für die Veröffentlichung von Nachrichten unterstützt. Das Veröffentlichen von Nachrichten mit einem QoS-Level, der den vom Server gemeldeten maximalen QoS-Level überschreitet, stellt eine Protokollverletzung dar.
Wenn der Client QoS 1 oder QoS 2 nicht unterstützen muss, sollte er den maximalen QoS-Level in jedem Abonnement, das er abschließt, auf einen Wert beschränken, den er unterstützen kann; der Server würde dann Nachrichten mit dem Maximum der unterstützten und beschränkten QoS-Level veröffentlichen.
Der Standardwert ist 2.
Siehe auch QMqttClient::publish() und QMqttClient::subscribe().
QString QMqttServerConnectionProperties::reason() const
Gibt die mit dieser Antwort verbundene Grundzeichenkette zurück.
QMqtt::ReasonCode QMqttServerConnectionProperties::reasonCode() const
Gibt den mit dieser Antwort verbundenen Grundcode zurück.
QString QMqttServerConnectionProperties::responseInformation() const
Gibt die Antwortinformationen zurück.
bool QMqttServerConnectionProperties::retainAvailable() const
Gibt true zurück, wenn der Server zurückgehaltene Nachrichten annimmt. Der Standardwert ist true.
quint16 QMqttServerConnectionProperties::serverKeepAlive() const
Gibt die Anzahl der Sekunden zurück, die der Server als Keep Alive angefordert hat. Dies überschreibt die von der Client-Seite eingestellte Überlebenszeit.
Siehe auch QMqttClient::setKeepAlive().
QString QMqttServerConnectionProperties::serverReference() const
Gibt eine Serveradresse zurück, die vom Client alternativ für die Verbindung verwendet werden kann. In der Regel wird dies zusammen mit dem Grundcode 0x9c (Use another server) oder 0x9c (Server moved) verwendet.
bool QMqttServerConnectionProperties::sharedSubscriptionSupported() const
Gibt true zurück, wenn der Server gemeinsame Abonnements akzeptiert. Der Standardwert ist true.
bool QMqttServerConnectionProperties::subscriptionIdentifierSupported() const
Gibt true zurück, wenn der Server Abonnementkennungen akzeptiert. Abonnementkennungen können bei der Erstellung eines neuen Abonnements an den Server übergeben werden.
Der Standardwert ist true.
Siehe auch QMqttSubscriptionProperties::setSubscriptionIdentifier().
bool QMqttServerConnectionProperties::wildcardSupported() const
Gibt true zurück, wenn der Server Abonnements einschließlich Wildcards akzeptiert. Der Standardwert ist true.
© 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.
