diff options
| author | Alex Blasche <alexander.blasche@qt.io> | 2017-06-29 15:12:42 +0200 |
|---|---|---|
| committer | Timur Pocheptsov <timur.pocheptsov@qt.io> | 2017-06-29 13:23:54 +0000 |
| commit | 225ba9d013073b27b6c4d2b3eee3720b09f5a379 (patch) | |
| tree | 5623ac744da0b82680ff34d981862bbae56a380a /src/bluetooth/qbluetoothdevicediscoveryagent.cpp | |
| parent | 29b98ef4a4a34497cfcb6091554809673024340e (diff) | |
Update doc for QBluetoothDeviceDiscoveryAgent::deviceDiscovered()
lowEnergyDiscoveryTimeout affects the emission behavior of
deviceDiscovered(). This behavior change should be explicitly
documented.
Task-number: QTBUG-57847
Change-Id: I94bd7cb36935b376c34ba90f5de4e3084e87e883
Reviewed-by: Timur Pocheptsov <timur.pocheptsov@qt.io>
Diffstat (limited to 'src/bluetooth/qbluetoothdevicediscoveryagent.cpp')
| -rw-r--r-- | src/bluetooth/qbluetoothdevicediscoveryagent.cpp | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/src/bluetooth/qbluetoothdevicediscoveryagent.cpp b/src/bluetooth/qbluetoothdevicediscoveryagent.cpp index b033ae3c..02ea30d1 100644 --- a/src/bluetooth/qbluetoothdevicediscoveryagent.cpp +++ b/src/bluetooth/qbluetoothdevicediscoveryagent.cpp @@ -143,7 +143,15 @@ Q_DECLARE_LOGGING_CATEGORY(QT_BT) information via \l discoveredDevices() once the discovery has finished. This will yield the most recent RSSI information. - \sa QBluetoothDeviceInfo::rssi() + If \l lowEnergyDiscoveryTimeout() is larger than 0 the signal is only ever + emitted when at least one attribute of \a info changes. This reflects the desire to + receive updates as more precise information becomes available. The exception to this + behavior is the case when \l lowEnergyDiscoveryTimeout is set to \c 0. A timeout of \c 0 + expresses the desire to monitor the appearance and disappearance of Low Energy devices + over time. Under this condition the \l deviceDiscovered() signal is emitted even if + \a info has not changed since the last signal emission. + + \sa QBluetoothDeviceInfo::rssi(), lowEnergyDiscoveryTimeout() */ /*! |