chrome.bluetooth API improvements.

chrome/browser/extensions/api/bluetooth/bluetooth_api.h

 // Copyright (c) 2012 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_BLUETOOTH_API_H_
 #define CHROME_BROWSER_EXTENSIONS_API_BLUETOOTH_BLUETOOTH_API_H_
 
 #include <string>
 
 #include "base/memory/ref_counted.h"
 #include "base/memory/scoped_ptr.h"
+#include "chrome/browser/extensions/api/bluetooth/bluetooth_api_socket.h"
 #include "chrome/browser/extensions/api/bluetooth/bluetooth_extension_function.h"
+#include "chrome/common/extensions/api/bluetooth.h"
 #include "device/bluetooth/bluetooth_device.h"
 #include "device/bluetooth/bluetooth_profile.h"
+#include "device/bluetooth/bluetooth_socket.h"
+#include "extensions/browser/api/api_resource_manager.h"
 #include "extensions/browser/api/async_api_function.h"
 #include "extensions/browser/browser_context_keyed_api_factory.h"
 #include "extensions/browser/event_router.h"
 #include "extensions/browser/extension_function.h"
 
 namespace content {
 class BrowserContext;
 }
 
 namespace device {
+class BluetoothAdapter;
+struct BluetoothOutOfBandPairingData;
+}
 
-class BluetoothAdapter;
-class BluetoothDevice;
-class BluetoothSocket;
-struct BluetoothOutOfBandPairingData;
-
-}  // namespace device
+namespace net {
+class IOBuffer;
+}
 
 namespace extensions {
 
 class ExtensionBluetoothEventRouter;
 
 // The profile-keyed service that manages the bluetooth extension API.
+// All methods of this class must be called on the UI thread.
+// TODO(rpaquay): Rename this and move to separate file.
 class BluetoothAPI : public BrowserContextKeyedAPI,
                      public EventRouter::Observer {
  public:
-  // Convenience method to get the BluetoothAPI for a profile.
+  typedef ApiResourceManager<BluetoothApiSocket>::ApiResourceData SocketData;
+
+  struct ConnectionParams {
+    ConnectionParams();
+    ~ConnectionParams();
+
+    content::BrowserThread::ID thread_id;
+    void* browser_context_id;
+    std::string extension_id;
+    std::string device_address;
+    std::string uuid;
+    scoped_refptr<device::BluetoothSocket> socket;
+    scoped_refptr<SocketData> socket_data;
+  };
+
+  // Convenience method to get the BluetoothAPI for a browser context.
   static BluetoothAPI* Get(content::BrowserContext* context);
 
   static BrowserContextKeyedAPIFactory<BluetoothAPI>* GetFactoryInstance();
 
   explicit BluetoothAPI(content::BrowserContext* context);
   virtual ~BluetoothAPI();
 
-  ExtensionBluetoothEventRouter* bluetooth_event_router();
+  ExtensionBluetoothEventRouter* event_router();
+  scoped_refptr<SocketData> socket_data();
+  scoped_refptr<api::BluetoothSocketEventDispatcher> socket_event_dispatcher();
 
   // KeyedService implementation.
   virtual void Shutdown() OVERRIDE;
 
   // EventRouter::Observer implementation.
   virtual void OnListenerAdded(const EventListenerInfo& details) OVERRIDE;
   virtual void OnListenerRemoved(const EventListenerInfo& details) OVERRIDE;
 
+  // Dispatch an event that takes a connection socket as a parameter to the
+  // extension that registered the profile that the socket has connected to.
+  void DispatchConnectionEvent(const std::string& extension_id,
+                               const std::string& profile_uuid,
+                               const device::BluetoothDevice* device,
+                               scoped_refptr<device::BluetoothSocket> socket);
+
  private:
-  friend class BrowserContextKeyedAPIFactory<BluetoothAPI>;
+  static void RegisterSocket(const ConnectionParams& params);
+  static void RegisterSocketUI(const ConnectionParams& params, int socket_id);
+  static void RegisterSocketWithAdapterUI(
+      const ConnectionParams& params,
+      int socket_id,
+      scoped_refptr<device::BluetoothAdapter> adapter);
 
   // BrowserContextKeyedAPI implementation.
+  friend class BrowserContextKeyedAPIFactory<BluetoothAPI>;
   static const char* service_name() { return "BluetoothAPI"; }
   static const bool kServiceRedirectedInIncognito = true;
   static const bool kServiceIsNULLWhileTesting = true;
 
   content::BrowserContext* browser_context_;
 
   // Created lazily on first access.
-  scoped_ptr<ExtensionBluetoothEventRouter> bluetooth_event_router_;
+  scoped_ptr<ExtensionBluetoothEventRouter> event_router_;
+  scoped_refptr<SocketData> socket_data_;
+  scoped_refptr<api::BluetoothSocketEventDispatcher> socket_event_dispatcher_;
 };
 
 namespace api {
 
+class BluetoothSocketEventDispatcher;
+
+// Base class for methods dealing with BluetoothSocketApi and
+// ApiResourceManager<BluetoothSocketApi>.
+class BluetoothSocketApiFunction : public UIThreadExtensionFunction {
+ public:
+  BluetoothSocketApiFunction();
+
+ protected:
+  virtual ~BluetoothSocketApiFunction();
+
+  // ExtensionFunction::RunImpl()
+  virtual bool RunImpl() OVERRIDE;
+
+  bool PrePrepare();
+  bool Respond();
+  void AsyncWorkCompleted();
+
+  virtual bool Prepare() = 0;
+  virtual void Work();
+  virtual void AsyncWorkStart();
+
+  content::BrowserThread::ID work_thread_id() const {
+    return BluetoothApiSocket::kThreadId;
+  }
+
+  scoped_refptr<BluetoothAPI::SocketData> socket_data_;
+  scoped_refptr<api::BluetoothSocketEventDispatcher> socket_event_dispatcher_;
+};
+
+class BluetoothGetAdapterStateFunction : public BluetoothExtensionFunction {
+ public:
+  DECLARE_EXTENSION_FUNCTION("bluetooth.getAdapterState",
+                             BLUETOOTH_GETADAPTERSTATE)
+
+ protected:
+  virtual ~BluetoothGetAdapterStateFunction();
+
+  // BluetoothExtensionFunction:
+  virtual bool DoWork(scoped_refptr<device::BluetoothAdapter> adapter) OVERRIDE;
+};
+
+class BluetoothGetDevicesFunction : public BluetoothExtensionFunction {
+ public:
+  DECLARE_EXTENSION_FUNCTION("bluetooth.getDevices", BLUETOOTH_GETDEVICES)
+
+ protected:
+  virtual ~BluetoothGetDevicesFunction();
+
+  // BluetoothExtensionFunction:
+  virtual bool DoWork(scoped_refptr<device::BluetoothAdapter> adapter) OVERRIDE;
+};
+
 class BluetoothAddProfileFunction : public UIThreadExtensionFunction {
  public:
   DECLARE_EXTENSION_FUNCTION("bluetooth.addProfile", BLUETOOTH_ADDPROFILE)
 
   BluetoothAddProfileFunction();
 
  protected:
-  virtual ~BluetoothAddProfileFunction() {}
+  virtual ~BluetoothAddProfileFunction();
   virtual bool RunImpl() OVERRIDE;
 
   virtual void RegisterProfile(
       const device::BluetoothProfile::Options& options,
       const device::BluetoothProfile::ProfileCallback& callback);
 
  private:
   void OnProfileRegistered(device::BluetoothProfile* bluetooth_profile);
 
   std::string uuid_;
 };
 
 class BluetoothRemoveProfileFunction : public SyncExtensionFunction {
  public:
   DECLARE_EXTENSION_FUNCTION("bluetooth.removeProfile",
                              BLUETOOTH_REMOVEPROFILE)
 
  protected:
-  virtual ~BluetoothRemoveProfileFunction() {}
+  virtual ~BluetoothRemoveProfileFunction();
   virtual bool RunImpl() OVERRIDE;
 };
 
 class BluetoothGetProfilesFunction : public BluetoothExtensionFunction {
  public:
   DECLARE_EXTENSION_FUNCTION("bluetooth.getProfiles", BLUETOOTH_GETPROFILES)
 
  protected:
-  virtual ~BluetoothGetProfilesFunction() {}
+  virtual ~BluetoothGetProfilesFunction();
 
   // BluetoothExtensionFunction:
   virtual bool DoWork(scoped_refptr<device::BluetoothAdapter> adapter) OVERRIDE;
 };
 
-class BluetoothGetAdapterStateFunction : public BluetoothExtensionFunction {
- public:
-  DECLARE_EXTENSION_FUNCTION("bluetooth.getAdapterState",
-                             BLUETOOTH_GETADAPTERSTATE)
-
- protected:
-  virtual ~BluetoothGetAdapterStateFunction() {}
-
-  // BluetoothExtensionFunction:
-  virtual bool DoWork(scoped_refptr<device::BluetoothAdapter> adapter) OVERRIDE;
-};
-
-class BluetoothGetDevicesFunction : public BluetoothExtensionFunction {
- public:
-  DECLARE_EXTENSION_FUNCTION("bluetooth.getDevices", BLUETOOTH_GETDEVICES)
-
- protected:
-  virtual ~BluetoothGetDevicesFunction() {}
-
-  // BluetoothExtensionFunction:
-  virtual bool DoWork(scoped_refptr<device::BluetoothAdapter> adapter) OVERRIDE;
-};
-
-class BluetoothGetServicesFunction : public BluetoothExtensionFunction {
- public:
-  DECLARE_EXTENSION_FUNCTION("bluetooth.getServices", BLUETOOTH_GETSERVICES)
-
- protected:
-  virtual ~BluetoothGetServicesFunction() {}
-
-  // BluetoothExtensionFunction:
-  virtual bool DoWork(scoped_refptr<device::BluetoothAdapter> adapter) OVERRIDE;
-
- private:
-  void GetServiceRecordsCallback(
-      base::ListValue* services,
-      const device::BluetoothDevice::ServiceRecordList& records);
-  void OnErrorCallback();
-};
-
 class BluetoothConnectFunction : public BluetoothExtensionFunction {
  public:
   DECLARE_EXTENSION_FUNCTION("bluetooth.connect", BLUETOOTH_CONNECT)
 
  protected:
-  virtual ~BluetoothConnectFunction() {}
+  virtual ~BluetoothConnectFunction();
 
   // BluetoothExtensionFunction:
   virtual bool DoWork(scoped_refptr<device::BluetoothAdapter> adapter) OVERRIDE;
 
  private:
   void OnSuccessCallback();
-  void OnErrorCallback();
+  void OnErrorCallback(const std::string& error);
 };
 
-class BluetoothDisconnectFunction : public SyncExtensionFunction {
+class BluetoothDisconnectFunction : public BluetoothSocketApiFunction {
  public:
   DECLARE_EXTENSION_FUNCTION("bluetooth.disconnect", BLUETOOTH_DISCONNECT)
+  BluetoothDisconnectFunction();
 
  protected:
-  virtual ~BluetoothDisconnectFunction() {}
-
-  // ExtensionFunction:
-  virtual bool RunImpl() OVERRIDE;
-};
-
-class BluetoothReadFunction : public AsyncApiFunction {
- public:
-  DECLARE_EXTENSION_FUNCTION("bluetooth.read", BLUETOOTH_READ)
-  BluetoothReadFunction();
-
- protected:
-  virtual ~BluetoothReadFunction();
+  virtual ~BluetoothDisconnectFunction();
 
   // AsyncApiFunction:
   virtual bool Prepare() OVERRIDE;
-  virtual bool Respond() OVERRIDE;
+  virtual void AsyncWorkStart() OVERRIDE;
+
+ private:
+  void OnSuccess();
+
+  scoped_ptr<bluetooth::Disconnect::Params> params_;
+};
+
+class BluetoothSendFunction : public BluetoothSocketApiFunction {
+ public:
+  DECLARE_EXTENSION_FUNCTION("bluetooth.send", BLUETOOTH_SEND)
+  BluetoothSendFunction();
+
+ protected:
+  virtual ~BluetoothSendFunction();
+
+  // AsyncApiFunction:
+  virtual bool Prepare() OVERRIDE;
+  virtual void AsyncWorkStart() OVERRIDE;
+
+ private:
+  void OnSendSuccess(int bytes_sent);
+  void OnSendError(const std::string& message);
+
+  scoped_ptr<bluetooth::Send::Params> params_;
+  scoped_refptr<net::IOBuffer> io_buffer_;
+  size_t io_buffer_size_;
+};
+
+class BluetoothUpdateSocketFunction : public BluetoothSocketApiFunction {
+ public:
+  DECLARE_EXTENSION_FUNCTION("bluetooth.updateSocket", BLUETOOTH_UPDATE_SOCKET)
+  BluetoothUpdateSocketFunction();
+
+ protected:
+  virtual ~BluetoothUpdateSocketFunction();
+
+  // AsyncApiFunction:
+  virtual bool Prepare() OVERRIDE;
   virtual void Work() OVERRIDE;
 
  private:
-  bool success_;
-  scoped_refptr<device::BluetoothSocket> socket_;
+  scoped_ptr<bluetooth::UpdateSocket::Params> params_;
 };
 
-class BluetoothWriteFunction : public AsyncApiFunction {
+class BluetoothSetSocketPausedFunction : public BluetoothSocketApiFunction {
  public:
-  DECLARE_EXTENSION_FUNCTION("bluetooth.write", BLUETOOTH_WRITE)
-  BluetoothWriteFunction();
+  DECLARE_EXTENSION_FUNCTION("bluetooth.setSocketPaused",
+                             BLUETOOTH_SET_SOCKET_PAUSED)
+  BluetoothSetSocketPausedFunction();
 
  protected:
-  virtual ~BluetoothWriteFunction();
+  virtual ~BluetoothSetSocketPausedFunction();
 
   // AsyncApiFunction:
   virtual bool Prepare() OVERRIDE;
-  virtual bool Respond() OVERRIDE;
   virtual void Work() OVERRIDE;
 
  private:
-  bool success_;
-  const base::BinaryValue* data_to_write_;  // memory is owned by args_
-  scoped_refptr<device::BluetoothSocket> socket_;
+  scoped_ptr<bluetooth::SetSocketPaused::Params> params_;
+};
+
+class BluetoothGetSocketFunction : public BluetoothSocketApiFunction {
+ public:
+  DECLARE_EXTENSION_FUNCTION("bluetooth.getSocket", BLUETOOTH_GET_SOCKET)
+
+  BluetoothGetSocketFunction();
+
+ protected:
+  virtual ~BluetoothGetSocketFunction();
+
+  // AsyncApiFunction:
+  virtual bool Prepare() OVERRIDE;
+  virtual void Work() OVERRIDE;
+
+ private:
+  scoped_ptr<bluetooth::GetSocket::Params> params_;
+};
+
+class BluetoothGetSocketsFunction : public BluetoothSocketApiFunction {
+ public:
+  DECLARE_EXTENSION_FUNCTION("bluetooth.getSockets", BLUETOOTH_GET_SOCKETS)
+
+  BluetoothGetSocketsFunction();
+
+ protected:
+  virtual ~BluetoothGetSocketsFunction();
+
+  // AsyncApiFunction:
+  virtual bool Prepare() OVERRIDE;
+  virtual void Work() OVERRIDE;
+};
+
+class BluetoothGetLocalOutOfBandPairingDataFunction
+    : public BluetoothExtensionFunction {
+ public:
+  DECLARE_EXTENSION_FUNCTION("bluetooth.getLocalOutOfBandPairingData",
+                             BLUETOOTH_GETLOCALOUTOFBANDPAIRINGDATA)
+
+ protected:
+  virtual ~BluetoothGetLocalOutOfBandPairingDataFunction() {}
+
+  void ReadCallback(const device::BluetoothOutOfBandPairingData& data);
+  void ErrorCallback();
+
+  // BluetoothExtensionFunction:
+  virtual bool DoWork(scoped_refptr<device::BluetoothAdapter> adapter) OVERRIDE;
 };
 
 class BluetoothSetOutOfBandPairingDataFunction
     : public BluetoothExtensionFunction {
  public:
   DECLARE_EXTENSION_FUNCTION("bluetooth.setOutOfBandPairingData",
                              BLUETOOTH_SETOUTOFBANDPAIRINGDATA)
 
  protected:
   virtual ~BluetoothSetOutOfBandPairingDataFunction() {}
 
   void OnSuccessCallback();
   void OnErrorCallback();
 
   // BluetoothExtensionFunction:
   virtual bool DoWork(scoped_refptr<device::BluetoothAdapter> adapter) OVERRIDE;
-};
-
-class BluetoothGetLocalOutOfBandPairingDataFunction
-    : public BluetoothExtensionFunction {
- public:
-  DECLARE_EXTENSION_FUNCTION("bluetooth.getLocalOutOfBandPairingData",
-                             BLUETOOTH_GETLOCALOUTOFBANDPAIRINGDATA)
-
- protected:
-  virtual ~BluetoothGetLocalOutOfBandPairingDataFunction() {}
-
-  void ReadCallback(
-      const device::BluetoothOutOfBandPairingData& data);
-  void ErrorCallback();
-
-  // BluetoothExtensionFunction:
-  virtual bool DoWork(scoped_refptr<device::BluetoothAdapter> adapter) OVERRIDE;
 };
 
 class BluetoothStartDiscoveryFunction : public BluetoothExtensionFunction {
  public:
   DECLARE_EXTENSION_FUNCTION("bluetooth.startDiscovery",
                              BLUETOOTH_STARTDISCOVERY)
 
  protected:
   virtual ~BluetoothStartDiscoveryFunction() {}
 
@@ skipping 17 matching lines @@
 
  private:
   void OnSuccessCallback();
   void OnErrorCallback();
 };
 
 }  // namespace api
 }  // namespace extensions
 
 #endif  // CHROME_BROWSER_EXTENSIONS_API_BLUETOOTH_BLUETOOTH_API_H_