summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlex Blasche <alexander.blasche@qt.io>2020-05-13 10:28:58 +0200
committerAlex Blasche <alexander.blasche@qt.io>2020-05-14 12:53:25 +0000
commitc580f1fcad437174e83ce5857f285ce533af9b69 (patch)
treeef0a6c44aa3d956f08f99d7115f806b453ab0784
parenta5344c74bdee705750bfa4bfc9d7ca4a6c4de87a (diff)
downloadqtconnectivity-c580f1fcad437174e83ce5857f285ce533af9b69.tar.gz
Rename QLEService::DiscoveringServices to DiscoveringService
Singular is a better fit to avoid the notion of several services being discovered at a given time. [ChangeLog][QtBluetooth][QLowEnergyService] Renamed DiscoveringServices enum value to DiscoveringService. Task-number: QTBUG-75344 Change-Id: I9ebe8a8ccba8bb49c55772ae81338f376826ee64 Reviewed-by: Timur Pocheptsov <timur.pocheptsov@qt.io>
-rw-r--r--examples/bluetooth/heartrate-game/devicehandler.cpp2
-rw-r--r--examples/bluetooth/lowenergyscanner/device.cpp2
-rw-r--r--examples/bluetooth/lowenergyscanner/doc/src/lowenergyscanner.qdoc2
-rw-r--r--src/bluetooth/ApiChangesQt6.txt6
-rw-r--r--src/bluetooth/doc/snippets/doc_src_qtbluetooth.cpp2
-rw-r--r--src/bluetooth/doc/src/bluetooth-le-overview.qdoc2
-rw-r--r--src/bluetooth/qlowenergycontroller_darwin.mm2
-rw-r--r--src/bluetooth/qlowenergycontroller_winrt.cpp2
-rw-r--r--src/bluetooth/qlowenergycontroller_winrt_new.cpp2
-rw-r--r--src/bluetooth/qlowenergyservice.cpp6
-rw-r--r--src/bluetooth/qlowenergyservice.h3
11 files changed, 18 insertions, 13 deletions
diff --git a/examples/bluetooth/heartrate-game/devicehandler.cpp b/examples/bluetooth/heartrate-game/devicehandler.cpp
index 83a4fbbe..a3937738 100644
--- a/examples/bluetooth/heartrate-game/devicehandler.cpp
+++ b/examples/bluetooth/heartrate-game/devicehandler.cpp
@@ -202,7 +202,7 @@ void DeviceHandler::serviceScanDone()
void DeviceHandler::serviceStateChanged(QLowEnergyService::ServiceState s)
{
switch (s) {
- case QLowEnergyService::DiscoveringServices:
+ case QLowEnergyService::DiscoveringService:
setInfo(tr("Discovering services..."));
break;
case QLowEnergyService::ServiceDiscovered:
diff --git a/examples/bluetooth/lowenergyscanner/device.cpp b/examples/bluetooth/lowenergyscanner/device.cpp
index e1d96be3..937ff4b4 100644
--- a/examples/bluetooth/lowenergyscanner/device.cpp
+++ b/examples/bluetooth/lowenergyscanner/device.cpp
@@ -320,7 +320,7 @@ void Device::serviceDetailsDiscovered(QLowEnergyService::ServiceState newState)
// in case the service discovery failed
// We have to queue the signal up to give UI time to even enter
// the above mode
- if (newState != QLowEnergyService::DiscoveringServices) {
+ if (newState != QLowEnergyService::DiscoveringService) {
QMetaObject::invokeMethod(this, "characteristicsUpdated",
Qt::QueuedConnection);
}
diff --git a/examples/bluetooth/lowenergyscanner/doc/src/lowenergyscanner.qdoc b/examples/bluetooth/lowenergyscanner/doc/src/lowenergyscanner.qdoc
index bb2372a0..a7d48de6 100644
--- a/examples/bluetooth/lowenergyscanner/doc/src/lowenergyscanner.qdoc
+++ b/examples/bluetooth/lowenergyscanner/doc/src/lowenergyscanner.qdoc
@@ -111,7 +111,7 @@
update potentially triggered by the internal logic.
During the initial detail search the service's \l {QLowEnergyService::state()}{state()} transitions
from \l {QLowEnergyService::DiscoveryRequired}{DiscoveryRequired} to
- \l {QLowEnergyService::DiscoveringServices}{DiscoveringServices} and eventually ends with
+ \l {QLowEnergyService::DiscoveringService}{DiscoveringService} and eventually ends with
\l {QLowEnergyService::ServiceDiscovered}{ServiceDiscovered}:
\snippet lowenergyscanner/device.cpp les-service-3
diff --git a/src/bluetooth/ApiChangesQt6.txt b/src/bluetooth/ApiChangesQt6.txt
index ddc5634a..95d8b69a 100644
--- a/src/bluetooth/ApiChangesQt6.txt
+++ b/src/bluetooth/ApiChangesQt6.txt
@@ -22,3 +22,9 @@ QBluetoothDeviceInfo
- QList<QBluetoothUuid> serviceUuids(DataCompleteness *completeness = nullptr) const was replaced by
QVector<QBluetoothUuid> serviceUuids() const.
+
+QLowEnergyService
+-----------------
+
+ - Renamed DiscoveringServices enum value to DiscoveringService. This properly relfects the fact that
+ only one service is being discovered at a given time.
diff --git a/src/bluetooth/doc/snippets/doc_src_qtbluetooth.cpp b/src/bluetooth/doc/snippets/doc_src_qtbluetooth.cpp
index a2c4d8b1..bb3b702c 100644
--- a/src/bluetooth/doc/snippets/doc_src_qtbluetooth.cpp
+++ b/src/bluetooth/doc/snippets/doc_src_qtbluetooth.cpp
@@ -216,7 +216,7 @@ void MyClass::btleSharedData()
first->discoverDetails();
- Q_ASSERT(first->state() == QLowEnergyService::DiscoveringServices);
+ Q_ASSERT(first->state() == QLowEnergyService::DiscoveringService);
Q_ASSERT(first->state() == second->state());
//! [data_share_qlowenergyservice]
}
diff --git a/src/bluetooth/doc/src/bluetooth-le-overview.qdoc b/src/bluetooth/doc/src/bluetooth-le-overview.qdoc
index 60181240..aa89745a 100644
--- a/src/bluetooth/doc/src/bluetooth-le-overview.qdoc
+++ b/src/bluetooth/doc/src/bluetooth-le-overview.qdoc
@@ -217,7 +217,7 @@ Low Energy devices.
During the detail search the service's \l {QLowEnergyService::state()}{state()} transitions
from \l {QLowEnergyService::DiscoveryRequired}{DiscoveryRequired} to
- \l {QLowEnergyService::DiscoveringServices}{DiscoveringServices} and eventually ends with
+ \l {QLowEnergyService::DiscoveringService}{DiscoveringService} and eventually ends with
\l {QLowEnergyService::ServiceDiscovered}{ServiceDiscovered}:
\snippet heartrate-game/devicehandler.cpp Find HRM characteristic
diff --git a/src/bluetooth/qlowenergycontroller_darwin.mm b/src/bluetooth/qlowenergycontroller_darwin.mm
index bbe7a4a6..0e33d1d3 100644
--- a/src/bluetooth/qlowenergycontroller_darwin.mm
+++ b/src/bluetooth/qlowenergycontroller_darwin.mm
@@ -302,7 +302,7 @@ void QLowEnergyControllerPrivateDarwin::discoverServiceDetails(const QBluetoothU
Q_ASSERT(leQueue);
ServicePrivate qtService(serviceList.value(serviceUuid));
- qtService->setState(QLowEnergyService::DiscoveringServices);
+ qtService->setState(QLowEnergyService::DiscoveringService);
// Copy objects ...
ObjCCentralManager *manager = centralManager.getAs<ObjCCentralManager>();
const QBluetoothUuid serviceUuidCopy(serviceUuid);
diff --git a/src/bluetooth/qlowenergycontroller_winrt.cpp b/src/bluetooth/qlowenergycontroller_winrt.cpp
index ab566bd9..60eda84d 100644
--- a/src/bluetooth/qlowenergycontroller_winrt.cpp
+++ b/src/bluetooth/qlowenergycontroller_winrt.cpp
@@ -592,7 +592,7 @@ void QLowEnergyControllerPrivateWinRT::discoverServiceDetails(const QBluetoothUu
qCDebug(QT_BT_WINRT_SERVICE_THREAD) << __FUNCTION__ << "Changing service pointer from thread"
<< QThread::currentThread();
- pointer->setState(QLowEnergyService::DiscoveringServices);
+ pointer->setState(QLowEnergyService::DiscoveringService);
ComPtr<IGattDeviceService2> deviceService2;
HRESULT hr = deviceService.As(&deviceService2);
Q_ASSERT_SUCCEEDED(hr);
diff --git a/src/bluetooth/qlowenergycontroller_winrt_new.cpp b/src/bluetooth/qlowenergycontroller_winrt_new.cpp
index f951d1a6..d8ea9c93 100644
--- a/src/bluetooth/qlowenergycontroller_winrt_new.cpp
+++ b/src/bluetooth/qlowenergycontroller_winrt_new.cpp
@@ -844,7 +844,7 @@ void QLowEnergyControllerPrivateWinRTNew::discoverServiceDetails(const QBluetoot
QSharedPointer<QLowEnergyServicePrivate> pointer = serviceList.value(service);
qCDebug(QT_BT_WINRT_SERVICE_THREAD) << __FUNCTION__ << "Changing service pointer from thread"
<< QThread::currentThread();
- pointer->setState(QLowEnergyService::DiscoveringServices);
+ pointer->setState(QLowEnergyService::DiscoveringService);
ComPtr<IGattDeviceService3> deviceService3;
HRESULT hr = deviceService.As(&deviceService3);
if (FAILED(hr)) {
diff --git a/src/bluetooth/qlowenergyservice.cpp b/src/bluetooth/qlowenergyservice.cpp
index 2e6d1f9b..b300103a 100644
--- a/src/bluetooth/qlowenergyservice.cpp
+++ b/src/bluetooth/qlowenergyservice.cpp
@@ -96,7 +96,7 @@ QT_BEGIN_NAMESPACE
The discovery of its included services, characteristics and descriptors
is triggered when calling \l discoverDetails(). During the discovery the
- \l state() transitions from \l DiscoveryRequired via \l DiscoveringServices
+ \l state() transitions from \l DiscoveryRequired via \l DiscoveringService
to its final \l ServiceDiscovered state. This transition is advertised via
the \l stateChanged() signal. Once the details are known, all of the contained
characteristics, descriptors and included services are known and can be read
@@ -228,7 +228,7 @@ QT_BEGIN_NAMESPACE
\value DiscoveryRequired The service details are yet to be discovered by calling \l discoverDetails().
The only reliable pieces of information are its
\l serviceUuid() and \l serviceName().
- \value DiscoveringServices The service details are being discovered.
+ \value DiscoveringService The service details are being discovered.
\value ServiceDiscovered The service details have been discovered.
\value LocalService The service is associated with a controller object in the
\l{QLowEnergyController::PeripheralRole}{peripheral role}. Such
@@ -573,7 +573,7 @@ void QLowEnergyService::discoverDetails()
if (d->state != QLowEnergyService::DiscoveryRequired)
return;
- d->setState(QLowEnergyService::DiscoveringServices);
+ d->setState(QLowEnergyService::DiscoveringService);
d->controller->discoverServiceDetails(d->uuid);
}
diff --git a/src/bluetooth/qlowenergyservice.h b/src/bluetooth/qlowenergyservice.h
index a2715471..b41bb200 100644
--- a/src/bluetooth/qlowenergyservice.h
+++ b/src/bluetooth/qlowenergyservice.h
@@ -72,8 +72,7 @@ public:
enum ServiceState {
InvalidService = 0,
DiscoveryRequired, // we know start/end handle but nothing more
- //TODO Rename DiscoveringServices -> DiscoveringDetails or DiscoveringService
- DiscoveringServices,// discoverDetails() called and running
+ DiscoveringService, // discoverDetails() called and running
ServiceDiscovered, // all details have been synchronized
LocalService,
};