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

成员函数文档

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

根据给定的securityMode 构建一个QCoapClient对象，并将parent 设置为父对象。

securityMode 的默认值为QtCoap::NoSecurity ，这将禁用安全功能。

[virtual noexcept] QCoapClient::~QCoapClient()

销毁QCoapClient 对象并释放所有资源。请注意，由本类返回的QCoapReply 对象将其父对象设置为QCoapClient ，这意味着它们将随该父对象一同被删除。

void QCoapClient::cancelObserve(QCoapReply *notifiedReply)

使用observe()方法返回的响应notifiedReply ，取消对资源的监听。

另请参阅 observe()。

void QCoapClient::cancelObserve(const QUrl &url)

取消对由url 标识的资源的监听。

另请参阅 observe()。

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

使用 DELETE 方法发送request ，并返回一个新的QCoapReply 对象。

另请参阅 get()、put()、post()、observe() 以及discover()。

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

向目标url 发送一个 DELETE 请求。

另请参阅 get()、put()、post()、observe() 以及discover()。

void QCoapClient::disconnect()

关闭已打开的套接字和连接，以释放传输通道。

另请参阅 setSecurityConfiguration()。

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

用于发现指定url 路径下可用的资源，并返回一个新的QCoapResourceDiscoveryReply 对象，该对象会在响应到达时触发QCoapResourceDiscoveryReply::discovered() 信号。

发现路径默认为“/.well-known/core”，但可以通过向discoveryPath 传递不同的路径来更改。发现机制在RFC 6690 中有详细描述。

另请参阅 get()、post()、put()、deleteResource() 以及observe()。

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

发现已加入group 且位于指定port 的端点上可用的资源。返回一个新的QCoapResourceDiscoveryReply 对象，该对象会在收到响应时触发QCoapResourceDiscoveryReply::discovered()信号。group 是CoAP多播组地址之一，默认值为QtCoap::AllCoapNodesIPv4 。

发现路径默认为“/.well-known/core”，但可以通过向discoveryPath 传递不同的路径来更改。发现机制在RFC 6690 中有详细描述。

另请参阅 get()、post()、put()、deleteResource() 以及observe()。

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

每当发生错误时，都会发出此信号。如果错误与特定的QCoapReply 无关，则reply 参数可以设置为nullptr 。error 参数包含错误代码。

另请参阅 finished()、QCoapReply::error()，以及QCoapReply::finished()。

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

每当接收到 CoAP 应答时（无论操作成功还是发生错误），都会与QCoapReply::finished() 信号一同发出此信号。reply 参数将包含指向刚刚接收到的应答的指针。

另请参阅 error()、QCoapReply::finished() 和QCoapReply::error()。

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

使用 GET 方法发送request ，并返回一个新的QCoapReply 对象。

另请参阅 post()、put()、deleteResource()、observe() 以及discover()。

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

向url 发送一个 GET 请求，并返回一个新的QCoapReply 对象。

另请参阅 post()、put()、deleteResource()、observe() 以及discover()。

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

向目标request 发送监听请求，并返回一个新的QCoapReply 对象，该对象会在收到新通知时触发QCoapReply::notified() 信号。

另请参阅 cancelObserve()、get()、post()、put()、deleteResource()，以及discover()。

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

向目标url 发送观察请求，并返回一个新的QCoapReply 对象，该对象会在收到新通知时触发QCoapReply::notified()信号。

另请参阅 cancelObserve()、get()、post()、put()、deleteResource()，以及discover()。

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

使用 POST 方法发送request ，并返回一个新的QCoapReply 对象。将data 作为此请求的有效载荷。如果data 为空，则使用request 的有效载荷。

另请参阅 get()、put()、deleteResource()、observe() 和discover()。

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

使用 POST 方法发送request 请求，并返回一个新的QCoapReply 对象。将device 的内容用作此请求的有效载荷。若设备为 null，则视为内容为空，此时将使用request 的有效载荷。

另请参阅 get()、put()、deleteResource()、observe() 以及discover()。

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

向url 发送一个 POST 请求，并返回一个新的QCoapReply 对象。将data 作为此请求的有效载荷。

另请参阅 get()、put()、deleteResource()、observe()，以及discover()。

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

使用 PUT 方法发送request ，并返回一个新的QCoapReply 对象。将data 作为此请求的有效载荷。如果data 为空，则使用request 的有效载荷。

另请参阅 get()、post()、deleteResource()、observe() 和discover()。

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

使用 PUT 方法发送request 请求，并返回一个新的QCoapReply 对象。将device 的内容用作此请求的有效载荷。空设备将被视为空内容，在这种情况下，将使用request 的有效载荷。

另请参阅 get()、post()、deleteResource()、observe() 以及discover()。

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

向url 发送一个 PUT 请求，并返回一个新的QCoapReply 对象。将data 作为此请求的有效载荷。

另请参阅 get()、post()、deleteResource()、observe(）和discover()。

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

当收到针对多播请求的单播响应时，会发出此信号。reply 参数包含指向刚接收到的回复的指针，message 包含有效载荷和消息详细信息，sender 包含发送方地址。

另请参阅 error()、QCoapReply::finished() 和QCoapReply::error()。

void QCoapClient::setAckRandomFactor(double ackRandomFactor)

将RFC 7252 第 4.2 节中定义的“ACK_RANDOM_FACTOR ”值设置为ackRandomFactor 。该值应大于或等于 1。默认值为 1.5。

另请参阅 setAckTimeout()。

void QCoapClient::setAckTimeout(uint ackTimeout)

将RFC 7252 第 4.2 节中定义的“ACK_TIMEOUT ”值设置为ackTimeout （单位为毫秒）。默认值为 2000 毫秒。

此超时仅适用于可确认的消息。可靠传输的实际超时时间是ACK_TIMEOUT 与ACK_TIMEOUT * ACK_RANDOM_FACTOR 之间的一个随机值。

另请参阅 setAckRandomFactor()。

void QCoapClient::setBlockSize(quint16 blockSize)

将协议在发送请求和接收响应时使用的最大块大小设置为blockSize 。块大小必须是2的幂。

void QCoapClient::setMaximumRetransmitCount(uint maximumRetransmitCount)

将RFC 7252 第 4.2 节中定义的“MAX_RETRANSMIT ”值设置为maximumRetransmitCount 。该值应小于或等于 25。默认值为 4。

void QCoapClient::setMaximumServerResponseDelay(uint responseDelay)

将“MAX_SERVER_RESPONSE_DELAY ”的值设置为responseDelay （单位为毫秒）。默认值为250秒。

根据RFC 7390 第 2.5 节的定义， MAX_SERVER_RESPONSE_DELAY 是客户端可向其发送组播请求的所有服务器所预期的最大响应延迟。

void QCoapClient::setMinimumTokenSize(int tokenSize)

将令牌的最小大小设置为tokenSize 字节。出于安全考虑，建议使用长度至少为4字节的令牌。该参数的默认值为4字节。

void QCoapClient::setSecurityConfiguration(const QCoapSecurityConfiguration &configuration)

从configuration 中设置安全配置参数。如果使用QtCoap::NoSecurity 模式，则该配置将被忽略。

另请参阅 disconnect()。

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

将QUdpSocket 套接字option 设置为value 。