QMqttServerConnectionProperties Class
Die Klasse „QMqttServerConnectionProperties“ repräsentiert die Konfigurationsoptionen eines Servers, mit dem ein „ QMqttClient “ verbunden ist. Mehr...
| Header: | #include <QMqttServerConnectionProperties> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS Mqtt) target_link_libraries(mytarget PRIVATE Qt6::Mqtt) |
| qmake: | QT += mqtt |
| Erbt von: | 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 |
Ausführliche Beschreibung
Wenn eine Verbindung hergestellt wurde, sendet der Server möglicherweise zusätzliche Details zu den Verbindungseigenschaften. Verwenden Sie ` availableProperties()` (), um die vom Server festgelegten Eigenschaften zu ermitteln. Wenn eine Eigenschaft nicht vom Server festgelegt wurde, werden Standardwerte angenommen, die durch Aufruf der Zugriffsfunktionen dieser Instanz abgerufen werden können.
Hinweis: Verbindungseigenschaften sind Teil der MQTT 5.0-Spezifikation und können bei einer Verbindung mit einer niedrigeren Protokollebene nicht verwendet werden. Weitere Informationen finden Sie unter ` QMqttClient::ProtocolVersion `.
Dokumentation zu Mitgliedstypen
enum QMqttServerConnectionProperties::ServerPropertyDetail
flags QMqttServerConnectionProperties::ServerPropertyDetails
Dieser Enum-Typ gibt die verfügbaren Eigenschaften an, die nach dem Aufbau einer Verbindung vom Server oder vom Client festgelegt 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 einer Trennung aufrechterhält. |
QMqttServerConnectionProperties::MaximumReceive | 0x00000002 | Die maximale Anzahl an QoS-1- und QoS-2-Nachrichten, die der Server gleichzeitig verarbeiten kann. |
QMqttServerConnectionProperties::MaximumQoS | 0x00000004 | Die höchste QoS-Stufe, die der Server verarbeiten kann. |
QMqttServerConnectionProperties::RetainAvailable | 0x00000010 | Gibt an, ob gespeicherte Nachrichten unterstützt werden. |
QMqttServerConnectionProperties::MaximumPacketSize | 0x00000020 | Legt die maximale Paketgröße einschließlich Nachrichtenkopf und Eigenschaften fest. |
QMqttServerConnectionProperties::AssignedClientId | 0x00000040 | Gibt an, ob der Server eine Client-Kennung zugewiesen hat. |
QMqttServerConnectionProperties::MaximumTopicAlias | 0x00000080 | Gibt die maximale Anzahl von Themenaliasen an. |
QMqttServerConnectionProperties::ReasonString | 0x00000100 | Gibt eine Zeichenfolge an, die weitere Details zum Verbindungsstatus enthält. |
QMqttServerConnectionProperties::UserProperty | 0x00000200 | Gibt zusätzliche Benutzereigenschaften an. |
QMqttServerConnectionProperties::WildCardSupported | 0x00000400 | Gibt an, ob der Server Wildcard-Abonnements unterstützt. |
QMqttServerConnectionProperties::SubscriptionIdentifierSupport | 0x00000800 | Gibt an, ob der Server Abonnement-Identifikatoren unterstützt. |
QMqttServerConnectionProperties::SharedSubscriptionSupport | 0x00001000 | Gibt an, ob der Server gemeinsam genutzte Abonnements unterstützt. |
QMqttServerConnectionProperties::ServerKeepAlive | 0x00002000 | Gibt die Anzahl der Sekunden an, nach denen der Server ein Keep-Alive-Paket vom Client erwartet. |
QMqttServerConnectionProperties::ResponseInformation | 0x00004000 | Legt die Antwortinformationen fest. |
QMqttServerConnectionProperties::ServerReference | 0x00008000 | Gibt eine alternative Serveradresse an, mit der der Client eine Verbindung herstellen kann. |
QMqttServerConnectionProperties::AuthenticationMethod | 0x00010000 | Legt die Authentifizierungsmethode fest. |
QMqttServerConnectionProperties::AuthenticationData | 0x00020000 | Gibt die Authentifizierungsdaten an. |
Der Typ „ServerPropertyDetails“ ist ein typedef für „QFlags<ServerPropertyDetail>“. Er speichert eine ODER-Kombination von „ServerPropertyDetail“-Werten.
Dokumentation zu den 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-ID zugewiesen hat.
Siehe auch ` QMqttClient::clientId()`.
bool QMqttServerConnectionProperties::isValid() const
Gibt „ true “ zurück, wenn der Server im Rahmen der Verbindungsbestätigung Eigenschaften bereitgestellt hat. Gibt „ false “ zurück, wenn keine Eigenschaften bereitgestellt wurden.
quint8 QMqttServerConnectionProperties::maximumQoS() const
Gibt die höchste QoS-Stufe zurück, die der Server für die Veröffentlichung von Nachrichten unterstützt. Die Veröffentlichung von Nachrichten mit einer QoS-Stufe, die die vom Server gemeldete höchste QoS-Stufe überschreitet, stellt einen Protokollverstoß dar.
Wenn der Client QoS 1 oder QoS 2 nicht unterstützen muss, sollte er die maximale QoS-Stufe in allen von ihm abonnierten Kanälen auf einen Wert beschränken, den er unterstützen kann; der Server würde dann Nachrichten mit der höchsten der unterstützten und der beschränkten QoS-Stufen veröffentlichen.
Der Standardwert ist „ 2 “.
Siehe auch „ QMqttClient::publish()“ und „ QMqttClient::subscribe()“.
QString QMqttServerConnectionProperties::reason() const
Gibt die mit dieser Antwort verknüpfte Begründungszeichenfolge zurück.
QMqtt::ReasonCode QMqttServerConnectionProperties::reasonCode() const
Gibt den zu dieser Antwort gehörenden Fehlercode zurück.
QString QMqttServerConnectionProperties::responseInformation() const
Gibt die Antwortinformationen zurück.
bool QMqttServerConnectionProperties::retainAvailable() const
Gibt „ true “ zurück, wenn der Server zurückbehaltene Nachrichten akzeptiert. Der Standardwert ist „ true “.
quint16 QMqttServerConnectionProperties::serverKeepAlive() const
Gibt die Anzahl der Sekunden zurück, die der Server als Keep-Alive-Zeit angefordert hat. Dies überschreibt die vom Client festgelegte Keep-Alive-Zeit.
Siehe auch ` QMqttClient::setKeepAlive()`.
QString QMqttServerConnectionProperties::serverReference() const
Gibt eine Serveradresse zurück, über die der Client alternativ eine Verbindung herstellen kann. In der Regel wird dies zusammen mit dem Fehlercode „ 0x9c “ (Anderen Server verwenden) oder „ 0x9c “ (Server wurde verschoben) 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 Abonnement-IDs akzeptiert. Abonnement-IDs können beim Anlegen 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 akzeptiert, die Platzhalter enthalten. Der Standardwert ist „ true “.
© 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.
