QMqttClient Class
La clase QMqttClient representa el punto de acceso central que se comunica con un broker MQTT. Más información...
| Encabezado: | #include <QMqttClient> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS Mqtt) target_link_libraries(mytarget PRIVATE Qt6::Mqtt) |
| qmake: | QT += mqtt |
| Heredado de: | QObject |
Tipos públicos
| enum | ClientError { NoError, InvalidProtocolVersion, IdRejected, ServerUnavailable, BadUsernameOrPassword, …, Mqtt5SpecificError } |
| enum | ClientState { Disconnected, Connecting, Connected } |
| enum | ProtocolVersion { MQTT_3_1, MQTT_3_1_1, MQTT_5_0 } |
| enum | TransportType { IODevice, AbstractSocket, SecureSocket, WebSocket, SecureWebSocket } |
Propiedades
|
|
Funciones públicas
| QMqttClient(QObject *parent = nullptr) | |
| virtual | ~QMqttClient() override |
| void | authenticate(const QMqttAuthenticationProperties &prop) |
| bool | autoKeepAlive() const |
| bool | cleanSession() const |
| QString | clientId() const |
| void | connectToHost() |
| void | connectToHostEncrypted(const QSslConfiguration &conf) |
(since 6.10) void | connectToHostWebSocket(QWebSocket *webSocket = nullptr) |
(since 6.10) void | connectToHostWebSocketEncrypted(QWebSocket *webSocket = nullptr) |
| QMqttConnectionProperties | connectionProperties() const |
| void | disconnectFromHost() |
| QMqttClient::ClientError | error() const |
| QString | hostname() const |
| quint16 | keepAlive() const |
| QMqttLastWillProperties | lastWillProperties() const |
| QString | password() const |
| quint16 | port() const |
| QMqttClient::ProtocolVersion | protocolVersion() const |
| qint32 | publish(const QMqttTopicName &topic, const QByteArray &message = QByteArray(), quint8 qos = 0, bool retain = false) |
| qint32 | publish(const QMqttTopicName &topic, const QMqttPublishProperties &properties, const QByteArray &message = QByteArray(), quint8 qos = 0, bool retain = false) |
| bool | requestPing() |
| QMqttServerConnectionProperties | serverConnectionProperties() const |
| void | setConnectionProperties(const QMqttConnectionProperties &prop) |
| void | setLastWillProperties(const QMqttLastWillProperties &prop) |
| void | setTransport(QIODevice *device, QMqttClient::TransportType transport) |
| QMqttClient::ClientState | state() const |
| QMqttSubscription * | subscribe(const QMqttTopicFilter &topic, quint8 qos = 0) |
| QMqttSubscription * | subscribe(const QMqttTopicFilter &topic, const QMqttSubscriptionProperties &properties, quint8 qos = 0) |
| QIODevice * | transport() const |
| void | unsubscribe(const QMqttTopicFilter &topic) |
| void | unsubscribe(const QMqttTopicFilter &topic, const QMqttUnsubscriptionProperties &properties) |
| QString | username() const |
| QByteArray | willMessage() const |
| quint8 | willQoS() const |
| bool | willRetain() const |
| QString | willTopic() const |
Ranuras públicas
| void | setAutoKeepAlive(bool autoKeepAlive) |
| void | setCleanSession(bool cleanSession) |
| void | setClientId(const QString &clientId) |
| void | setError(QMqttClient::ClientError error) |
| void | setHostname(const QString &hostname) |
| void | setKeepAlive(quint16 keepAlive) |
| void | setPassword(const QString &password) |
| void | setPort(quint16 port) |
| void | setProtocolVersion(QMqttClient::ProtocolVersion protocolVersion) |
| void | setState(QMqttClient::ClientState state) |
| void | setUsername(const QString &username) |
| void | setWillMessage(const QByteArray &willMessage) |
| void | setWillQoS(quint8 willQoS) |
| void | setWillRetain(bool willRetain) |
| void | setWillTopic(const QString &willTopic) |
Señales
| void | authenticationFinished(const QMqttAuthenticationProperties &p) |
| void | authenticationRequested(const QMqttAuthenticationProperties &p) |
| void | autoKeepAliveChanged(bool autoKeepAlive) |
| void | brokerSessionRestored() |
| void | cleanSessionChanged(bool cleanSession) |
| void | clientIdChanged(QString clientId) |
| void | connected() |
| void | disconnected() |
| void | errorChanged(QMqttClient::ClientError error) |
| void | hostnameChanged(QString hostname) |
| void | keepAliveChanged(quint16 keepAlive) |
| void | messageReceived(const QByteArray &message, const QMqttTopicName &topic = QMqttTopicName()) |
| void | messageSent(qint32 id) |
| void | messageStatusChanged(qint32 id, QMqtt::MessageStatus s, const QMqttMessageStatusProperties &properties) |
| void | passwordChanged(QString password) |
| void | pingResponseReceived() |
| void | portChanged(quint16 port) |
| void | protocolVersionChanged(QMqttClient::ProtocolVersion protocolVersion) |
| void | stateChanged(QMqttClient::ClientState state) |
| void | usernameChanged(QString username) |
| void | willMessageChanged(QByteArray willMessage) |
| void | willQoSChanged(quint8 willQoS) |
| void | willRetainChanged(bool willRetain) |
| void | willTopicChanged(QString willTopic) |
Descripción detallada
Un cliente MQTT es un programa o dispositivo que utiliza MQTT para establecer una conexión de red con un servidor MQTT, también denominado «broker». La solicitud de conexión debe contener un identificador de cliente único. Opcionalmente, puede incluir un «Will Topic», un «Will Message», un nombre de usuario y una contraseña.
Una vez establecida la conexión, un cliente puede enviar mensajes que puedan interesar a otros clientes, suscribirse para recibir notificaciones sobre temas, darse de baja para eliminar una solicitud de notificaciones y desconectarse del broker.
Documentación sobre tipos de miembros
enum QMqttClient::ClientError
Este tipo de enumeración especifica el estado de error de un cliente.
| Constante | Valor | Descripción |
|---|---|---|
QMqttClient::NoError | 0 | No se ha producido ningún error. |
QMqttClient::InvalidProtocolVersion | 1 | El broker no acepta una conexión que utilice la versión del protocolo especificada. |
QMqttClient::IdRejected | 2 | El ID del cliente tiene un formato incorrecto. Esto podría estar relacionado con su longitud. |
QMqttClient::ServerUnavailable | 3 | Se ha establecido la conexión de red, pero el servicio no está disponible por parte del bróker. |
QMqttClient::BadUsernameOrPassword | 4 | Los datos del nombre de usuario o la contraseña tienen un formato incorrecto. |
QMqttClient::NotAuthorized | 5 | El cliente no está autorizado a conectarse. |
QMqttClient::TransportInvalid | 256 | El transporte subyacente ha provocado un error. Por ejemplo, es posible que la conexión se haya interrumpido de forma inesperada. |
QMqttClient::ProtocolViolation | 257 | El cliente ha detectado una infracción del protocolo y, por lo tanto, ha cerrado la conexión. |
QMqttClient::UnknownError | 258 | Se ha producido un error desconocido. |
QMqttClient::Mqtt5SpecificError | 259 | El error está relacionado con el nivel 5 del protocolo MQTT. Es posible que un código de motivo proporcione más detalles. |
enum QMqttClient::ClientState
Este tipo de enumeración especifica los estados en los que puede entrar un cliente.
| Constante | Valor | Descripción |
|---|---|---|
QMqttClient::Disconnected | 0 | El cliente está desconectado del bróker. |
QMqttClient::Connecting | 1 | Se ha realizado una solicitud de conexión, pero el bróker aún no ha autorizado la conexión. |
QMqttClient::Connected | 2 | El cliente está conectado al bróker. |
enum QMqttClient::ProtocolVersion
Esta enumeración especifica la versión del protocolo del estándar MQTT que se debe utilizar durante la comunicación con un broker.
| Constante | Valor | Descripción |
|---|---|---|
QMqttClient::MQTT_3_1 | 3 | Estándar MQTT 3.1 |
QMqttClient::MQTT_3_1_1 | 4 | Estándar MQTT 3.1.1, conocido públicamente como versión 4 |
QMqttClient::MQTT_5_0 | 5 | Estándar MQTT 5.0 |
enum QMqttClient::TransportType
Este tipo de enumeración especifica el método de conexión que se utilizará para establecer una conexión con un broker.
| Constante | Valor | Descripción |
|---|---|---|
QMqttClient::IODevice | 0 | El transporte utiliza una clase basada en un ` QIODevice`. |
QMqttClient::AbstractSocket | 1 | El transporte utiliza una clase basada en un ` QAbstractSocket`. |
QMqttClient::SecureSocket | 2 | El transporte utiliza una clase basada en un ` QSslSocket`. |
QMqttClient::WebSocket (since Qt 6.10) | 3 | El transporte utiliza una clase basada en un ` QIODevice`, que a su vez utiliza internamente un ` QWebSocket `. |
QMqttClient::SecureWebSocket (since Qt 6.10) | 4 | El transporte utiliza una clase basada en una « QIODevice », que utiliza internamente un « QWebSocket » seguro. |
Documentación de propiedades
autoKeepAlive : bool
Esta propiedad determina si el cliente gestionará automáticamente los mensajes de mantenimiento de conexión con el servidor.
Si esta propiedad está establecida en « true », el cliente enviará automáticamente un mensaje de ping al servidor en el intervalo « keepAlive ».
De lo contrario, el usuario deberá invocar manualmente ` requestPing ` dentro del intervalo especificado para la conexión. Si no se ha enviado ningún ping dentro de dicho intervalo, el servidor se desconectará.
El valor predeterminado de esta propiedad es true.
Funciones de acceso:
| bool | autoKeepAlive() const |
| void | setAutoKeepAlive(bool autoKeepAlive) |
Señal de notificación:
| void | autoKeepAliveChanged(bool autoKeepAlive) |
Véase también keepAlive(), requestPing(), serverConnectionProperties() y pingResponseReceived().
cleanSession : bool
Esta propiedad almacena el estado tras conectarse a un broker.
Funciones de acceso:
| bool | cleanSession() const |
| void | setCleanSession(bool cleanSession) |
Señal de notificador:
| void | cleanSessionChanged(bool cleanSession) |
clientId : QString
Esta propiedad contiene el valor del identificador del cliente.
Cada cliente debe tener un ID único para poder conectarse a un bróker MQTT. Si el usuario no especifica ningún ID de cliente, se generará uno automáticamente al establecer la conexión.
Funciones de acceso:
| QString | clientId() const |
| void | setClientId(const QString &clientId) |
Señal de notificación:
| void | clientIdChanged(QString clientId) |
error : ClientError
Especifica el error actual del cliente.
Funciones de acceso:
| QMqttClient::ClientError | error() const |
| void | setError(QMqttClient::ClientError error) |
Señal del notificador:
| void | errorChanged(QMqttClient::ClientError error) |
hostname : QString
Esta propiedad contiene el nombre de host del bróker MQTT al que conectarse.
Si no se especifica ningún transporte mediante setTransport(), el cliente creará él mismo una conexión de socket con el nombre de host especificado.
Funciones de acceso:
| QString | hostname() const |
| void | setHostname(const QString &hostname) |
Señal del notificador:
| void | hostnameChanged(QString hostname) |
keepAlive : quint16
Esta propiedad determina el intervalo con el que se envían mensajes «ping» periódicos al broker.
Una vez establecida la conexión con un broker, el cliente debe enviar actualizaciones frecuentes para indicar que sigue estando disponible. El intervalo entre dichas actualizaciones viene especificado por esta propiedad.
El intervalo se especifica en segundos.
Si el broker no responde dentro de un periodo de gracia, se cerrará la conexión.
Funciones de acceso:
| quint16 | keepAlive() const |
| void | setKeepAlive(quint16 keepAlive) |
Señal del notificador:
| void | keepAliveChanged(quint16 keepAlive) |
Véanse también autoKeepAlive(), requestPing() y pingResponseReceived().
password : QString
Esta propiedad contiene la contraseña para conectarse a un bróker.
Funciones de acceso:
| QString | password() const |
| void | setPassword(const QString &password) |
Señal de notificación:
| void | passwordChanged(QString password) |
port : quint16
Esta propiedad indica el puerto al que conectarse con el broker MQTT.
Si no se especifica ningún protocolo de transporte mediante ` setTransport()`, el cliente establecerá una conexión de socket con un host que utilice este número de puerto.
Funciones de acceso:
| quint16 | port() const |
| void | setPort(quint16 port) |
Señal de notificación:
| void | portChanged(quint16 port) |
protocolVersion : ProtocolVersion
Esta propiedad indica la versión del estándar MQTT que se debe utilizar para las conexiones.
Especifica la versión del estándar que utiliza el cliente para conectarse a un bróker. Los valores válidos son:
- 3: versión 3.1 del estándar MQTT.
- 4: versión 3.1.1 del estándar MQTT, a menudo denominada MQTT 4.
- 5: Estándar MQTT 5.0.
Funciones de acceso:
| QMqttClient::ProtocolVersion | protocolVersion() const |
| void | setProtocolVersion(QMqttClient::ProtocolVersion protocolVersion) |
Señal de notificación:
| void | protocolVersionChanged(QMqttClient::ProtocolVersion protocolVersion) |
state : ClientState
Esta propiedad contiene el estado actual del cliente.
Funciones de acceso:
| QMqttClient::ClientState | state() const |
| void | setState(QMqttClient::ClientState state) |
Señal de notificador:
| void | stateChanged(QMqttClient::ClientState state) |
username : QString
Esta propiedad contiene el nombre de usuario para conectarse a un broker.
Funciones de acceso:
| QString | username() const |
| void | setUsername(const QString &username) |
Señal de notificador:
| void | usernameChanged(QString username) |
willMessage : QByteArray
Esta propiedad contiene la carga útil de un mensaje «Will».
Funciones de acceso:
| QByteArray | willMessage() const |
| void | setWillMessage(const QByteArray &willMessage) |
Señal de notificador:
| void | willMessageChanged(QByteArray willMessage) |
willQoS : quint8
Esta propiedad define el nivel de calidad de servicio (QoS) para el envío y el almacenamiento del mensaje «Will».
Funciones de acceso:
| quint8 | willQoS() const |
| void | setWillQoS(quint8 willQoS) |
Señal de notificación:
| void | willQoSChanged(quint8 willQoS) |
willRetain : bool
Esta propiedad determina si el mensaje «Will» debe conservarse en el broker para que lo reciban los futuros suscriptores.
Funciones de acceso:
| bool | willRetain() const |
| void | setWillRetain(bool willRetain) |
Señal de notificación:
| void | willRetainChanged(bool willRetain) |
willTopic : QString
Esta propiedad contiene el tema «Will».
Funciones de acceso:
| QString | willTopic() const |
| void | setWillTopic(const QString &willTopic) |
Señal de notificación:
| void | willTopicChanged(QString willTopic) |
Documentación de las funciones de miembro
[explicit] QMqttClient::QMqttClient(QObject *parent = nullptr)
Crea una nueva instancia de cliente MQTT con el parent especificado.
[override virtual noexcept] QMqttClient::~QMqttClient()
Elimina un cliente MQTT. Si el cliente MQTT aún no se había desconectado del broker MQTT, se desconectará automáticamente.
Nota: Si se especifica un transporte con ` setTransport `, este debe ser válido en este momento.
void QMqttClient::authenticate(const QMqttAuthenticationProperties &prop)
Envía una solicitud de autenticación al broker. prop especifica la información necesaria para completar la solicitud de autenticación.
Esta función solo debe invocarse después de que se haya emitido una señal « QMqttClient::authenticationRequested ».
Nota: La autenticaciónampliada forma parte del estándar MQTT 5.0 y solo se puede utilizar cuando el cliente especifica MQTT_5_0 como ProtocolVersion.
Véase también authenticationRequested() y authenticationFinished().
[signal] void QMqttClient::authenticationFinished(const QMqttAuthenticationProperties &p)
Esta señal se emite una vez finalizada la autenticación ampliada. p ofrece información detallada sobre el proceso de autenticación.
Una vez completada con éxito la autenticación, se emite QMqttClient::connected.
Nota: La autenticaciónampliada forma parte del estándar MQTT 5.0 y solo se puede utilizar cuando el cliente especifica MQTT_5_0 como ProtocolVersion.
Véase también authenticationRequested() y authenticate().
[signal] void QMqttClient::authenticationRequested(const QMqttAuthenticationProperties &p)
Esta señal se emite después de que un cliente haya invocado QMqttClient::connectToHost o QMqttClient::connectToHostEncrypted y antes de que se establezca la conexión. En la autenticación ampliada, un broker puede solicitar datos adicionales que deben proporcionarse invocando QMqttClient::authenticate. p especifica las propiedades proporcionadas por el broker.
Nota: La autenticaciónampliada forma parte del estándar MQTT 5.0 y solo se puede utilizar cuando el cliente especifica MQTT_5_0 como ProtocolVersion.
Véase también authenticationFinished() y authenticate().
[signal] void QMqttClient::brokerSessionRestored()
Esta señal se emite después de que un cliente se haya conectado correctamente a un broker con la propiedad ` cleanSession ` establecida en ` false`, y el broker haya restablecido la sesión.
Las sesiones se pueden restablecer si un cliente se ha conectado anteriormente utilizando el mismo clientId.
[invokable] void QMqttClient::connectToHost()
Inicia una conexión con el servidor MQTT.
Nota: Esta función se puede invocar a través del sistema de metaobjetos y desde QML. Véase Q_INVOKABLE.
void QMqttClient::connectToHostEncrypted(const QSslConfiguration &conf)
Inicia una conexión cifrada con el servidor MQTT.
conf Especifica la configuración SSL que se utilizará para la conexión.
[invokable, since 6.10] void QMqttClient::connectToHostWebSocket(QWebSocket *webSocket = nullptr)
Establece un tipo de transporte WebSocket e inicia una conexión con el broker MQTT. Se sustituye el tipo de transporte anterior. Si se especifica webSocket, se ignoran el nombre de host y el puerto, y la conexión se establece mediante ese WebSocket. El WebSocket es propiedad del código que realiza la llamada y debe ser válido durante toda la vida útil del objeto QMqttClient.
Nota: Esta función se puede invocar a través del sistema de metaobjetos y desde QML. Véase Q_INVOKABLE.
Esta función se introdujo en Qt 6.10.
[invokable, since 6.10] void QMqttClient::connectToHostWebSocketEncrypted(QWebSocket *webSocket = nullptr)
Establece un tipo de transporte WebSocket seguro e inicia una conexión con el broker MQTT. Se sustituye el tipo de transporte anterior. Si se especifica ` webSocket `, se ignoran el nombre de host y el puerto, y la conexión se establece mediante ese WebSocket. El objeto `webSocket` es propiedad del código que lo invoca y debe ser válido durante toda la vida útil del objeto ` QMqttClient `.
Nota: Esta función se puede invocar a través del sistema de metaobjetos y desde QML. Véase Q_INVOKABLE.
Esta función se introdujo en Qt 6.10.
[signal] void QMqttClient::connected()
Esta señal se emite cuando se ha establecido una conexión.
QMqttConnectionProperties QMqttClient::connectionProperties() const
Devuelve al broker las propiedades de conexión que solicita el cliente.
Nota: La función « QMqttConnectionProperties » solo se puede utilizar cuando el cliente especifica « MQTT_5_0 » como « ProtocolVersion ».
Véase también setConnectionProperties().
[invokable] void QMqttClient::disconnectFromHost()
Se desconecta del servidor MQTT.
Nota: Esta función se puede invocar a través del sistema de metaobjetos y desde QML. Véase Q_INVOKABLE.
[signal] void QMqttClient::disconnected()
Esta señal se emite cuando se ha cerrado una conexión. Una conexión puede cerrarse al llamar a ` disconnectFromHost()` o cuando el broker se desconecta.
QMqttLastWillProperties QMqttClient::lastWillProperties() const
Devuelve las propiedades de la última voluntad.
Nota: La función ` QMqttLastWillProperties ` solo se puede utilizar cuando el cliente especifica ` MQTT_5_0 ` como ` ProtocolVersion`.
Véase también setLastWillProperties().
[signal] void QMqttClient::messageReceived(const QByteArray &message, const QMqttTopicName &topic = QMqttTopicName())
Esta señal se emite cuando se ha recibido un nuevo mensaje. La categoría del mensaje viene especificada por topic, y el contenido es message.
[signal] void QMqttClient::messageSent(qint32 id)
Indica que el broker ha recibido un mensaje enviado mediante la función ` publish()`. El ` id ` es el mismo que el devuelto por ` publish() `, lo que facilita el seguimiento del estado del mensaje.
[signal] void QMqttClient::messageStatusChanged(qint32 id, QMqtt::MessageStatus s, const QMqttMessageStatusProperties &properties)
Esta señal se emite cuando cambia el estado del mensaje identificado por id. s especifica el nuevo estado del mensaje, y properties especifica propiedades adicionales proporcionadas por el servidor.
[signal] void QMqttClient::pingResponseReceived()
Esta señal se emite después de que el bróker responda a una llamada « requestPing()» o a un mensaje de ping « keepAlive()», y la conexión siga siendo válida.
[invokable] qint32 QMqttClient::publish(const QMqttTopicName &topic, const QByteArray &message = QByteArray(), quint8 qos = 0, bool retain = false)
Publica un « message » en el broker con el « topic » especificado. « qos » especifica el nivel de calidad de servicio (QoS) requerido para la transferencia del mensaje.
Si retain se establece en true, el mensaje permanecerá en el broker para que otros clientes puedan conectarse y recibirlo.
Devuelve un ID que se utiliza internamente para identificar el mensaje.
Nota: Esta función se puede invocar a través del sistema de metaobjetos y desde QML. Véase Q_INVOKABLE.
[invokable] qint32 QMqttClient::publish(const QMqttTopicName &topic, const QMqttPublishProperties &properties, const QByteArray &message = QByteArray(), quint8 qos = 0, bool retain = false)
Publica un « message » en el broker con los valores especificados « properties » y « topic ». « qos » especifica el nivel de calidad de servicio (QoS) requerido para la transferencia del mensaje.
Si retain se establece en true, el mensaje permanecerá en el broker para que otros clientes puedan conectarse y recibirlo.
Devuelve un ID que se utiliza internamente para identificar el mensaje.
Nota: properties solo se enviará al broker cuando el cliente especifique MQTT_5_0 como ProtocolVersion.
Nota: Esta función se puede invocar a través del sistema de metaobjetos y desde QML. Véase Q_INVOKABLE.
bool QMqttClient::requestPing()
Envía un mensaje «ping» al bróker y espera una respuesta.
Si la conexión está activa y autoKeepAlive es true, la llamada a esta función fallará, ya que el cliente es el responsable de gestionar este proceso.
El uso manual de ` requestPing() ` requiere una llamada cada vez dentro del intervalo ` keepAlive ` mientras la conexión esté activa.
Para comprobar si el ping se ha realizado con éxito, conéctate a la señal pingResponseReceived().
Devuelve ` true ` si se ha podido enviar la solicitud de ping.
Véase también pingResponseReceived(), autoKeepAlive() y keepAlive().
QMqttServerConnectionProperties QMqttClient::serverConnectionProperties() const
Devuelve el objeto ` QMqttServerConnectionProperties ` que el broker ha devuelto tras un intento de conexión.
Esto puede utilizarse para verificar que el bróker ha aceptado las propiedades de conexión del lado del cliente establecidas mediante ` QMqttClient::setConnectionProperties `. Además, en caso de que falle un intento de conexión, puede utilizarse para realizar un diagnóstico de la conexión.
Nota: QMqttServerConnectionProperties solo se puede utilizar cuando el cliente especifica MQTT_5_0 como ProtocolVersion.
Véase también connectionProperties().
void QMqttClient::setConnectionProperties(const QMqttConnectionProperties &prop)
Establece las propiedades de conexión en « prop ». Se puede utilizar « QMqttConnectionProperties » para solicitar al servidor que utilice un conjunto específico de funciones. Tras una solicitud de conexión, se puede obtener la respuesta del servidor llamando a « QMqttClient::serverConnectionProperties ».
Nota: Las propiedades de conexión solo se pueden configurar si el cliente MQTT se encuentra en el estado Disconnected.
Nota: « QMqttConnectionProperties » solo se puede utilizar cuando el cliente especifica « MQTT_5_0 » como « ProtocolVersion ».
Véase también connectionProperties().
void QMqttClient::setLastWillProperties(const QMqttLastWillProperties &prop)
Establece las propiedades del mensaje de última voluntad en « prop ». « QMqttLastWillProperties » permite configurar características adicionales para el mensaje de última voluntad almacenado en el broker.
Nota: Las propiedades de conexión solo se pueden configurar si el cliente MQTT se encuentra en el estado « Disconnected ».
Nota: « QMqttLastWillProperties » solo se puede utilizar cuando el cliente especifica « MQTT_5_0 » como « ProtocolVersion ».
Véase también lastWillProperties().
void QMqttClient::setTransport(QIODevice *device, QMqttClient::TransportType transport)
Establece el transporte en « device ». Un transporte puede ser de tipo socket o derivado de « QIODevice », y se especifica mediante « transport ».
Nota: El transporte solo se puede cambiar si el cliente MQTT se encuentra en el estado « Disconnected ».
Nota: Establecer un transporte personalizado para un cliente no transfiere la responsabilidad sobre la gestión de la conexión ni la titularidad. El transporte debe estar abierto para los transportes basados en « QIODevice » o conectado para los transportes de tipo socket antes de llamar a QMqttClient::connectToHost().
Véase también transport().
QMqttSubscription *QMqttClient::subscribe(const QMqttTopicFilter &topic, quint8 qos = 0)
Añade una nueva suscripción para recibir notificaciones en topic. El parámetro qos especifica el nivel al que se reciben los mensajes de seguridad. Para obtener más información sobre los niveles de calidad de servicio (QoS) disponibles, consulta «Calidad de servicio».
Esta función devuelve un puntero a un objeto ` QMqttSubscription`. Si se suscribe dos veces al mismo tema, el valor devuelto apunta a la misma instancia de suscripción. El cliente MQTT es el propietario de la suscripción.
QMqttSubscription *QMqttClient::subscribe(const QMqttTopicFilter &topic, const QMqttSubscriptionProperties &properties, quint8 qos = 0)
Añade una nueva suscripción para recibir notificaciones en topic. El parámetro properties especifica propiedades adicionales de la suscripción que debe validar el bróker. El parámetro qos especifica el nivel al que se reciben los mensajes de seguridad. Para obtener más información sobre los niveles de calidad de servicio (QoS) disponibles, consulta «Calidad de servicio».
Esta función devuelve un puntero a un objeto ` QMqttSubscription`. Si se suscribe dos veces al mismo tema, el valor devuelto apunta a la misma instancia de suscripción. El cliente MQTT es el propietario de la suscripción.
Nota: El objeto « properties » solo se transmitirá al broker cuando el cliente especifique « MQTT_5_0 » como « ProtocolVersion ».
QIODevice *QMqttClient::transport() const
Devuelve el transporte utilizado para la comunicación con el broker.
Véase también setTransport().
void QMqttClient::unsubscribe(const QMqttTopicFilter &topic)
Se da de baja de topic. No se enviarán notificaciones a ninguna de las suscripciones realizadas mediante la llamada a subscribe().
Nota: Si un cliente se desconecta de un broker sin darse de baja, el broker almacenará todos los mensajes y los publicará en la siguiente reconexión.
void QMqttClient::unsubscribe(const QMqttTopicFilter &topic, const QMqttUnsubscriptionProperties &properties)
Se da de baja de topic. No se enviarán notificaciones a ninguna de las suscripciones realizadas mediante la llamada a subscribe(). properties especifica propiedades de usuario adicionales que se pasarán al bróker.
Nota: Si un cliente se desconecta de un bróker sin darse de baja, el bróker almacenará todos los mensajes y los publicará en la próxima reconexión.
Nota: properties solo se pasará al bróker cuando el cliente especifique MQTT_5_0 como ProtocolVersion.
© 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.