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);

Member Function Documentation

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

Construit un objet QCoapClient pour l'objet securityMode donné et définit parent comme l'objet parent.

La valeur par défaut pour securityMode est QtCoap::NoSecurity, qui désactive la sécurité.

[virtual noexcept] QCoapClient::~QCoapClient()

Détruit l'objet QCoapClient et libère les ressources. Notez que les objets QCoapReply renvoyés par cette classe ont pour parents l'ensemble QCoapClient, ce qui signifie qu'ils seront supprimés en même temps que lui.

void QCoapClient::cancelObserve(QCoapReply *notifiedReply)

Annule l'observation d'une ressource en utilisant la réponse notifiedReply renvoyée par la méthode observe().

Voir aussi observe().

void QCoapClient::cancelObserve(const QUrl &url)

Annule l'observation d'une ressource identifiée par url.

Voir aussi observe().

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

Envoie l'objet request à l'aide de la méthode DELETE et renvoie un nouvel objet QCoapReply.

Voir aussi get(), put(), post(), observe() et discover().

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

Envoie une requête DELETE à la cible url.

Voir aussi get(), put(), post(), observe() et discover().

void QCoapClient::disconnect()

Ferme les sockets et les connexions ouvertes pour libérer le transport.

Voir aussi setSecurityConfiguration().

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

Découvre les ressources disponibles à l'adresse url et renvoie un nouvel objet QCoapResourceDiscoveryReply qui émet le signal QCoapResourceDiscoveryReply::discovered() lorsque la réponse arrive.

Le chemin de découverte est par défaut "/.well-known/core", mais il peut être modifié en passant un chemin différent à discoveryPath. La découverte est décrite dans la RFC 6690.

Voir aussi get(), post(), put(), deleteResource() et observe().

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

Découvre les ressources disponibles aux points d'extrémité qui ont rejoint le site group à l'adresse port donnée. Renvoie un nouvel objet QCoapResourceDiscoveryReply qui émet le signal QCoapResourceDiscoveryReply::discovered() lorsqu'une réponse arrive. L'adresse group est l'une des adresses de groupe de multidiffusion CoAP et correspond par défaut à QtCoap::AllCoapNodesIPv4.

Le chemin de découverte est par défaut "/.well-known/core", mais peut être modifié en passant un chemin différent à discoveryPath. La découverte est décrite dans la RFC 6690.

Voir aussi get(), post(), put(), deleteResource() et observe().

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

Ce signal est émis lorsqu'une erreur se produit. Le paramètre reply peut être nullptr si l'erreur n'est pas liée à un QCoapReply spécifique. Le paramètre error contient le code d'erreur.

Voir également finished(), QCoapReply::error() et QCoapReply::finished().

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

Ce signal est émis avec le signal QCoapReply::finished() à chaque fois qu'une réponse CoAP est reçue, après un succès ou une erreur. Le paramètre reply contient un pointeur sur la réponse qui vient d'être reçue.

Voir également error(), QCoapReply::finished() et QCoapReply::error().

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

Envoie le site request à l'aide de la méthode GET et renvoie un nouvel objet QCoapReply.

Voir aussi post(), put(), deleteResource(), observe() et discover().

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

Envoie une requête GET à url et renvoie un nouvel objet QCoapReply.

Voir aussi post(), put(), deleteResource(), observe() et discover().

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

Envoie une demande d'observation de la cible request et renvoie un nouvel objet QCoapReply qui émet le signal QCoapReply::notified() chaque fois qu'une nouvelle notification arrive.

Voir aussi cancelObserve(), get(), post(), put(), deleteResource() et discover().

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

Envoie une demande d'observation de la cible url et renvoie un nouvel objet QCoapReply qui émet le signal QCoapReply::notified() chaque fois qu'une nouvelle notification arrive.

Voir aussi cancelObserve(), get(), post(), put(), deleteResource() et discover().

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

Envoie l'adresse request en utilisant la méthode POST et renvoie un nouvel objet QCoapReply. Utilise data comme charge utile pour cette demande. Si data est vide, c'est le contenu de request qui sera utilisé.

Voir aussi get(), put(), deleteResource(), observe() et discover().

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

Envoie l'adresse request à l'aide de la méthode POST et renvoie un nouvel objet QCoapReply. Utilise le contenu de device comme charge utile pour cette demande. Un appareil nul est traité comme un contenu vide, auquel cas le contenu de request sera utilisé.

Voir aussi get(), put(), deleteResource(), observe() et discover().

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

Envoie une requête POST à url et renvoie un nouvel objet QCoapReply. Utilise data comme charge utile pour cette requête.

Voir aussi get(), put(), deleteResource(), observe() et discover().

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

Envoie le site request à l'aide de la méthode PUT et renvoie un nouvel objet QCoapReply. Utilise data comme charge utile pour cette demande. Si data est vide, c'est le contenu de request qui sera utilisé.

Voir aussi get(), post(), deleteResource(), observe() et discover().

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

Envoie l'adresse request à l'aide de la méthode PUT et renvoie un nouvel objet QCoapReply. Utilise le contenu de device comme charge utile pour cette demande. Un appareil nul est traité comme un contenu vide, auquel cas le contenu de request sera utilisé.

Voir aussi get(), post(), deleteResource(), observe() et discover().

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

Envoie une requête PUT à url et renvoie un nouvel objet QCoapReply. Utilise data comme charge utile pour cette requête.

Voir aussi get(), post(), deleteResource(), observe() et discover().

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

Ce signal est émis lorsqu'une réponse unicast à une requête multicast arrive. Le paramètre reply contient un pointeur sur la réponse qui vient d'être reçue, message contient la charge utile et les détails du message, et sender contient l'adresse de l'expéditeur.

Voir également error(), QCoapReply::finished() et QCoapReply::error().

void QCoapClient::setAckRandomFactor(double ackRandomFactor)

Fixe la valeur ACK_RANDOM_FACTOR définie dans la RFC 7252 - Section 4.2, à ackRandomFactor. Cette valeur doit être supérieure ou égale à 1. La valeur par défaut est 1.5.

Voir aussi setAckTimeout().

void QCoapClient::setAckTimeout(uint ackTimeout)

Fixe la valeur ACK_TIMEOUT définie dans la RFC 7252 - Section 4.2 à ackTimeout en millisecondes. La valeur par défaut est 2000 ms.

Ce délai ne s'applique qu'aux messages confirmables. Le délai réel pour les transmissions fiables est une valeur aléatoire comprise entre ACK_TIMEOUT et ACK_TIMEOUT * ACK_RANDOM_FACTOR.

Voir également setAckRandomFactor().

void QCoapClient::setBlockSize(quint16 blockSize)

Définit la taille maximale du bloc utilisé par le protocole à l'adresse blockSize lors de l'envoi de requêtes et de la réception de réponses. La taille du bloc doit être une puissance de deux.

void QCoapClient::setMaximumRetransmitCount(uint maximumRetransmitCount)

Définit la valeur MAX_RETRANSMIT définie dans RFC 7252 - Section 4.2 à maximumRetransmitCount. Cette valeur doit être inférieure ou égale à 25. La valeur par défaut est 4.

void QCoapClient::setMaximumServerResponseDelay(uint responseDelay)

Définit la valeur de MAX_SERVER_RESPONSE_DELAY à responseDelay en millisecondes. La valeur par défaut est de 250 secondes.

Comme défini dans la RFC 7390 - Section 2.5, MAX_SERVER_RESPONSE_DELAY est le délai de réponse maximal attendu sur tous les serveurs auxquels le client peut envoyer une demande de multidiffusion.

void QCoapClient::setMinimumTokenSize(int tokenSize)

Fixe la taille minimale du jeton à tokenSize en octets. Pour des raisons de sécurité, il est recommandé d'utiliser des jetons d'une longueur d'au moins 4 octets. La valeur par défaut de ce paramètre est de 4 octets.

void QCoapClient::setSecurityConfiguration(const QCoapSecurityConfiguration &configuration)

Définit les paramètres de configuration de la sécurité à partir de configuration. La configuration sera ignorée si le mode QtCoap::NoSecurity est utilisé.

Voir aussi disconnect().

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

Définit le socket QUdpSocket option à value.