components/arc: implement multi advertising

components/arc/bluetooth/arc_bluetooth_bridge.h

 // Copyright 2016 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 COMPONENTS_ARC_BLUETOOTH_ARC_BLUETOOTH_BRIDGE_H_
 #define COMPONENTS_ARC_BLUETOOTH_ARC_BLUETOOTH_BRIDGE_H_
 
 #include <stdint.h>
 
 #include <memory>
 #include <string>
 #include <unordered_map>
 #include <vector>
 
 #include "base/callback.h"
 #include "components/arc/arc_bridge_service.h"
 #include "components/arc/arc_service.h"
 #include "components/arc/common/bluetooth.mojom.h"
 #include "components/arc/instance_holder.h"
 #include "device/bluetooth/bluetooth_adapter.h"
 #include "device/bluetooth/bluetooth_adapter_factory.h"
+#include "device/bluetooth/bluetooth_advertisement.h"
 #include "device/bluetooth/bluetooth_device.h"
 #include "device/bluetooth/bluetooth_discovery_session.h"
 #include "device/bluetooth/bluetooth_local_gatt_service.h"
 #include "device/bluetooth/bluetooth_remote_gatt_characteristic.h"
 #include "device/bluetooth/bluetooth_remote_gatt_descriptor.h"
 #include "device/bluetooth/bluetooth_remote_gatt_service.h"
 #include "device/bluetooth/bluez/bluetooth_adapter_bluez.h"
 #include "mojo/public/cpp/bindings/binding.h"
 
 namespace arc {
@@ skipping 227 matching lines @@
   // Delete a local service.
   void DeleteService(int32_t service_handle,
                      const DeleteServiceCallback& callback) override;
   // Send value indication to a remote device.
   void SendIndication(int32_t attribute_handle,
                       mojom::BluetoothAddressPtr address,
                       bool confirm,
                       mojo::Array<uint8_t> value,
                       const SendIndicationCallback& callback) override;
 
+  // Set up or disable multiple advertising.
+  void ReserveAdvertisementHandle(
+      const ReserveAdvertisementHandleCallback& callback) override;
+  void BroadcastAdvertisement(
+      int32_t adv_handle,
+      mojom::BluetoothAdvertisementPtr advertisement,
+      const BroadcastAdvertisementCallback& callback) override;
+  void ReleaseAdvertisementHandle(
+      int32_t adv_handle,
+      const ReleaseAdvertisementHandleCallback& callback) override;
+
   // Chrome observer callbacks
   void OnPoweredOn(
       const base::Callback<void(mojom::BluetoothAdapterState)>& callback) const;
   void OnPoweredOff(
       const base::Callback<void(mojom::BluetoothAdapterState)>& callback) const;
   void OnPoweredError(
       const base::Callback<void(mojom::BluetoothAdapterState)>& callback) const;
   void OnDiscoveryStarted(
       std::unique_ptr<device::BluetoothDiscoverySession> session);
   void OnDiscoveryStopped();
@@ skipping 74 matching lines @@
 
   // Common code for OnCharacteristicWriteRequest and OnDescriptorWriteRequest
   template <class LocalGattAttribute>
   void OnGattAttributeWriteRequest(const device::BluetoothDevice* device,
                                    const LocalGattAttribute* attribute,
                                    const std::vector<uint8_t>& value,
                                    int offset,
                                    const base::Closure& success_callback,
                                    const ErrorCallback& error_callback);
 
+  // Callbacks for managing advertisements registered from the instance.
+
+  // Called when we have an open slot in the advertisement map and want to
+  // register the advertisement given by |data| for handle |adv_handle|.
+  void OnReadyToRegisterAdvertisement(
+      const BroadcastAdvertisementCallback& callback,
+      int32_t adv_handle,
+      std::unique_ptr<device::BluetoothAdvertisement::Data> data);
+  // Called when we've successfully registered a new advertisement for
+  // handle |adv_handle|.
+  void OnRegisterAdvertisementDone(
+      const BroadcastAdvertisementCallback& callback,
+      int32_t adv_handle,
+      scoped_refptr<device::BluetoothAdvertisement> advertisement);
+  // Called when the attempt to register an advertisement for handle
+  // |adv_handle| has failed. |adv_handle| remains reserved, but no
+  // advertisement is associated with it.
+  void OnRegisterAdvertisementError(
+      const BroadcastAdvertisementCallback& callback,
+      int32_t adv_handle,
+      device::BluetoothAdvertisement::ErrorCode error_code);
+  // Both of the following are called after we've tried to unregister
+  // the advertisement for |adv_handle|. Either way, we will no
+  // longer be broadcasting this advertisement, so in either case, the
+  // handle can be released.
+  void OnUnregisterAdvertisementDone(
+      const ReleaseAdvertisementHandleCallback& callback,
+      int32_t adv_handle);
+  void OnUnregisterAdvertisementError(
+      const ReleaseAdvertisementHandleCallback& callback,
+      int32_t adv_handle,
+      device::BluetoothAdvertisement::ErrorCode error_code);
+  // Find the next free advertisement handle and put it in *adv_handle,
+  // or return false if the advertisement map is full.
+  bool GetAdvertisementHandle(int32_t* adv_handle);
+
   bool CalledOnValidThread();
 
   mojo::Binding<mojom::BluetoothHost> binding_;
 
   scoped_refptr<bluez::BluetoothAdapterBlueZ> bluetooth_adapter_;
   scoped_refptr<device::BluetoothAdvertisement> advertisment_;
   std::unique_ptr<device::BluetoothDiscoverySession> discovery_session_;
   std::unordered_map<std::string,
                      std::unique_ptr<device::BluetoothGattNotifySession>>
       notification_session_;
   // Map from Android int handle to Chrome (BlueZ) string identifier.
   std::unordered_map<int32_t, std::string> gatt_identifier_;
   // Map from Chrome (BlueZ) string identifier to android int handle.
   std::unordered_map<std::string, int32_t> gatt_handle_;
   // Store last GattCharacteristic added to each GattService for GattServer.
   std::unordered_map<int32_t, int32_t> last_characteristic_;
   // Monotonically increasing value to use as handle to give to Android side.
   int32_t gatt_server_attribute_next_handle_ = 0;
   // Keeps track of all devices which initiated a GATT connection to us.
   std::unordered_set<std::string> gatt_connection_cache_;
 
+  // Holds advertising data registered by the instance.
+  static constexpr uint16_t kMaxAdvertisements = 5;
+  std::map<int32_t, scoped_refptr<device::BluetoothAdvertisement>>

[rickyz (no longer on Chrome), 2016/08/24 21:47:30]

Did you see rkc's comment on using std::array for this instead?

[Eric Caruso, 2016/08/24 22:24:42]

The design changed, and I got rid of AdvertisementInstance. I might also change
the keying to be simpler as puthik@ suggested, which would make std::array hard
to use for this.

Currently, the advertisements_ structure is to be interpreted as follows:
* key does not exist -> handle is free
* key exists, but value is nullptr -> handle is reserved and no advertisement is
registered
* key exists and value is not nullptr -> handle is reserved and in use.

If I did use std::array, the equivalent here would be some kind of optional type
for the scoped_refptr:
base::Optional<scoped_refptr<device::BluetoothAdvertisement>> (since we don't
have std::optional until C++17). Otherwise it would be difficult to encode the
reserved-but-unusued case. The above optional type allows me to encode it, but
in a weird way that I don't think is very easy to understand. I'd rather not go
back to a struct with an in-use bool either, since that was elided in favor of
stashing the struct in an std::unique_ptr to begin with.

+      advertisements_;
+
   base::ThreadChecker thread_checker_;
 
   // WeakPtrFactory to use for callbacks.
   base::WeakPtrFactory<ArcBluetoothBridge> weak_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(ArcBluetoothBridge);
 };
 
 }  // namespace arc
 
 #endif  // COMPONENTS_ARC_BLUETOOTH_ARC_BLUETOOTH_BRIDGE_H_