summaryrefslogtreecommitdiffstats
path: root/device
diff options
context:
space:
mode:
authorortuno <ortuno@chromium.org>2016-03-10 21:37:19 -0800
committerCommit bot <commit-bot@chromium.org>2016-03-11 05:39:39 +0000
commit7bc3d0031395dcf700b005c4933102f8897350f6 (patch)
treef369b637ec320a7bcaf2317f7fd037947cc2dedd /device
parent6cad14e7709b9578100415a641ec1ea3f0268e27 (diff)
downloadchromium_src-7bc3d0031395dcf700b005c4933102f8897350f6.zip
chromium_src-7bc3d0031395dcf700b005c4933102f8897350f6.tar.gz
chromium_src-7bc3d0031395dcf700b005c4933102f8897350f6.tar.bz2
bluetooth: Clarify how StartNotifySession function works
And what happens when the device doesn't have the expected descriptor. BUG=591864 Review URL: https://codereview.chromium.org/1758293003 Cr-Commit-Position: refs/heads/master@{#380538}
Diffstat (limited to 'device')
-rw-r--r--device/bluetooth/bluetooth_gatt_characteristic.h6
1 files changed, 6 insertions, 0 deletions
diff --git a/device/bluetooth/bluetooth_gatt_characteristic.h b/device/bluetooth/bluetooth_gatt_characteristic.h
index 6dabe87..8cce601 100644
--- a/device/bluetooth/bluetooth_gatt_characteristic.h
+++ b/device/bluetooth/bluetooth_gatt_characteristic.h
@@ -181,6 +181,12 @@ class DEVICE_BLUETOOTH_EXPORT BluetoothGattCharacteristic {
// notifications/indications. On success, the characteristic starts sending
// value notifications and |callback| is called with a session object whose
// ownership belongs to the caller. |error_callback| is called on errors.
+ //
+ // Writes to the Client Characteristic Configuration descriptor to enable
+ // notifications/indications. Core Bluetooth Specification [V4.2 Vol 3 Part G
+ // Section 3.3.1.1. Characteristic Properties] requires this descriptor to be
+ // present when notifications/indications are supported. If the descriptor is
+ // not present |error_callback| will be run.
virtual void StartNotifySession(const NotifySessionCallback& callback,
const ErrorCallback& error_callback) = 0;