Improve QBluetoothSocket::close() documentation
The disconnected() and stateChanged() signals are delayed which may easily overlooked by API users. This change specifically points out this behavior difference. Change-Id: I3a9e9c656da50c9efe455cd2dbf903a2849e36da Task-number: QTBUG-41770 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
This commit is contained in:
parent
8c7dd769fc
commit
413d98ef93
|
@ -144,6 +144,10 @@ Q_DECLARE_LOGGING_CATEGORY(QT_BT_QNX)
|
||||||
Aborts the current connection and resets the socket. Unlike disconnectFromService(), this
|
Aborts the current connection and resets the socket. Unlike disconnectFromService(), this
|
||||||
function immediately closes the socket, discarding any pending data in the write buffer.
|
function immediately closes the socket, discarding any pending data in the write buffer.
|
||||||
|
|
||||||
|
\note On Android, aborting the socket requires asynchronous interaction with Android threads.
|
||||||
|
Therefore the associated \l disconnected() and \l stateChanged() signals are delayed
|
||||||
|
until the threads have finished the closure.
|
||||||
|
|
||||||
\sa disconnectFromService(), close()
|
\sa disconnectFromService(), close()
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
@ -151,6 +155,11 @@ Q_DECLARE_LOGGING_CATEGORY(QT_BT_QNX)
|
||||||
\fn void QBluetoothSocket::close()
|
\fn void QBluetoothSocket::close()
|
||||||
|
|
||||||
Disconnects the socket's connection with the device.
|
Disconnects the socket's connection with the device.
|
||||||
|
|
||||||
|
\note On Android, closing the socket requires asynchronous interaction with Android threads.
|
||||||
|
Therefore the associated \l disconnected() and \l stateChanged() signals are delayed
|
||||||
|
until the threads have finished the closure.
|
||||||
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
|
|
Loading…
Reference in New Issue