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

Documentation des fonctions membres

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

Crée un objet `QCoapClient` pour l'securityMode ` spécifiée et définit ` parent ` comme objet parent.

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

[virtual noexcept] QCoapClient::~QCoapClient()

Détruit l'objet ` QCoapClient ` et libère toutes les ressources associées. Notez que les objets ` QCoapReply ` renvoyés par cette classe ont pour parent l'objet ` QCoapClient ` ; ils seront donc supprimés en même temps que celui-ci.

void QCoapClient::cancelObserve(QCoapReply *notifiedReply)

Annule la surveillance d'une ressource à l'aide de la réponse « notifiedReply » renvoyée par la méthode observe().

Voir également observe().

void QCoapClient::cancelObserve(const QUrl &url)

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

Voir également observe().

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

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

Voir également get(), put(), post(), observe() et discover().

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

Envoie une requête DELETE à l'url.

Voir également get(), put(), post(), observe() et discover().

void QCoapClient::disconnect()

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

Voir également setSecurityConfiguration().

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

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

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 également 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étecte les ressources disponibles au niveau des terminaux ayant rejoint l'group à l'adresse port indiquée. Renvoie un nouvel objet QCoapResourceDiscoveryReply qui émet le signal QCoapResourceDiscoveryReply::discovered() dès qu'une réponse arrive. L'adresse group correspond à l'une des adresses de groupe de multidiffusion CoAP ; sa valeur par défaut est QtCoap::AllCoapNodesIPv4.

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

Voir également get(), post(), put(), deleteResource() et observe().

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

Ce signal est émis chaque fois qu'une erreur se produit. Le paramètre reply peut prendre la valeur « nullptr » si l'erreur n'est pas liée à une 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 en même temps que le signal « QCoapReply::finished() » chaque fois qu’une réponse CoAP est reçue, qu’il s’agisse d’une opération réussie ou d’une erreur. Le paramètre « reply » contiendra un pointeur vers la réponse qui vient d’être reçue.

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

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

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

Voir également 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 également post(), put(), deleteResource(), observe() et discover().

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

Envoie une requête pour surveiller l'request cible et renvoie un nouvel objet QCoapReply qui émet le signal QCoapReply::notified() dès qu'une nouvelle notification arrive.

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

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

Envoie une requête pour surveiller l'url cible et renvoie un nouvel objet QCoapReply qui émet le signal QCoapReply::notified() dès qu'une nouvelle notification arrive.

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

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

Envoie l'request à l'aide de la méthode POST et renvoie un nouvel objet QCoapReply. Utilise data comme charge utile pour cette requête. Si data est vide, la charge utile de request sera utilisée.

Voir également get(), put(), deleteResource(), observe() et discover().

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

Envoie l'request e à l'aide de la méthode POST et renvoie un nouvel objet QCoapReply. Utilise le contenu de device comme charge utile pour cette requête. Un périphérique null est considéré comme un contenu vide ; dans ce cas, la charge utile de request sera utilisée.

Voir également 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 également get(), put(), deleteResource(), observe() et discover().

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

Envoie l'request à l'aide de la méthode PUT et renvoie un nouvel objet QCoapReply. Utilise data comme charge utile pour cette requête. Si data est vide, la charge utile de request sera utilisée.

Voir également get(), post(), deleteResource(), observe() et discover().

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

Envoie l'request e à l'aide de la méthode PUT et renvoie un nouvel objet QCoapReply. Utilise le contenu de device comme charge utile pour cette requête. Un périphérique null est considéré comme un contenu vide ; dans ce cas, la charge utile de request sera utilisée.

Voir également 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 également 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 en unicast à une requête en multicast arrive. Le paramètre reply contient un pointeur vers 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)

Définit la valeur « ACK_RANDOM_FACTOR » (taux de mise à jour des données) définie dans la norme RFC 7252 - section 4.2, sur « ackRandomFactor ». Cette valeur doit être supérieure ou égale à 1. La valeur par défaut est 1,5.

Voir également setAckTimeout().

void QCoapClient::setAckTimeout(uint ackTimeout)

Définit la valeur « ACK_TIMEOUT » spécifiée dans la RFC 7252 – section 4.2 sur « ackTimeout » en millisecondes. La valeur par défaut est de 2 000 ms.

Ce délai d'expiration s'applique uniquement aux messages confirmables. Le délai d'expiration 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 des blocs utilisés par le protocole à blockSize lors de l'envoi de requêtes et de la réception de réponses. La taille des blocs doit être une puissance de deux.

void QCoapClient::setMaximumRetransmitCount(uint maximumRetransmitCount)

Définit la valeur « MAX_RETRANSMIT » (fréquence de mise à jour) définie dans la norme RFC 7252 - section 4.2 sur « 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 « MAX_SERVER_RESPONSE_DELAY » sur « responseDelay » en millisecondes. La valeur par défaut est de 250 secondes.

Comme défini dans la RFC 7390 - Section 2.5, l'MAX_SERVER_RESPONSE_DELAY correspond au délai de réponse maximal attendu sur l'ensemble des serveurs auxquels le client peut envoyer une requête de multidiffusion.

void QCoapClient::setMinimumTokenSize(int tokenSize)

Définit la taille minimale des jetons à tokenSize s 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 sécurité à partir de configuration. La configuration sera ignorée si le mode « QtCoap::NoSecurity » est utilisé.

Voir également disconnect().

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

QUdpSocket Définit l'option de la socket sur value.