Manage profiles in BluetoothAdapter on ChromeOS

device/bluetooth/bluetooth_adapter_chromeos.h

 // Copyright 2013 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 DEVICE_BLUETOOTH_BLUETOOTH_ADAPTER_CHROMEOS_H_
 #define DEVICE_BLUETOOTH_BLUETOOTH_ADAPTER_CHROMEOS_H_
 
+#include <map>
 #include <queue>
 #include <string>
 
 #include "base/memory/weak_ptr.h"
 #include "base/sequenced_task_runner.h"
 #include "chromeos/dbus/bluetooth_adapter_client.h"
 #include "chromeos/dbus/bluetooth_agent_service_provider.h"
 #include "chromeos/dbus/bluetooth_device_client.h"
 #include "chromeos/dbus/bluetooth_input_client.h"
+#include "chromeos/dbus/bluetooth_profile_manager_client.h"
+#include "chromeos/dbus/bluetooth_profile_service_provider.h"
 #include "dbus/object_path.h"
 #include "device/bluetooth/bluetooth_adapter.h"
 #include "device/bluetooth/bluetooth_device.h"
 #include "device/bluetooth/bluetooth_export.h"
 
 namespace device {
 class BluetoothSocketThread;
 }  // namespace device
 
 namespace chromeos {
 
 class BluetoothChromeOSTest;
+class BluetoothAdapterProfileChromeOS;
 class BluetoothDeviceChromeOS;
 class BluetoothPairingChromeOS;
 class BluetoothRemoteGattCharacteristicChromeOS;
 class BluetoothRemoteGattDescriptorChromeOS;
 class BluetoothRemoteGattServiceChromeOS;
 
 // The BluetoothAdapterChromeOS class implements BluetoothAdapter for the
 // Chrome OS platform.
 class DEVICE_BLUETOOTH_EXPORT BluetoothAdapterChromeOS
     : public device::BluetoothAdapter,
       public chromeos::BluetoothAdapterClient::Observer,
       public chromeos::BluetoothDeviceClient::Observer,
       public chromeos::BluetoothInputClient::Observer,
       public chromeos::BluetoothAgentServiceProvider::Delegate {
  public:
+  typedef base::Callback<void(const std::string& error_message)>
+      ErrorCompletionCallback;
+
   static base::WeakPtr<BluetoothAdapter> CreateAdapter();
 
   // BluetoothAdapter:
   void DeleteOnCorrectThread() const override;
   virtual void AddObserver(
       device::BluetoothAdapter::Observer* observer) override;
   virtual void RemoveObserver(
       device::BluetoothAdapter::Observer* observer) override;
   virtual std::string GetAddress() const override;
   virtual std::string GetName() const override;
@@ skipping 50 matching lines @@
   void NotifyGattCharacteristicValueChanged(
       BluetoothRemoteGattCharacteristicChromeOS* characteristic,
       const std::vector<uint8>& value);
   void NotifyGattDescriptorValueChanged(
       BluetoothRemoteGattDescriptorChromeOS* descriptor,
       const std::vector<uint8>& value);
 
   // Returns the object path of the adapter.
   const dbus::ObjectPath& object_path() const { return object_path_; }
 
+  // Uses (creating if necessary) a profile on the adapter for a custom service.
+  // Returns the associated profile object.  When the profile is successfully

[armansito, 2015/01/21 01:44:47]

I would add a note here that the returned object is owned by the
BluetoothAdapterChromeOS.

[Marie Janssen, 2015/01/22 21:55:32]

Done.

+  // created, |success_callback| will be called. On failure, |error_callback|
+  // will be
+  // called.

[armansito, 2015/01/21 01:44:47]

nit: "// will be called." instead of having "// called." in its own line.

[Marie Janssen, 2015/01/22 21:55:32]

Done.

+  BluetoothAdapterProfileChromeOS* UseProfile(

[armansito, 2015/01/21 01:44:47]

Well we are returning the profile here but technically registering it may fail.
So maybe it's better to return a pointer to the profile in the success callback
instead of the return value.

[Marie Janssen, 2015/01/22 21:55:32]

Done.

+      const device::BluetoothUUID& uuid,
+      const dbus::ObjectPath& device_path,

[armansito, 2015/01/21 01:44:47]

Will local (listening) services also use this function? In that case, are they
expected to pass in an empty string for |device_path|?

[Marie Janssen, 2015/01/22 21:55:32]

Yes. Empty string for |device_path| is a listening socket. Added a clarifying
comment.

+      const BluetoothProfileManagerClient::Options* options,

[armansito, 2015/01/21 01:44:47]

Should |options| be passed by const reference instead of a pointer?

[Marie Janssen, 2015/01/22 21:55:32]

Using a pointer is because of consistency with previous use in
BluetoothSocketChromeOS.

+      BluetoothProfileServiceProvider::Delegate* delegate,
+      const base::Closure& success_callback,
+      const ErrorCompletionCallback& error_callback);
+
+  // Releases the profile associated with |uuid|
+  void ReleaseProfile(const device::BluetoothUUID& uuid);
+
  protected:
   // BluetoothAdapter:
   virtual void RemovePairingDelegateInternal(
       device::BluetoothDevice::PairingDelegate* pairing_delegate) override;
 
  private:
   friend class base::DeleteHelper<BluetoothAdapterChromeOS>;
   friend class BluetoothChromeOSTest;
 
   // typedef for callback parameters that are passed to AddDiscoverySession
@@ skipping 104 matching lines @@
                              const ErrorCallback& error_callback,
                              const std::string& error_name,
                              const std::string& error_message);
 
   // Called by dbus:: on completion of the D-Bus method call to stop discovery.
   void OnStopDiscovery(const base::Closure& callback);
   void OnStopDiscoveryError(const ErrorCallback& error_callback,
                             const std::string& error_name,
                             const std::string& error_message);
 
+  // Called by dbus:: on completion of the D-Bus method to register a profile.
+  void OnRegisterProfile(const device::BluetoothUUID& uuid,
+                         const dbus::ObjectPath& device_path,
+                         BluetoothProfileServiceProvider::Delegate* delegate,
+                         const base::Closure& success_callback,
+                         const ErrorCompletionCallback& error_callback);
+  bool SetProfileDelegate(const device::BluetoothUUID& uuid,
+                          const dbus::ObjectPath& device_path,
+                          BluetoothProfileServiceProvider::Delegate* delegate,
+                          const base::Closure& success_callback,
+                          const ErrorCompletionCallback& error_callback);
+  void OnRegisterProfileError(const ErrorCompletionCallback& error_callback,
+                              const std::string& error_name,
+                              const std::string& error_message);
+
   // Processes the queued discovery requests. For each DiscoveryCallbackPair in
   // the queue, this method will try to add a new discovery session. This method
   // is called whenever a pending D-Bus call to start or stop discovery has
   // ended (with either success or failure).
   void ProcessQueuedDiscoveryRequests();
 
   // Number of discovery sessions that have been added.
   int num_discovery_sessions_;
 
   // True, if there is a pending request to start or stop discovery.
@@ skipping 17 matching lines @@
   ObserverList<device::BluetoothAdapter::Observer> observers_;
 
   // Instance of the D-Bus agent object used for pairing, initialized with
   // our own class as its delegate.
   scoped_ptr<BluetoothAgentServiceProvider> agent_;
 
   // UI thread task runner and socket thread object used to create sockets.
   scoped_refptr<base::SequencedTaskRunner> ui_task_runner_;
   scoped_refptr<device::BluetoothSocketThread> socket_thread_;
 
+  // The profiles we have registered with the bluetooth daemon.
+  std::map<device::BluetoothUUID, BluetoothAdapterProfileChromeOS*> profiles_;
+
   // Note: This should remain the last member so it'll be destroyed and
   // invalidate its weak pointers before any other members are destroyed.
   base::WeakPtrFactory<BluetoothAdapterChromeOS> weak_ptr_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(BluetoothAdapterChromeOS);
 };
 
 }  // namespace chromeos
 
 #endif  // DEVICE_BLUETOOTH_BLUETOOTH_ADAPTER_CHROMEOS_H_