QCoapClient Class

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

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

client->cancelObserve(reply);

Documentación de funciones miembro

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

Construye un objeto QCoapClient para el securityMode dado y establece parent como el objeto padre.

El valor por defecto para securityMode es QtCoap::NoSecurity, que desactiva la seguridad.

[virtual noexcept] QCoapClient::~QCoapClient()

Destruye el objeto QCoapClient y libera cualquier recurso. Tenga en cuenta que los objetos QCoapReply que se devuelven desde esta clase tienen el conjunto QCoapClient como padres, lo que significa que se eliminarán junto con él.

void QCoapClient::cancelObserve(QCoapReply *notifiedReply)

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

Véase también observe().

void QCoapClient::cancelObserve(const QUrl &url)

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

Véase también observe().

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

Envía el 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 al destino url.

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

void QCoapClient::disconnect()

Cierra los sockets y conexiones abiertos para liberar el transporte.

Véase también setSecurityConfiguration().

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

Descubre los recursos disponibles en el url dado y devuelve un nuevo objeto QCoapResourceDiscoveryReply que emite la señal QCoapResourceDiscoveryReply::discovered() cada vez que llega la respuesta.

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

Véase 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"))

Descubre los recursos disponibles en los extremos que se han unido al group en el port dado. Devuelve un nuevo objeto QCoapResourceDiscoveryReply que emite la señal QCoapResourceDiscoveryReply::discovered() cada vez que llega una respuesta. group es una de las direcciones de grupo de multidifusión CoAP y su valor predeterminado es QtCoap::AllCoapNodesIPv4.

La ruta de descubrimiento por defecto es "/.well-known/core", pero puede cambiarse pasando una ruta diferente a discoveryPath. Discovery se describe en RFC 6690.

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

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

Esta señal se emite siempre 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, tras un éxito o un error. El parámetro reply contendrá un puntero a la respuesta que se acaba de recibir.

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

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

Envía el 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 petición GET a url y devuelve un nuevo objeto QCoapReply.

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 objetivo url 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::post(const QCoapRequest &request, const QByteArray &data = QByteArray())

Envía el 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 request utilizando 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 trata como contenido vacío, en cuyo caso se utilizará la carga útil de request.

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

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

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

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

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

Envía el request utilizando 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 el 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 trata como contenido vacío, en cuyo caso se utilizará la carga útil de request.

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

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

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

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 unidifusión a una solicitud 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.

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

void QCoapClient::setAckRandomFactor(double ackRandomFactor)

Establece el valor ACK_RANDOM_FACTOR definido en 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 ACK_TIMEOUT definido en RFC 7252 - Sección 4.2 a ackTimeout en milisegundos. El valor por defecto es 2000 ms.

Este tiempo de espera sólo se aplica a los mensajes confirmables. El tiempo de espera real para transmisiones fiables es un valor aleatorio 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 utilizado por el protocolo en blockSize al enviar solicitudes y recibir respuestas. El tamaño de bloque debe ser una potencia de dos.

void QCoapClient::setMaximumRetransmitCount(uint maximumRetransmitCount)

Establece el valor MAX_RETRANSMIT definido en RFC 7252 - Sección 4.2 a maximumRetransmitCount. Este valor debe ser menor 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.

Como se define en RFC 7390 - Sección 2.5, MAX_SERVER_RESPONSE_DELAY es el retardo de respuesta máximo esperado sobre todos los servidores a los que el cliente puede enviar una petición multicast.

void QCoapClient::setMinimumTokenSize(int tokenSize)

Establece el tamaño mínimo del token en tokenSize en bytes. Por razones de seguridad se recomienda utilizar tokens con una longitud de al menos 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 de configuration. La configuración será ignorada si se utiliza el modo QtCoap::NoSecurity.

Véase también disconnect().

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

Establece la toma QUdpSocket option en value.