QMqttPublishProperties Class
La clase QMqttPublishProperties representa las opciones de configuración para enviar o recibir un mensaje. Más información...
| Encabezado: | #include <QMqttPublishProperties> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS Mqtt) target_link_libraries(mytarget PRIVATE Qt6::Mqtt) |
| qmake: | QT += mqtt |
Tipos públicos
| enum | PublishPropertyDetail { None, PayloadFormatIndicator, MessageExpiryInterval, TopicAlias, ResponseTopic, …, ContentType } |
| flags | PublishPropertyDetails |
Funciones públicas
| 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 |
Descripción detallada
Al invocar ` QMqttClient::publish()` para enviar un mensaje a un bróker, se puede incluir `QMqttPublishProperties` para proporcionar argumentos adicionales sobre cómo debe tratarse el mensaje en el bróker.
Además, la recepción de un mensaje por parte de una suscripción instanciada puede contener propiedades de publicación que hayan sido reenviadas o adaptadas por el servidor.
Nota: Las propiedadesde publicación forman parte de la especificación MQTT 5.0 y no se pueden utilizar al conectarse con un nivel de protocolo inferior. Consulta QMqttClient::ProtocolVersion para obtener más información.
Documentación sobre tipos de miembros
enum QMqttPublishProperties::PublishPropertyDetail
flags QMqttPublishProperties::PublishPropertyDetails
Este tipo de enumeración especifica el conjunto de propiedades disponibles que establece el servidor o el cliente al crear un mensaje.
| Constante | Valor | Descripción |
|---|---|---|
QMqttPublishProperties::None | 0x00000000 | No se ha especificado ninguna propiedad. |
QMqttPublishProperties::PayloadFormatIndicator | 0x00000001 | El tipo de contenido del mensaje. |
QMqttPublishProperties::MessageExpiryInterval | 0x00000002 | El tiempo durante el cual un mensaje es válido. |
QMqttPublishProperties::TopicAlias | 0x00000004 | El alias del tema de este mensaje. |
QMqttPublishProperties::ResponseTopic | 0x00000008 | El tema al que debe responder el destinatario. |
QMqttPublishProperties::CorrelationData | 0x00000010 | Un identificador del mensaje de respuesta. |
QMqttPublishProperties::UserProperty | 0x00000020 | Propiedades adicionales establecidas por el usuario. |
QMqttPublishProperties::SubscriptionIdentifier | 0x00000040 | Un identificador de las suscripciones que coinciden con la publicación. |
QMqttPublishProperties::ContentType | 0x00000080 | Una descripción del contenido del mensaje. |
El tipo `PublishPropertyDetails` es una definición de tipo para ` QFlags<PublishPropertyDetail>`. Almacena una combinación OR de valores de `PublishPropertyDetail`.
Documentación de las funciones de miembro
QMqttPublishProperties::PublishPropertyDetails QMqttPublishProperties::availableProperties() const
Devuelve las propiedades disponibles especificadas en esta instancia. Al crear un mensaje, no es necesario incluir todas las propiedades. Esta función sirve para indicar cuáles son las propiedades que se han establecido explícitamente.
QString QMqttPublishProperties::contentType() const
Devuelve el tipo de contenido del mensaje.
Véase también setContentType().
QByteArray QMqttPublishProperties::correlationData() const
Devuelve los datos de correlación.
Véase también setCorrelationData().
quint32 QMqttPublishProperties::messageExpiryInterval() const
Devuelve el intervalo de caducidad del mensaje. Este valor especifica el número de segundos durante los cuales el servidor puede reenviar el mensaje. Si el intervalo caduca, el servidor debe eliminar el mensaje y cancelar su publicación.
Véase también setMessageExpiryInterval().
QMqtt::PayloadFormatIndicator QMqttPublishProperties::payloadFormatIndicator() const
Devuelve el indicador del formato de la carga útil.
Véase también setPayloadFormatIndicator().
QString QMqttPublishProperties::responseTopic() const
Devuelve el tema de respuesta que el usuario debe utilizar como continuación de una solicitud.
Véase también setResponseTopic().
void QMqttPublishProperties::setContentType(const QString &type)
Establece el tipo de contenido del mensaje como « type ».
Véase también contentType().
void QMqttPublishProperties::setCorrelationData(const QByteArray &correlation)
Establece los datos de correlación en correlation.
Véase también correlationData().
void QMqttPublishProperties::setMessageExpiryInterval(quint32 interval)
Establece el intervalo de caducidad de los mensajes en interval.
Véase también messageExpiryInterval().
void QMqttPublishProperties::setPayloadFormatIndicator(QMqtt::PayloadFormatIndicator indicator)
Establece el indicador de formato de la carga útil en « indicator ».
Véase también payloadFormatIndicator().
void QMqttPublishProperties::setResponseTopic(const QString &topic)
Establece el tema de respuesta en « topic ».
Véase también responseTopic().
void QMqttPublishProperties::setSubscriptionIdentifiers(const QList<quint32> &ids)
Establece los identificadores de suscripción en ids.
Véase también subscriptionIdentifiers().
void QMqttPublishProperties::setTopicAlias(quint16 alias)
Establece el alias del tema para publicar un mensaje en alias. El valor del alias del tema debe ser mayor que cero y menor que el alias máximo especificado por el servidor.
Véase también topicAlias() y QMqttServerConnectionProperties::maximumTopicAlias().
void QMqttPublishProperties::setUserProperties(const QMqttUserProperties &properties)
Establece las propiedades de usuario de un mensaje en properties.
Véase también userProperties().
QList<quint32> QMqttPublishProperties::subscriptionIdentifiers() const
Devuelve los identificadores de las suscripciones que coinciden con el filtro de temas del mensaje.
Véase también setSubscriptionIdentifiers().
quint16 QMqttPublishProperties::topicAlias() const
Devuelve el alias del tema utilizado para publicar un mensaje.
Véase también setTopicAlias().
QMqttUserProperties QMqttPublishProperties::userProperties() const
Devuelve las propiedades de usuario de un mensaje.
Véase también 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.