aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSona Kurazyan <sona.kurazyan@qt.io>2019-05-23 16:16:30 +0200
committerSona Kurazyan <sona.kurazyan@qt.io>2019-07-24 11:31:05 +0200
commitf3b29d9327aef74bcd5668c4a7377513c9b16b11 (patch)
tree148a5835d922cf0dd9aabfdacd301f775469079e
parent9c933b340023ae0399fd6cbe0f0ef84c3a46d12c (diff)
Improve QCoapClient's documentationv5.13.15.13.1
- Added more details for explaining the usage of the disconnect() method. - Fixed a warning. Change-Id: Ifa5a91d9df70592009545a467a47c840889ff516 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Simon Hausmann <simon.hausmann@qt.io>
-rw-r--r--src/coap/qcoapclient.cpp15
1 files changed, 12 insertions, 3 deletions
diff --git a/src/coap/qcoapclient.cpp b/src/coap/qcoapclient.cpp
index 999c5ea..367ef5d 100644
--- a/src/coap/qcoapclient.cpp
+++ b/src/coap/qcoapclient.cpp
@@ -486,8 +486,8 @@ QCoapReply *QCoapClient::observe(const QUrl &url)
/*!
\overload
- Cancels the observation of a resource using the reply returned by the
- observe() method.
+ Cancels the observation of a resource using the reply \a notifiedReply returned by
+ the observe() method.
\sa observe()
*/
@@ -514,6 +514,11 @@ void QCoapClient::cancelObserve(const QUrl &url)
/*!
Closes the open sockets and connections to free the transport.
+
+ \note In the secure mode this needs to be called before changing
+ the security configuration or connecting to another server.
+
+ \sa setSecurityConfiguration()
*/
void QCoapClient::disconnect()
{
@@ -601,7 +606,11 @@ bool QCoapClientPrivate::send(QCoapReply *reply)
Sets the security configuration parameters from \a configuration.
Configuration will be ignored if the QtCoap::NoSecurity mode is used.
- \note This method must be called before the handshake starts.
+ \note This method must be called before the handshake starts. If you need
+ to change the security configuration after establishing a secure connection
+ with the server, the client needs to be disconnected first.
+
+ \sa disconnect()
*/
void QCoapClient::setSecurityConfiguration(const QCoapSecurityConfiguration &configuration)
{