diff options
author | Maurice Kalinowski <maurice.kalinowski@qt.io> | 2018-08-02 08:59:43 +0200 |
---|---|---|
committer | Maurice Kalinowski <maurice.kalinowski@qt.io> | 2018-08-09 09:27:42 +0000 |
commit | c129d6650508063e438e80f4c755159ead413e28 (patch) | |
tree | 7bb9a587a4c3e59625dc2fe35069a98de7d4c465 /src | |
parent | ac42d33351519e42be93c2585a8a9b15832d5d7f (diff) |
Update documentation on QMqttClient::setTransport
The client does not take ownership on connection management. This has
not been made clear in the documentation so far and caused to wrong
usage of the client.
Task-number: QTBUG-69305
Task-number: QTBUG-68031
Change-Id: I11186478e241c860760aa187d03458ccb7601eee
Reviewed-by: hjk <hjk@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Diffstat (limited to 'src')
-rw-r--r-- | src/mqtt/qmqttclient.cpp | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/src/mqtt/qmqttclient.cpp b/src/mqtt/qmqttclient.cpp index 8cf1661..5150663 100644 --- a/src/mqtt/qmqttclient.cpp +++ b/src/mqtt/qmqttclient.cpp @@ -283,6 +283,10 @@ QMqttClient::QMqttClient(QObject *parent) : QObject(*(new QMqttClientPrivate(thi \note The transport can only be exchanged if the MQTT client is in the \l Disconnected state. + + \note Setting a custom transport for a client does not pass over responsibility + on connection management. The transport has to be opened for QIODevice based + transports or connected for socket type transports before calling QMqttClient::connectToHost(). */ void QMqttClient::setTransport(QIODevice *device, QMqttClient::TransportType transport) { |