summaryrefslogtreecommitdiffstats
path: root/java
diff options
context:
space:
mode:
authorSven Gothel <[email protected]>2020-08-28 07:30:23 +0200
committerSven Gothel <[email protected]>2020-08-28 07:30:23 +0200
commitbae1b8630367f89f290fce5d3e3766cb5455de1e (patch)
tree2306946b6b98bf78b9f20460120738ed33285bbe /java
parent764c96515f3d0339ec486d8659db25016336fdbe (diff)
DBTDevice::pingGATT(): Disconnect and return false if: GATT not connected or no GATTServices available
This required getGATTServices() (C++) or getServices() (Java) to be completed, hence added remark in API doc. Reasoning is that pingGATT shall not initiated resource creation, but assumes all set set up well. If failing, it shall cause a disconnected.
Diffstat (limited to 'java')
-rw-r--r--java/org/tinyb/BluetoothDevice.java7
1 files changed, 5 insertions, 2 deletions
diff --git a/java/org/tinyb/BluetoothDevice.java b/java/org/tinyb/BluetoothDevice.java
index 03d21e0f..5cc8ff63 100644
--- a/java/org/tinyb/BluetoothDevice.java
+++ b/java/org/tinyb/BluetoothDevice.java
@@ -207,9 +207,12 @@ public interface BluetoothDevice extends BluetoothObject
* <p>
* In case the device is no more reachable, disconnect will be initiated due to the occurring IO error.
* </p>
- *
- * @return {@code true} if successful or not implemented, otherwise false in case GATT connection failed.
+ * <p>
+ * GATT services must have been initialized via {@link #getServices()}, otherwise {@code false} is being returned.
+ * </p>
+ * @return {@code true} if successful or not implemented, otherwise false in case no GATT services exists or is not connected..
* @since 2.0.0
+ * @implNote not implemented in tinyb.dbus.
*/
boolean pingGATT();