API Bindings for GATT server functionality.

chrome/browser/extensions/api/bluetooth_low_energy/bluetooth_low_energy_api.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 CHROME_BROWSER_EXTENSIONS_API_BLUETOOTH_LOW_ENERGY_BLUETOOTH_LOW_ENERGY_API_H_
 #define CHROME_BROWSER_EXTENSIONS_API_BLUETOOTH_LOW_ENERGY_BLUETOOTH_LOW_ENERGY_API_H_
 
-#include <memory>
+#include <string>
 
 #include "base/macros.h"
+#include "base/memory/ref_counted.h"
+#include "chrome/browser/extensions/api/bluetooth_low_energy/bluetooth_api_advertisement.h"
 #include "chrome/browser/extensions/api/bluetooth_low_energy/bluetooth_low_energy_event_router.h"
-#include "chrome/browser/extensions/browser_context_keyed_service_factories.h"
+#include "content/public/browser/browser_context.h"
 #include "device/bluetooth/bluetooth_advertisement.h"
 #include "extensions/browser/api/api_resource_manager.h"
+#include "extensions/browser/browser_context_keyed_api_factory.h"
 #include "extensions/browser/extension_function.h"
 #include "extensions/browser/extension_function_histogram_value.h"
 
+namespace apibtle = extensions::api::bluetooth_low_energy;

[Devlin, 2016/05/02 22:27:58]

nit: this isn't typically allowed - only in .cc files where it doesn't pollute
the global namespace.

[rkc, 2016/05/02 23:25:50]

Done.

+
 namespace extensions {
-
 class BluetoothApiAdvertisement;
 class BluetoothLowEnergyEventRouter;
 
+namespace api {
+namespace bluetooth_low_energy {
+namespace CreateService {
+struct Params;
+}
+namespace CreateCharacteristic {
+struct Params;
+}
+namespace CreateDescriptor {
+struct Params;
+}
+namespace RegisterService {
+struct Params;
+}
+namespace UnregisterService {
+struct Params;
+}
+namespace SendRequestResponse {
+struct Params;
+}
+}  // namespace bluetooth_low_energy
+}  // namespace api
+
 // The profile-keyed service that manages the bluetoothLowEnergy extension API.
 class BluetoothLowEnergyAPI : public BrowserContextKeyedAPI {
  public:
   static BrowserContextKeyedAPIFactory<BluetoothLowEnergyAPI>*
       GetFactoryInstance();
 
   // Convenience method to get the BluetoothLowEnergy API for a browser context.
   static BluetoothLowEnergyAPI* Get(content::BrowserContext* context);
 
   explicit BluetoothLowEnergyAPI(content::BrowserContext* context);
@@ skipping 17 matching lines @@
   std::unique_ptr<BluetoothLowEnergyEventRouter> event_router_;
 
   DISALLOW_COPY_AND_ASSIGN(BluetoothLowEnergyAPI);
 };
 
 namespace api {
 
 // Base class for bluetoothLowEnergy API functions. This class handles some of
 // the common logic involved in all API functions, such as checking for
 // platform support and returning the correct error.
-class BluetoothLowEnergyExtensionFunction : public AsyncExtensionFunction {
+//
+// DEPRECATED: This inherits from AsyncExtensionFunction, which we're trying to
+// get rid of for various reasons. Please inherit from the
+// BluetoothLowEnergyExtensionFunction class instead.
+class BluetoothLowEnergyExtensionFunctionDeprecated
+    : public AsyncExtensionFunction {
  public:
-  BluetoothLowEnergyExtensionFunction();
+  BluetoothLowEnergyExtensionFunctionDeprecated();
 
  protected:
-  ~BluetoothLowEnergyExtensionFunction() override;
+  ~BluetoothLowEnergyExtensionFunctionDeprecated() override;
 
-  // ExtensionFunction override.
+  // AsyncExtensionFunction override.
   bool RunAsync() override;
 
   // Implemented by individual bluetoothLowEnergy extension functions to perform
   // the body of the function. This invoked asynchonously after RunAsync after
   // the BluetoothLowEnergyEventRouter has obtained a handle on the
   // BluetoothAdapter.
   virtual bool DoWork() = 0;
 
  private:
+  DISALLOW_COPY_AND_ASSIGN(BluetoothLowEnergyExtensionFunctionDeprecated);
+};
+
+// Replacement for BluetoothLowEnergyExtensionFunctionDeprecated. Has the same
+// functionality except that instead of the SendResponse/return combo, we'll
+// return our response with Respond().
+class BluetoothLowEnergyExtensionFunction : public UIThreadExtensionFunction {
+ public:
+  BluetoothLowEnergyExtensionFunction();
+
+ protected:
+  ~BluetoothLowEnergyExtensionFunction() override;
+
+  // ExtensionFunction override.
+  ResponseAction Run() override;
+
+  // Implemented by individual bluetoothLowEnergy extension functions to perform
+  // the body of the function. This invoked asynchonously after Run after
+  // the BluetoothLowEnergyEventRouter has obtained a handle on the
+  // BluetoothAdapter.
+  virtual void DoWork() = 0;
+
+ private:
   DISALLOW_COPY_AND_ASSIGN(BluetoothLowEnergyExtensionFunction);
 };
 
+// Base class for bluetoothLowEnergy API peripheral mode functions. This class
+// handles some of the common logic involved in all API peripheral mode
+// functions, such as checking for peripheral permissions and returning the
+// correct error.
+template <typename Params>
+class BLEPeripheralExtensionFunction
+    : public BluetoothLowEnergyExtensionFunction {
+ public:
+  BLEPeripheralExtensionFunction();
+
+ protected:
+  ~BLEPeripheralExtensionFunction() override;
+
+  // ExtensionFunction override.
+  ResponseAction Run() override;
+
+  std::unique_ptr<Params> params_;
+
+ private:
+  DISALLOW_COPY_AND_ASSIGN(BLEPeripheralExtensionFunction);
+};
+
 class BluetoothLowEnergyConnectFunction
-    : public BluetoothLowEnergyExtensionFunction {
+    : public BluetoothLowEnergyExtensionFunctionDeprecated {
  public:
   DECLARE_EXTENSION_FUNCTION("bluetoothLowEnergy.connect",
                              BLUETOOTHLOWENERGY_CONNECT);
 
  protected:
   ~BluetoothLowEnergyConnectFunction() override {}
 
-  // BluetoothLowEnergyExtensionFunction override.
+  // BluetoothLowEnergyExtensionFunctionDeprecated override.
   bool DoWork() override;
 
  private:
   // Success and error callbacks, called by
   // BluetoothLowEnergyEventRouter::Connect.
   void SuccessCallback();
   void ErrorCallback(BluetoothLowEnergyEventRouter::Status status);
 };
 
 class BluetoothLowEnergyDisconnectFunction
-    : public BluetoothLowEnergyExtensionFunction {
+    : public BluetoothLowEnergyExtensionFunctionDeprecated {
  public:
   DECLARE_EXTENSION_FUNCTION("bluetoothLowEnergy.disconnect",
                              BLUETOOTHLOWENERGY_DISCONNECT);
 
  protected:
   ~BluetoothLowEnergyDisconnectFunction() override {}
 
-  // BluetoothLowEnergyExtensionFunction override.
+  // BluetoothLowEnergyExtensionFunctionDeprecated override.
   bool DoWork() override;
 
  private:
   // Success and error callbacks, called by
   // BluetoothLowEnergyEventRouter::Disconnect.
   void SuccessCallback();
   void ErrorCallback(BluetoothLowEnergyEventRouter::Status status);
 };
 
 class BluetoothLowEnergyGetServiceFunction
-    : public BluetoothLowEnergyExtensionFunction {
+    : public BluetoothLowEnergyExtensionFunctionDeprecated {
  public:
   DECLARE_EXTENSION_FUNCTION("bluetoothLowEnergy.getService",
                              BLUETOOTHLOWENERGY_GETSERVICE);
 
  protected:
   ~BluetoothLowEnergyGetServiceFunction() override {}
 
-  // BluetoothLowEnergyExtensionFunction override.
+  // BluetoothLowEnergyExtensionFunctionDeprecated override.
   bool DoWork() override;
 };
 
 class BluetoothLowEnergyGetServicesFunction
-    : public BluetoothLowEnergyExtensionFunction {
+    : public BluetoothLowEnergyExtensionFunctionDeprecated {
  public:
   DECLARE_EXTENSION_FUNCTION("bluetoothLowEnergy.getServices",
                              BLUETOOTHLOWENERGY_GETSERVICES);
 
  protected:
   ~BluetoothLowEnergyGetServicesFunction() override {}
 
-  // BluetoothLowEnergyExtensionFunction override.
+  // BluetoothLowEnergyExtensionFunctionDeprecated override.
   bool DoWork() override;
 };
 
 class BluetoothLowEnergyGetCharacteristicFunction
-    : public BluetoothLowEnergyExtensionFunction {
+    : public BluetoothLowEnergyExtensionFunctionDeprecated {
  public:
   DECLARE_EXTENSION_FUNCTION("bluetoothLowEnergy.getCharacteristic",
                              BLUETOOTHLOWENERGY_GETCHARACTERISTIC);
 
  protected:
   ~BluetoothLowEnergyGetCharacteristicFunction() override {}
 
-  // BluetoothLowEnergyExtensionFunction override.
+  // BluetoothLowEnergyExtensionFunctionDeprecated override.
   bool DoWork() override;
 };
 
 class BluetoothLowEnergyGetCharacteristicsFunction
-    : public BluetoothLowEnergyExtensionFunction {
+    : public BluetoothLowEnergyExtensionFunctionDeprecated {
  public:
   DECLARE_EXTENSION_FUNCTION("bluetoothLowEnergy.getCharacteristics",
                              BLUETOOTHLOWENERGY_GETCHARACTERISTICS);
 
  protected:
   ~BluetoothLowEnergyGetCharacteristicsFunction() override {}
 
-  // BluetoothLowEnergyExtensionFunction override.
+  // BluetoothLowEnergyExtensionFunctionDeprecated override.
   bool DoWork() override;
 };
 
 class BluetoothLowEnergyGetIncludedServicesFunction
-    : public BluetoothLowEnergyExtensionFunction {
+    : public BluetoothLowEnergyExtensionFunctionDeprecated {
  public:
   DECLARE_EXTENSION_FUNCTION("bluetoothLowEnergy.getIncludedServices",
                              BLUETOOTHLOWENERGY_GETINCLUDEDSERVICES);
 
  protected:
   ~BluetoothLowEnergyGetIncludedServicesFunction() override {}
 
-  // BluetoothLowEnergyExtensionFunction override.
+  // BluetoothLowEnergyExtensionFunctionDeprecated override.
   bool DoWork() override;
 };
 
 class BluetoothLowEnergyGetDescriptorFunction
-    : public BluetoothLowEnergyExtensionFunction {
+    : public BluetoothLowEnergyExtensionFunctionDeprecated {
  public:
   DECLARE_EXTENSION_FUNCTION("bluetoothLowEnergy.getDescriptor",
                              BLUETOOTHLOWENERGY_GETDESCRIPTOR);
 
  protected:
   ~BluetoothLowEnergyGetDescriptorFunction() override {}
 
-  // BluetoothLowEnergyExtensionFunction override.
+  // BluetoothLowEnergyExtensionFunctionDeprecated override.
   bool DoWork() override;
 };
 
 class BluetoothLowEnergyGetDescriptorsFunction
-    : public BluetoothLowEnergyExtensionFunction {
+    : public BluetoothLowEnergyExtensionFunctionDeprecated {
  public:
   DECLARE_EXTENSION_FUNCTION("bluetoothLowEnergy.getDescriptors",
                              BLUETOOTHLOWENERGY_GETDESCRIPTORS);
 
  protected:
   ~BluetoothLowEnergyGetDescriptorsFunction() override {}
 
-  // BluetoothLowEnergyExtensionFunction override.
+  // BluetoothLowEnergyExtensionFunctionDeprecated override.
   bool DoWork() override;
 };
 
 class BluetoothLowEnergyReadCharacteristicValueFunction
-    : public BluetoothLowEnergyExtensionFunction {
+    : public BluetoothLowEnergyExtensionFunctionDeprecated {
  public:
   DECLARE_EXTENSION_FUNCTION("bluetoothLowEnergy.readCharacteristicValue",
                              BLUETOOTHLOWENERGY_READCHARACTERISTICVALUE);
 
  protected:
   ~BluetoothLowEnergyReadCharacteristicValueFunction() override {}
 
-  // BluetoothLowEnergyExtensionFunction override.
+  // BluetoothLowEnergyExtensionFunctionDeprecated override.
   bool DoWork() override;
 
  private:
   // Success and error callbacks, called by
   // BluetoothLowEnergyEventRouter::ReadCharacteristicValue.
   void SuccessCallback();
   void ErrorCallback(BluetoothLowEnergyEventRouter::Status status);
 
   // The instance ID of the requested characteristic.
   std::string instance_id_;
 };
 
 class BluetoothLowEnergyWriteCharacteristicValueFunction
-    : public BluetoothLowEnergyExtensionFunction {
+    : public BluetoothLowEnergyExtensionFunctionDeprecated {
  public:
   DECLARE_EXTENSION_FUNCTION("bluetoothLowEnergy.writeCharacteristicValue",
                              BLUETOOTHLOWENERGY_WRITECHARACTERISTICVALUE);
 
  protected:
   ~BluetoothLowEnergyWriteCharacteristicValueFunction() override {}
 
-  // BluetoothLowEnergyExtensionFunction override.
+  // BluetoothLowEnergyExtensionFunctionDeprecated override.
   bool DoWork() override;
 
  private:
   // Success and error callbacks, called by
   // BluetoothLowEnergyEventRouter::WriteCharacteristicValue.
   void SuccessCallback();
   void ErrorCallback(BluetoothLowEnergyEventRouter::Status status);
 
   // The instance ID of the requested characteristic.
   std::string instance_id_;
 };
 
 class BluetoothLowEnergyStartCharacteristicNotificationsFunction
-    : public BluetoothLowEnergyExtensionFunction {
+    : public BluetoothLowEnergyExtensionFunctionDeprecated {
  public:
   DECLARE_EXTENSION_FUNCTION(
       "bluetoothLowEnergy.startCharacteristicNotifications",
       BLUETOOTHLOWENERGY_STARTCHARACTERISTICNOTIFICATIONS);
 
  protected:
   ~BluetoothLowEnergyStartCharacteristicNotificationsFunction() override {}
 
-  // BluetoothLowEnergyExtensionFunction override.
+  // BluetoothLowEnergyExtensionFunctionDeprecated override.
   bool DoWork() override;
 
  private:
   // Success and error callbacks, called by
   // BluetoothLowEnergyEventRouter::StartCharacteristicNotifications.
   void SuccessCallback();
   void ErrorCallback(BluetoothLowEnergyEventRouter::Status status);
 };
 
 class BluetoothLowEnergyStopCharacteristicNotificationsFunction
-    : public BluetoothLowEnergyExtensionFunction {
+    : public BluetoothLowEnergyExtensionFunctionDeprecated {
  public:
   DECLARE_EXTENSION_FUNCTION(
       "bluetoothLowEnergy.stopCharacteristicNotifications",
       BLUETOOTHLOWENERGY_STOPCHARACTERISTICNOTIFICATIONS);
 
  protected:
   ~BluetoothLowEnergyStopCharacteristicNotificationsFunction() override {}
 
-  // BluetoothLowEnergyExtensionFunction override.
+  // BluetoothLowEnergyExtensionFunctionDeprecated override.
   bool DoWork() override;
 
  private:
   // Success and error callbacks, called by
   // BluetoothLowEnergyEventRouter::StopCharacteristicNotifications.
   void SuccessCallback();
   void ErrorCallback(BluetoothLowEnergyEventRouter::Status status);
 };
 
 class BluetoothLowEnergyReadDescriptorValueFunction
-    : public BluetoothLowEnergyExtensionFunction {
+    : public BluetoothLowEnergyExtensionFunctionDeprecated {
  public:
   DECLARE_EXTENSION_FUNCTION("bluetoothLowEnergy.readDescriptorValue",
                              BLUETOOTHLOWENERGY_READDESCRIPTORVALUE);
 
  protected:
   ~BluetoothLowEnergyReadDescriptorValueFunction() override {}
 
-  // BluetoothLowEnergyExtensionFunction override.
+  // BluetoothLowEnergyExtensionFunctionDeprecated override.
   bool DoWork() override;
 
  private:
   // Success and error callbacks, called by
   // BluetoothLowEnergyEventRouter::ReadDescriptorValue.
   void SuccessCallback();
   void ErrorCallback(BluetoothLowEnergyEventRouter::Status status);
 
   // The instance ID of the requested descriptor.
   std::string instance_id_;
 };
 
 class BluetoothLowEnergyWriteDescriptorValueFunction
-    : public BluetoothLowEnergyExtensionFunction {
+    : public BluetoothLowEnergyExtensionFunctionDeprecated {
  public:
   DECLARE_EXTENSION_FUNCTION("bluetoothLowEnergy.writeDescriptorValue",
                              BLUETOOTHLOWENERGY_WRITEDESCRIPTORVALUE);
 
  protected:
   ~BluetoothLowEnergyWriteDescriptorValueFunction() override {}
 
-  // BluetoothLowEnergyExtensionFunction override.
+  // BluetoothLowEnergyExtensionFunctionDeprecated override.
   bool DoWork() override;
 
  private:
   // Success and error callbacks, called by
   // BluetoothLowEnergyEventRouter::WriteDescriptorValue.
   void SuccessCallback();
   void ErrorCallback(BluetoothLowEnergyEventRouter::Status status);
 
   // The instance ID of the requested descriptor.
   std::string instance_id_;
 };
 
 class BluetoothLowEnergyAdvertisementFunction
-    : public BluetoothLowEnergyExtensionFunction {
+    : public BluetoothLowEnergyExtensionFunctionDeprecated {
  public:
   BluetoothLowEnergyAdvertisementFunction();
 
  protected:
   ~BluetoothLowEnergyAdvertisementFunction() override;
 
   // Takes ownership.
   int AddAdvertisement(BluetoothApiAdvertisement* advertisement);
   BluetoothApiAdvertisement* GetAdvertisement(int advertisement_id);
   void RemoveAdvertisement(int advertisement_id);
@@ skipping 11 matching lines @@
 
 class BluetoothLowEnergyRegisterAdvertisementFunction
     : public BluetoothLowEnergyAdvertisementFunction {
  public:
   DECLARE_EXTENSION_FUNCTION("bluetoothLowEnergy.registerAdvertisement",
                              BLUETOOTHLOWENERGY_REGISTERADVERTISEMENT);
 
  protected:
   ~BluetoothLowEnergyRegisterAdvertisementFunction() override {}
 
-  // BluetoothLowEnergyExtensionFunction override.
+  // BluetoothLowEnergyExtensionFunctionDeprecated override.
   bool DoWork() override;
 
  private:
   void SuccessCallback(scoped_refptr<device::BluetoothAdvertisement>);
   void ErrorCallback(device::BluetoothAdvertisement::ErrorCode status);
 
   // The instance ID of the requested descriptor.
   std::string instance_id_;
 };
 
 class BluetoothLowEnergyUnregisterAdvertisementFunction
     : public BluetoothLowEnergyAdvertisementFunction {
  public:
   DECLARE_EXTENSION_FUNCTION("bluetoothLowEnergy.unregisterAdvertisement",
                              BLUETOOTHLOWENERGY_UNREGISTERADVERTISEMENT);
 
  protected:
   ~BluetoothLowEnergyUnregisterAdvertisementFunction() override {}
 
-  // BluetoothLowEnergyExtensionFunction override.
+  // BluetoothLowEnergyExtensionFunctionDeprecated override.
   bool DoWork() override;
 
  private:
   void SuccessCallback(int advertisement_id);
   void ErrorCallback(int advertisement_id,
                      device::BluetoothAdvertisement::ErrorCode status);
 
   // The instance ID of the requested descriptor.
   std::string instance_id_;
 };
 
+class BluetoothLowEnergyCreateServiceFunction
+    : public BLEPeripheralExtensionFunction<apibtle::CreateService::Params> {
+ public:
+  DECLARE_EXTENSION_FUNCTION("bluetoothLowEnergy.createService",
+                             BLUETOOTHLOWENERGY_CREATESERVICE);
+
+ protected:
+  ~BluetoothLowEnergyCreateServiceFunction() override {}
+
+  // BluetoothLowEnergyPeripheralExtensionFunction override.
+  void DoWork() override;
+};
+
+class BluetoothLowEnergyCreateCharacteristicFunction
+    : public BLEPeripheralExtensionFunction<
+          apibtle::CreateCharacteristic::Params> {
+ public:
+  DECLARE_EXTENSION_FUNCTION("bluetoothLowEnergy.createCharacteristic",
+                             BLUETOOTHLOWENERGY_CREATECHARACTERISTIC);
+
+ protected:
+  ~BluetoothLowEnergyCreateCharacteristicFunction() override {}
+
+  // BluetoothLowEnergyPeripheralExtensionFunction override.
+  void DoWork() override;
+};
+
+class BluetoothLowEnergyCreateDescriptorFunction
+    : public BLEPeripheralExtensionFunction<apibtle::CreateDescriptor::Params> {
+ public:
+  DECLARE_EXTENSION_FUNCTION("bluetoothLowEnergy.createDescriptor",
+                             BLUETOOTHLOWENERGY_CREATEDESCRIPTOR);
+
+ protected:
+  ~BluetoothLowEnergyCreateDescriptorFunction() override {}
+
+  // BluetoothLowEnergyPeripheralExtensionFunction override.
+  void DoWork() override;
+};
+
+class BluetoothLowEnergyRegisterServiceFunction
+    : public BLEPeripheralExtensionFunction<apibtle::RegisterService::Params> {
+ public:
+  DECLARE_EXTENSION_FUNCTION("bluetoothLowEnergy.registerService",
+                             BLUETOOTHLOWENERGY_REGISTERSERVICE);
+
+ protected:
+  ~BluetoothLowEnergyRegisterServiceFunction() override {}
+
+  // BluetoothLowEnergyPeripheralExtensionFunction override.
+  void DoWork() override;
+};
+
+class BluetoothLowEnergyUnregisterServiceFunction
+    : public BLEPeripheralExtensionFunction<
+          apibtle::UnregisterService::Params> {
+ public:
+  DECLARE_EXTENSION_FUNCTION("bluetoothLowEnergy.unregisterService",
+                             BLUETOOTHLOWENERGY_UNREGISTERSERVICE);
+
+ protected:
+  ~BluetoothLowEnergyUnregisterServiceFunction() override {}
+
+  // BluetoothLowEnergyPeripheralExtensionFunction override.
+  void DoWork() override;
+};
+
+class BluetoothLowEnergySendRequestResponseFunction
+    : public BLEPeripheralExtensionFunction<
+          apibtle::SendRequestResponse::Params> {
+ public:
+  DECLARE_EXTENSION_FUNCTION("bluetoothLowEnergy.sendRequestResponse",
+                             BLUETOOTHLOWENERGY_SENDREQUESTRESPONSE);
+
+ protected:
+  ~BluetoothLowEnergySendRequestResponseFunction() override {}
+
+  // BluetoothLowEnergyPeripheralExtensionFunction override.
+  void DoWork() override;
+};
+
 }  // namespace api
 }  // namespace extensions
 
 #endif  // CHROME_BROWSER_EXTENSIONS_API_BLUETOOTH_LOW_ENERGY_BLUETOOTH_LOW_ENERGY_API_H_