En esta página

QCoapClient Class

La clase QCoapClient permite a la aplicación enviar solicitudes CoAP y recibir respuestas. Más información...

Encabezado: #include <QCoapClient>
CMake: find_package(Qt6 REQUIRED COMPONENTS Coap)
target_link_libraries(mytarget PRIVATE Qt6::Coap)
qmake: QT += coap
Heredado de: QObject

Nota: Todas las funciones de esta clase son reentrantes.

Propiedades

Funciones públicas

QCoapClient(QtCoap::SecurityMode securityMode = QtCoap::SecurityMode::NoSecurity, QObject *parent = nullptr)
virtual ~QCoapClient()
QNetworkInterface bindInterface() const
void cancelObserve(QCoapReply *notifiedReply)
void cancelObserve(const QUrl &url)
QCoapReply *deleteResource(const QCoapRequest &request)
QCoapReply *deleteResource(const QUrl &url)
void disconnect()
QCoapResourceDiscoveryReply *discover(const QUrl &url, const QString &discoveryPath = QLatin1String("/.well-known/core"))
QCoapResourceDiscoveryReply *discover(QtCoap::MulticastGroup group = QtCoap::MulticastGroup::AllCoapNodesIPv4, int port = QtCoap::DefaultPort, const QString &discoveryPath = QLatin1String("/.well-known/core"))
QCoapReply *get(const QCoapRequest &request)
QCoapReply *get(const QUrl &url)
QCoapReply *observe(const QCoapRequest &request)
QCoapReply *observe(const QUrl &url)
QCoapReply *post(const QCoapRequest &request, const QByteArray &data = QByteArray())
QCoapReply *post(const QCoapRequest &request, QIODevice *device)
QCoapReply *post(const QUrl &url, const QByteArray &data = QByteArray())
QCoapReply *put(const QCoapRequest &request, const QByteArray &data = QByteArray())
QCoapReply *put(const QCoapRequest &request, QIODevice *device)
QCoapReply *put(const QUrl &url, const QByteArray &data = QByteArray())
void setAckRandomFactor(double ackRandomFactor)
void setAckTimeout(uint ackTimeout)
void setBindInterface(const QNetworkInterface &iface)
void setBlockSize(quint16 blockSize)
void setMaximumRetransmitCount(uint maximumRetransmitCount)
void setMaximumServerResponseDelay(uint responseDelay)
void setMinimumTokenSize(int tokenSize)
void setSecurityConfiguration(const QCoapSecurityConfiguration &configuration)
void setSocketOption(QAbstractSocket::SocketOption option, const QVariant &value)

Señales

void bindInterfaceChanged(const QNetworkInterface &iface)
void error(QCoapReply *reply, QtCoap::Error error)
void finished(QCoapReply *reply)
void responseToMulticastReceived(QCoapReply *reply, const QCoapMessage &message, const QHostAddress &sender)

Descripción detallada

La clase QCoapClient contiene señales que se activan cuando llega la respuesta a una solicitud enviada.

La aplicación puede utilizar un QCoapClient para enviar solicitudes a través de una red CoAP. Proporciona funciones para solicitudes estándar: cada una devuelve un objeto ` QCoapReply `, al que se enviarán los datos de la respuesta; estos se pueden leer cuando llega la señal ` finished()`.

Se puede enviar una solicitud sencilla con:

QCoapClient *client = new QCoapClient(this);
connect(client, &QCoapClient::finished, this, &TestClass::slotFinished);
client->get(QCoapRequest(Qurl("coap://coap.me/test")));

Nota: Una vez finalizado el procesamiento de la solicitud, es responsabilidad del usuario eliminar el objeto ` QCoapReply ` en el momento oportuno. No lo elimines directamente dentro de la ranura conectada a ` finished()`. Puedes utilizar la función ` deleteLater()`.

También puede utilizar una solicitud de observación. Esta se puede utilizar como se ha indicado anteriormente, o de forma más cómoda con la señal QCoapReply::notified():

QCoapRequest request = QCoapRequest(Qurl("coap://coap.me/obs"));
QCoapReply *reply = client->observe(request);
connect(reply, &QCoapReply::notified, this, &TestClass::slotNotified);

Y la observación se puede cancelar con:

client->cancelObserve(reply);

Cuando llega una respuesta, el QCoapClient emite una señal « finished()».

Nota: En el caso de una solicitud de descubrimiento, el objeto devuelto es un ` QCoapResourceDiscoveryReply`. Se puede utilizar de la misma forma que un ` QCoapReply `, pero además contiene una lista de recursos.

Consideraciones de seguridad

Durante una transferencia por bloques, la carga útil de la respuesta se acumula en la memoria hasta que finaliza la transferencia, y ` QtCoap ` no impone un límite máximo al tamaño acumulado. Por lo tanto, un servidor malicioso o defectuoso que siga enviando bloques sin indicar nunca cuál es el último puede provocar que el cliente agote la memoria. El tamaño acumulado no se puede observar mientras la transferencia está en curso, por lo que una aplicación no puede limitarlo directamente. Realiza intercambios por bloques únicamente con servidores de confianza y, preferiblemente, en una red de confianza o aislada.

Multidifusión

DTLS protege una conexión entre dos extremos y, por lo tanto, no puede aplicarse a la multidifusión, donde pueden estar presentes más de dos extremos. Por este motivo, una solicitud de multidifusión y sus respuestas no se cifran ni se autentican.

Cualquier host del grupo puede responder a una solicitud de multidifusión. En CoAP, todos estos hosts son propietarios legítimos del recurso y se espera que proporcionen respuestas equivalentes. Cuando se envía una respuesta bloque a bloque, los bloques restantes se recuperan mediante unidifusión desde el host que haya respondido.

La multidifusión de CoAP se ha diseñado partiendo de la premisa de que la red es segura y de que todos los nodos del grupo son de confianza. Utiliza la multidifusión únicamente en situaciones que cumplan esta premisa.

Véase también QCoapRequest, QCoapReply y QCoapResourceDiscoveryReply.

Documentación de propiedades

[since 6.11] bindInterface : QNetworkInterface

Esta propiedad especifica la interfaz de red que utilizará el socket

El valor por defecto es un objeto ` invalid QNetworkInterface `, lo que significa que se aceptarán paquetes entrantes desde todas las interfaces de red. Del mismo modo, todas las interfaces de red pueden utilizarse para enviar paquetes salientes.

Cuando se especifica una interfaz de red válida, solo se aceptarán paquetes entrantes procedentes de esa interfaz. Del mismo modo, los paquetes salientes solo se enviarán a través de esa interfaz.

El cambio de esta propiedad solo surtirá efecto la próxima vez que el cliente se conecte al socket, por lo que hay que asegurarse de llamar a ` disconnect()` si ha habido alguna comunicación previa.

Esta enumeración se introdujo en Qt 6.11.

Funciones de acceso:

QNetworkInterface bindInterface() const
void setBindInterface(const QNetworkInterface &iface)

Señal del notificador:

void bindInterfaceChanged(const QNetworkInterface &iface)

Documentación de funciones miembro

[explicit] QCoapClient::QCoapClient(QtCoap::SecurityMode securityMode = QtCoap::SecurityMode::NoSecurity, QObject *parent = nullptr)

Crea un objeto `QCoapClient` para el ` securityMode ` indicado y establece ` parent ` como objeto padre.

El valor predeterminado para ` securityMode ` es ` QtCoap::NoSecurity`, lo que desactiva la seguridad.

[virtual noexcept] QCoapClient::~QCoapClient()

Destruye el objeto ` QCoapClient ` y libera los recursos correspondientes. Ten en cuenta que los objetos ` QCoapReply ` devueltos por esta clase tienen como padre el objeto ` QCoapClient `, lo que significa que se eliminarán junto con este.

void QCoapClient::cancelObserve(QCoapReply *notifiedReply)

Cancela la observación de un recurso utilizando la respuesta « notifiedReply » devuelta por el método observe().

Esta es una función sobrecargada.

Véase también observe().

void QCoapClient::cancelObserve(const QUrl &url)

Cancela la observación de un recurso identificado por el url.

Esta es una función sobrecargada.

Véase también observe().

QCoapReply *QCoapClient::deleteResource(const QCoapRequest &request)

Envía el objeto ` request ` utilizando el método DELETE y devuelve un nuevo objeto ` QCoapReply `.

Véase también get(), put(), post(), observe() y discover().

QCoapReply *QCoapClient::deleteResource(const QUrl &url)

Envía una solicitud DELETE a la dirección url.

Esta es una función sobrecargada.

Véanse también get(), put(), post(), observe() y discover().

void QCoapClient::disconnect()

Cierra los sockets y las conexiones abiertas para liberar el canal de transporte.

Nota: En el modo seguro, es necesario llamar a esta función antes de cambiar la configuración de seguridad o de conectarse a otro servidor.

Véase también setSecurityConfiguration().

QCoapResourceDiscoveryReply *QCoapClient::discover(const QUrl &url, const QString &discoveryPath = QLatin1String("/.well-known/core"))

Detecta los recursos disponibles en la dirección url indicada y devuelve un nuevo objeto QCoapResourceDiscoveryReply que emite la señal QCoapResourceDiscoveryReply::discovered() cada vez que llega la respuesta.

La ruta de descubrimiento es, por defecto, «/.well-known/core», pero puede modificarse pasando una ruta diferente a discoveryPath. El descubrimiento se describe en el RFC 6690.

Véanse también get(), post(), put(), deleteResource() y observe().

QCoapResourceDiscoveryReply *QCoapClient::discover(QtCoap::MulticastGroup group = QtCoap::MulticastGroup::AllCoapNodesIPv4, int port = QtCoap::DefaultPort, const QString &discoveryPath = QLatin1String("/.well-known/core"))

Detecta los recursos disponibles en los puntos finales que se han unido al grupo de descubrimiento de recursos ( group ) en la dirección port especificada. Devuelve un nuevo objeto QCoapResourceDiscoveryReply que emite la señal QCoapResourceDiscoveryReply::discovered() cada vez que llega una respuesta. La dirección de grupo de descubrimiento ( group ) es una de las direcciones de grupo de multidifusión de CoAP y, por defecto, es QtCoap::AllCoapNodesIPv4.

La ruta de descubrimiento es, por defecto, «/.well-known/core», pero se puede cambiar pasando una ruta diferente a discoveryPath. El descubrimiento se describe en el RFC 6690.

Esta es una función sobrecargada.

Véase también get(), post(), put(), deleteResource() y observe().

[signal] void QCoapClient::error(QCoapReply *reply, QtCoap::Error error)

Esta señal se emite cada vez que se produce un error. El parámetro « reply » puede ser « nullptr » si el error no está relacionado con un « QCoapReply » específico. El parámetro « error » contiene el código de error.

Véase también finished(), QCoapReply::error() y QCoapReply::finished().

[signal] void QCoapClient::finished(QCoapReply *reply)

Esta señal se emite junto con la señal « QCoapReply::finished » () cada vez que se recibe una respuesta CoAP, ya sea tras un éxito o un error. El parámetro « reply » contendrá un puntero a la respuesta que se acaba de recibir.

Véanse también error(), QCoapReply::finished() y QCoapReply::error().

QCoapReply *QCoapClient::get(const QCoapRequest &request)

Envía la solicitud request utilizando el método GET y devuelve un nuevo objeto QCoapReply.

Véase también post(), put(), deleteResource(), observe() y discover().

QCoapReply *QCoapClient::get(const QUrl &url)

Envía una solicitud GET a url y devuelve un nuevo objeto QCoapReply.

Esta es una función sobrecargada.

Véase también post(), put(), deleteResource(), observe() y discover().

QCoapReply *QCoapClient::observe(const QCoapRequest &request)

Envía una solicitud para observar el objetivo request y devuelve un nuevo objeto QCoapReply que emite la señal QCoapReply::notified() cada vez que llega una nueva notificación.

Véase también cancelObserve(), get(), post(), put(), deleteResource() y discover().

QCoapReply *QCoapClient::observe(const QUrl &url)

Envía una solicitud para observar el objeto de destino url y devuelve un nuevo objeto QCoapReply que emite la señal QCoapReply::notified() cada vez que llega una nueva notificación.

Esta es una función sobrecargada.

Véase también cancelObserve(), get(), post(), put(), deleteResource() y discover().

QCoapReply *QCoapClient::post(const QCoapRequest &request, const QByteArray &data = QByteArray())

Envía el objeto ` request ` utilizando el método POST y devuelve un nuevo objeto ` QCoapReply `. Utiliza ` data ` como carga útil para esta solicitud. Si ` data ` está vacío, se utilizará la carga útil de ` request `.

Véase también get(), put(), deleteResource(), observe() y discover().

QCoapReply *QCoapClient::post(const QCoapRequest &request, QIODevice *device)

Envía el objeto ` request ` mediante el método POST y devuelve un nuevo objeto ` QCoapReply `. Utiliza el contenido de ` device ` como carga útil para esta solicitud. Un dispositivo nulo se considera contenido vacío, en cuyo caso se utilizará la carga útil de ` request `.

Nota: El dispositivo debe estar abierto y ser legible antes de llamar a esta función.

Esta es una función sobrecargada.

Véanse también get(), put(), deleteResource(), observe() y discover().

QCoapReply *QCoapClient::post(const QUrl &url, const QByteArray &data = QByteArray())

Envía una solicitud POST a url y devuelve un nuevo objeto QCoapReply. Utiliza data como carga útil para esta solicitud.

Esta es una función sobrecargada.

Véase también get(), put(), deleteResource(), observe() y discover().

QCoapReply *QCoapClient::put(const QCoapRequest &request, const QByteArray &data = QByteArray())

Envía el objeto « request » mediante el método PUT y devuelve un nuevo objeto « QCoapReply ». Utiliza « data » como carga útil para esta solicitud. Si « data » está vacío, se utilizará la carga útil de « request ».

Véase también get(), post(), deleteResource(), observe() y discover().

QCoapReply *QCoapClient::put(const QCoapRequest &request, QIODevice *device)

Envía la petición request utilizando el método PUT y devuelve un nuevo objeto QCoapReply. Utiliza el contenido de device como carga útil para esta solicitud. Un dispositivo nulo se considera contenido vacío, en cuyo caso se utilizará la carga útil de request.

Nota: El dispositivo debe estar abierto y ser legible antes de llamar a esta función.

Esta es una función sobrecargada.

Véase también get(), post(), deleteResource(), observe() y discover().

QCoapReply *QCoapClient::put(const QUrl &url, const QByteArray &data = QByteArray())

Envía una solicitud PUT a url y devuelve un nuevo objeto QCoapReply. Utiliza data como carga útil para esta solicitud.

Esta es una función sobrecargada.

Véase también get(), post(), deleteResource(), observe() y discover().

[signal] void QCoapClient::responseToMulticastReceived(QCoapReply *reply, const QCoapMessage &message, const QHostAddress &sender)

Esta señal se emite cuando llega una respuesta de unidifusión a una solicitud de multidifusión. El parámetro reply contiene un puntero a la respuesta que se acaba de recibir, message contiene la carga útil y los detalles del mensaje, y sender contiene la dirección del remitente.

Nota: Las solicitudesde multidifusión no están autenticadas; consulta multicast security considerations para conocer el modelo de confianza en el que se basa.

Véase también error(), QCoapReply::finished() y QCoapReply::error().

void QCoapClient::setAckRandomFactor(double ackRandomFactor)

Establece el valor « ACK_RANDOM_FACTOR », definido en la RFC 7252 (sección 4.2), en « ackRandomFactor ». Este valor debe ser mayor o igual a 1. El valor por defecto es 1,5.

Véase también setAckTimeout().

void QCoapClient::setAckTimeout(uint ackTimeout)

Establece el valor de « ACK_TIMEOUT », definido en la RFC 7252 (sección 4.2), en « ackTimeout » en milisegundos. El valor por defecto es 2000 ms.

Este tiempo de espera solo se aplica a los mensajes confirmables. El tiempo de espera real para las transmisiones fiables es un valor aleatorio comprendido entre ACK_TIMEOUT y ACK_TIMEOUT * ACK_RANDOM_FACTOR.

Véase también setAckRandomFactor().

void QCoapClient::setBlockSize(quint16 blockSize)

Establece el tamaño máximo de bloque que utiliza el protocolo en blockSize al enviar solicitudes y recibir respuestas. El tamaño del bloque debe ser una potencia de dos.

void QCoapClient::setMaximumRetransmitCount(uint maximumRetransmitCount)

Establece el valor de « MAX_RETRANSMIT », definido en la RFC 7252 —sección 4.2—, en « maximumRetransmitCount ». Este valor debe ser inferior o igual a 25. El valor predeterminado es 4.

void QCoapClient::setMaximumServerResponseDelay(uint responseDelay)

Establece el valor de « MAX_SERVER_RESPONSE_DELAY » en « responseDelay » en milisegundos. El valor por defecto es 250 segundos.

Tal y como se define en la RFC 7390, sección 2.5, el « MAX_SERVER_RESPONSE_DELAY » es el retraso máximo de respuesta previsto en todos los servidores a los que el cliente puede enviar una solicitud de multidifusión.

void QCoapClient::setMinimumTokenSize(int tokenSize)

Establece el tamaño mínimo del token en tokenSize en bytes. Por motivos de seguridad, se recomienda utilizar tokens con una longitud mínima de 4 bytes. El valor por defecto de este parámetro es de 4 bytes.

void QCoapClient::setSecurityConfiguration(const QCoapSecurityConfiguration &configuration)

Establece los parámetros de configuración de seguridad desde configuration. La configuración se ignorará si se utiliza el modo QtCoap::NoSecurity.

Nota: Este método debe invocarse antes de que comience el protocolo de autenticación. Si necesitas cambiar la configuración de seguridad tras establecer una conexión segura con el servidor, primero hay que desconectar al cliente.

Véase también disconnect().

void QCoapClient::setSocketOption(QAbstractSocket::SocketOption option, const QVariant &value)

Establece el socket QUdpSocket option en value.

© 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.