bluetooh: Define new connectGATT and WebBluetoothGATTRemoteServer

public/platform/modules/bluetooth/WebBluetooth.h

 // Copyright 2014 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef WebBluetooth_h
 #define WebBluetooth_h
 
 #include "public/platform/WebCallbacks.h"
 
 namespace blink {
 
 struct WebBluetoothDevice;
 struct WebBluetoothError;
+struct WebBluetoothGATTRemoteServer;
 
 // Success and failure callbacks for requestDevice.
 // WebBluetoothDevice and WebBluetoothError object ownership is transfered.
 typedef WebCallbacks<WebBluetoothDevice, WebBluetoothError> WebBluetoothRequestDeviceCallbacks;
 
+// Success and failure callbacks for connectGATT.
+typedef WebCallbacks<WebBluetoothGATTRemoteServer, WebBluetoothError> WebBluetoothConnectGATTCallbacks;
+
 class WebBluetooth {
 public:
     virtual ~WebBluetooth() { }
 
-    // Requests a bluetooth device.
+    // BluetoothDiscovery Methods:
+    // See https://webbluetoothcg.github.io/web-bluetooth/#idl-def-bluetoothdiscovery
     // WebBluetoothRequestDeviceCallbacks ownership transferred to the client.

[Jeffrey Yasskin, 2015/04/17 23:45:08]

Should we have a comment like this for the ownership transfer in connectGATT()?
If so, use "callee" instead of "client" or s/to the client/into connectGATT()/.
(I'd read "client" as referring to the caller, but there's no way to pass
ownership to the caller with this interface.)

[ortuno, 2015/04/20 18:32:44]

Done

     virtual void requestDevice(WebBluetoothRequestDeviceCallbacks*) = 0;
+
+    // BluetoothDevice methods:

[scheib, 2015/04/18 00:06:52]

OK, we're going 'monolithic' which we agreed with prudent for the expected size
of APIs and overhead in splitting them. We'll need to have methods not conflict.
Most won't, but there are a few:

BluetoothGATTCharacteristic.readValue
BluetoothGATTDescriptor.readValue

BluetoothGATTCharacteristic.writeValue
BluetoothGATTDescriptor.writeValue

BluetoothInteraction.getCharacteristic
BluetoothGATTService.getCharacteristic

BluetoothInteraction.getDescriptor
BluetoothGATTCharacteristic.getDescriptor

We could decorate the names of all methods we add here, giving them context.
But, I think that's overkill since most won't conflict.

We can decorate in a few ways for the few that will conflict, here's my guess of
what we can do: <method name>Of<Interface>
readValueOfCharacteristic
readValueOfDescriptor
...
getCharacteristic
getCharacteristicOfService

So, for now this is good, just wanted to think that through as changing the
interface is painful.

[ortuno, 2015/04/20 18:32:44]

Ack.

+    // See https://webbluetoothcg.github.io/web-bluetooth/#idl-def-bluetoothdevice
+    virtual void connectGATT(std::string, WebBluetoothConnectGATTCallbacks*) { }

[Jeffrey Yasskin, 2015/04/17 23:45:08]

Great! You're following the advice from
https://github.com/WebBluetoothCG/web-bluetooth/issues/83.

[Jeffrey Yasskin, 2015/04/17 23:45:08]

Comment what this string means, or give the argument a descriptive name. It's
the device's instanceID, right?

[scheib, 2015/04/19 05:40:37]

It is instanceID, oops I overlooked this too: Please use a consistent type for
instanceID across the blink interface. WebString
https://code.google.com/p/chromium/codesearch#chromium/src/third_party/WebKit...

[ortuno, 2015/04/20 18:32:44]

Done.

[ortuno, 2015/04/20 18:32:44]

Done.

+
+    // BluetoothGATTRemoteServer methods:
+    // See https://webbluetoothcg.github.io/web-bluetooth/#idl-def-bluetoothgattremoteserver
+    virtual void disconnect() { }
+    // TODO(ortuno): Properly define this methods once WebBluetoothServiceUuid and

[Jeffrey Yasskin, 2015/04/17 23:45:08]

s/this/these/

[scheib, 2015/04/18 00:06:52]

s/this/these/. If line wrapping, do so before 80 columns.

[ortuno, 2015/04/20 18:32:44]

Done.

+    // WebBluetoothGATTService are defined.
+    // virtual void getPrimaryService() { }
+    // virtual void getPrimaryServices() { }
 };
 
 } // namespace blink
 
 #endif // WebBluetooth_h