QMqttClient Class

Documentación de la Función Miembro

[explicit] QMqttClient::QMqttClient(QObject *parent = nullptr)

Crea una nueva instancia de cliente MQTT con la dirección parent especificada.

[override virtual noexcept] QMqttClient::~QMqttClient()

Elimina un cliente MQTT. Si el cliente MQTT no estaba ya desconectado del broker MQTT, se desconectará automáticamente.

void QMqttClient::authenticate(const QMqttAuthenticationProperties &prop)

Envía una solicitud de autenticación al intermediario. prop especifica la información necesaria para completar la solicitud de autenticación.

Esta función sólo debe llamarse después de que se haya emitido una señal QMqttClient::authenticationRequested.

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 extendida. p especifica los detalles disponibles sobre el proceso de autenticación.

Tras una autenticación correcta se emite QMqttClient::connected.

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 invoque QMqttClient::connectToHost o QMqttClient::connectToHostEncrypted y antes de que se establezca la conexión. En la autenticación extendida, un broker puede solicitar detalles adicionales que deben ser proporcionados invocando QMqttClient::authenticate. p especifica propiedades proporcionadas por el broker.

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 con éxito a un corredor con la propiedad cleanSession establecida en false, y el corredor haya restaurado la sesión.

Las sesiones se pueden restaurar si un cliente se ha conectado previamente utilizando el mismo clientId.

[invokable] void QMqttClient::connectToHost()

Inicia una conexión con el broker MQTT.

void QMqttClient::connectToHostEncrypted(const QSslConfiguration &conf)

Inicia una conexión cifrada con el broker 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 de socket web e inicia una conexión con el broker MQTT. El tipo de transporte anterior es reemplazado. Si se da webSocket, se ignora el nombre de host y el puerto, y la conexión se realiza con ese websocket. webSocket es propiedad del código que llama, y debe ser válido durante el tiempo de vida del objeto QMqttClient.

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. El tipo de transporte anterior es reemplazado. Si se da webSocket, se ignora el nombre de host y el puerto, y la conexión se realiza con ese websocket. webSocket es propiedad del código que llama, y debe ser válido durante el tiempo de vida del objeto QMqttClient.

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 las propiedades de conexión que el cliente solicita al broker.

Véase también setConnectionProperties().

[invokable] void QMqttClient::disconnectFromHost()

Se desconecta del broker MQTT.

[signal] void QMqttClient::disconnected()

Esta señal se emite cuando se ha cerrado una conexión. Una conexión puede cerrarse cuando se llama a disconnectFromHost() o cuando el broker se desconecta.

QMqttLastWillProperties QMqttClient::lastWillProperties() const

Devuelve las propiedades de la última voluntad.

Véase también setLastWillProperties().

[signal] void QMqttClient::messageReceived(const QByteArray &message, const QMqttTopicName &topic = QMqttTopicName())

Esta señal se emite cuando se recibe un nuevo mensaje. La categoría del mensaje se especifica mediante topic siendo el contenido message.

[signal] void QMqttClient::messageSent(qint32 id)

Indica que un mensaje que fue enviado a través de la función publish() ha sido recibido por el broker. El id es el mismo que devuelve publish() para ayudar a seguir el 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 broker responda a una llamada requestPing() o a un mensaje 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 QoS necesario para transferir el mensaje.

Si retain se establece en true, el mensaje permanecerá en el broker para que otros clientes se conecten y reciban el mensaje.

Devuelve un ID que se utiliza internamente para identificar el mensaje.

[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 properties y topic especificados. qos especifica el nivel de QoS necesario para transferir el mensaje.

Si retain se establece en true, el mensaje permanecerá en el broker para que otros clientes se conecten y reciban el mensaje.

Devuelve un ID que se utiliza internamente para identificar el mensaje.

bool QMqttClient::requestPing()

Envía un mensaje ping al broker y espera una respuesta.

Si la conexión está activa y autoKeepAlive es true, entonces la llamada a esta función fallará ya que el cliente es responsable de gestionar este proceso.

Utilizar requestPing() manualmente requiere una llamada cada vez dentro del intervalo keepAlive mientras la conexión esté activa.

Para comprobar si el ping ha tenido éxito, conéctese 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 QMqttServerConnectionProperties que el broker devolvió después de un intento de conexión.

Esto se puede utilizar para verificar que las propiedades de conexión del lado del cliente establecidas por QMqttClient::setConnectionProperties han sido aceptadas por el broker. Además, en caso de un intento de conexión fallido, puede utilizarse para diagnosticar la conexión.

Véase también connectionProperties().

void QMqttClient::setConnectionProperties(const QMqttConnectionProperties &prop)

Establece las propiedades de conexión en prop. QMqttConnectionProperties puede utilizarse para pedir al servidor que utilice un conjunto de características específico. Después de una solicitud de conexión, la respuesta del servidor se puede obtener llamando a QMqttClient::serverConnectionProperties.

Véase también connectionProperties().

void QMqttClient::setLastWillProperties(const QMqttLastWillProperties &prop)

Establece las propiedades de la última voluntad en prop. QMqttLastWillProperties permite establecer características adicionales para el mensaje de última voluntad almacenado en el broker.

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 en transport.

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 disponibles, consulte Calidad de servicio.

Esta función devuelve un puntero a un QMqttSubscription. Si el mismo tema se suscribe dos veces, el valor de retorno 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 deben ser validadas por el broker. El parámetro qos especifica el nivel en el que se reciben los mensajes de seguridad. Para obtener más información sobre los niveles de calidad de servicio disponibles, consulte Calidad de servicio.

Esta función devuelve un puntero a un QMqttSubscription. Si el mismo tema se suscribe dos veces, el valor de retorno apunta a la misma instancia de suscripción. El cliente MQTT es el propietario de la suscripción.

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 llamando a subscribe().

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 llamando a subscribe(). properties especifica propiedades de usuario adicionales que se pasarán al corredor.