QMqttServerConnectionProperties Class
La clase `QMqttServerConnectionProperties` representa las opciones de configuración de un servidor al que está conectado un ` QMqttClient `. Más información...
| Encabezado: | #include <QMqttServerConnectionProperties> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS Mqtt) target_link_libraries(mytarget PRIVATE Qt6::Mqtt) |
| qmake: | QT += mqtt |
| Heredado de: | QMqttConnectionProperties |
Tipos públicos
| enum | ServerPropertyDetail { None, SessionExpiryInterval, MaximumReceive, MaximumQoS, RetainAvailable, …, AuthenticationData } |
| flags | ServerPropertyDetails |
Funciones públicas
| 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 |
Descripción detallada
Una vez establecida la conexión, el servidor puede enviar detalles adicionales sobre las propiedades de la conexión. Utiliza availableProperties() para identificar las propiedades establecidas por el servidor. Si el servidor no ha establecido una propiedad, se asumen valores por defecto, que pueden obtenerse invocando las funciones de acceso de esta instancia.
Nota: Las propiedadesde conexión forman parte de la especificación MQTT 5.0 y no se pueden utilizar al conectarse con un nivel de protocolo inferior. Consulte QMqttClient::ProtocolVersion para obtener más información.
Documentación sobre tipos de miembros
enum QMqttServerConnectionProperties::ServerPropertyDetail
flags QMqttServerConnectionProperties::ServerPropertyDetails
Este tipo de enumeración especifica las propiedades disponibles que establece el servidor o el cliente tras establecer una conexión.
| Constante | Valor | Descripción |
|---|---|---|
QMqttServerConnectionProperties::None | 0x00000000 | No se ha especificado ninguna propiedad. |
QMqttServerConnectionProperties::SessionExpiryInterval | 0x00000001 | El número de segundos que el servidor mantiene la sesión tras una desconexión. |
QMqttServerConnectionProperties::MaximumReceive | 0x00000002 | El número máximo de mensajes de QoS 1 y 2 que el servidor es capaz de gestionar simultáneamente. |
QMqttServerConnectionProperties::MaximumQoS | 0x00000004 | El nivel máximo de QoS que el servidor puede interpretar. |
QMqttServerConnectionProperties::RetainAvailable | 0x00000010 | Especifica si se admiten los mensajes retenidos. |
QMqttServerConnectionProperties::MaximumPacketSize | 0x00000020 | Especifica el tamaño máximo de paquete, incluyendo la cabecera del mensaje y las propiedades. |
QMqttServerConnectionProperties::AssignedClientId | 0x00000040 | Especifica si el servidor ha asignado un identificador de cliente. |
QMqttServerConnectionProperties::MaximumTopicAlias | 0x00000080 | Especifica el número máximo de alias de temas. |
QMqttServerConnectionProperties::ReasonString | 0x00000100 | Especifica una cadena que proporciona más detalles sobre el estado de la conexión. |
QMqttServerConnectionProperties::UserProperty | 0x00000200 | Especifica propiedades de usuario adicionales. |
QMqttServerConnectionProperties::WildCardSupported | 0x00000400 | Especifica si el servidor admite suscripciones con comodines. |
QMqttServerConnectionProperties::SubscriptionIdentifierSupport | 0x00000800 | Especifica si el servidor admite identificadores de suscripción. |
QMqttServerConnectionProperties::SharedSubscriptionSupport | 0x00001000 | Especifica si el servidor admite suscripciones compartidas. |
QMqttServerConnectionProperties::ServerKeepAlive | 0x00002000 | Especifica el número de segundos que el servidor espera recibir un paquete de mantenimiento de conexión del cliente. |
QMqttServerConnectionProperties::ResponseInformation | 0x00004000 | Especifica la información de respuesta. |
QMqttServerConnectionProperties::ServerReference | 0x00008000 | Especifica una dirección de servidor alternativa a la que el cliente puede conectarse. |
QMqttServerConnectionProperties::AuthenticationMethod | 0x00010000 | Especifica el método de autenticación. |
QMqttServerConnectionProperties::AuthenticationData | 0x00020000 | Especifica los datos de autenticación. |
El tipo ServerPropertyDetails es una definición de tipo para QFlags<ServerPropertyDetail>. Almacena una combinación OR de valores de ServerPropertyDetail.
Documentación de las funciones de miembro
QMqttServerConnectionProperties::ServerPropertyDetails QMqttServerConnectionProperties::availableProperties() const
Devuelve las propiedades disponibles especificadas por el servidor.
bool QMqttServerConnectionProperties::clientIdAssigned() const
Devuelve ` true ` si el servidor ha asignado un nuevo identificador de cliente al cliente.
Véase también QMqttClient::clientId().
bool QMqttServerConnectionProperties::isValid() const
Devuelve « true » si el servidor ha facilitado propiedades como parte de la confirmación de la conexión. Devuelve « false » si no se ha facilitado ninguna propiedad.
quint8 QMqttServerConnectionProperties::maximumQoS() const
Devuelve el nivel máximo de QoS que admite el servidor para la publicación de mensajes. La publicación de mensajes con un nivel de QoS que supere el nivel máximo indicado por el servidor constituye una infracción del protocolo.
Si el cliente no necesita admitir QoS 1 ni QoS 2, debe limitar el nivel máximo de QoS en cualquier suscripción que realice a un valor que pueda admitir; de este modo, el servidor publicará mensajes con el nivel máximo entre los niveles de QoS admitidos y los restringidos.
El valor por defecto es 2.
Véase también QMqttClient::publish() y QMqttClient::subscribe().
QString QMqttServerConnectionProperties::reason() const
Devuelve la cadena de motivo asociada a esta respuesta.
QMqtt::ReasonCode QMqttServerConnectionProperties::reasonCode() const
Devuelve el código de motivo asociado a esta respuesta.
QString QMqttServerConnectionProperties::responseInformation() const
Devuelve la información de la respuesta.
bool QMqttServerConnectionProperties::retainAvailable() const
Devuelve « true » si el servidor acepta mensajes retenidos. El valor por defecto es « true ».
quint16 QMqttServerConnectionProperties::serverKeepAlive() const
Devuelve el número de segundos que el servidor ha solicitado como tiempo de mantenimiento de la conexión. Esto anula el tiempo de mantenimiento de la conexión establecido desde el lado del cliente.
Véase también QMqttClient::setKeepAlive().
QString QMqttServerConnectionProperties::serverReference() const
Devuelve una dirección de servidor a la que el cliente puede conectarse como alternativa. Normalmente, se utiliza junto con el código de motivo « 0x9c » (Utilizar otro servidor) o « 0x9c » (El servidor se ha trasladado).
bool QMqttServerConnectionProperties::sharedSubscriptionSupported() const
Devuelve « true » si el servidor acepta suscripciones compartidas. El valor por defecto es « true ».
bool QMqttServerConnectionProperties::subscriptionIdentifierSupported() const
Devuelve « true » si el servidor acepta identificadores de suscripción. Los identificadores de suscripción se pueden enviar al servidor al crear una nueva suscripción.
El valor por defecto es true.
Véase también QMqttSubscriptionProperties::setSubscriptionIdentifier().
bool QMqttServerConnectionProperties::wildcardSupported() const
Devuelve « true » si el servidor acepta suscripciones que incluyan comodines. El valor por defecto es « 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.