Chromium Code Reviews Chromium Code Reviews
Issue 10899037:
Refactoring bluetooth API code. (Closed)
Base URL: svn://svn.chromium.org/chrome/trunk/src| Index: chrome/browser/chromeos/bluetooth/bluetooth_device_chromeos.h |
| diff --git a/chrome/browser/chromeos/bluetooth/bluetooth_device.h b/chrome/browser/chromeos/bluetooth/bluetooth_device_chromeos.h |
| similarity index 55% |
| copy from chrome/browser/chromeos/bluetooth/bluetooth_device.h |
| copy to chrome/browser/chromeos/bluetooth/bluetooth_device_chromeos.h |
| index 031dfd833448f8667dac957145eccbb6987486ff..d57f698f841dd23262de923187e018af1d1e73d6 100644 |
| --- a/chrome/browser/chromeos/bluetooth/bluetooth_device.h |
| +++ b/chrome/browser/chromeos/bluetooth/bluetooth_device_chromeos.h |
| @@ -2,18 +2,18 @@ |
| // Use of this source code is governed by a BSD-style license that can be |
| // found in the LICENSE file. |
| -#ifndef CHROME_BROWSER_CHROMEOS_BLUETOOTH_BLUETOOTH_DEVICE_H_ |
| -#define CHROME_BROWSER_CHROMEOS_BLUETOOTH_BLUETOOTH_DEVICE_H_ |
| +#ifndef CHROME_BROWSER_CHROMEOS_BLUETOOTH_BLUETOOTH_DEVICE_CHROMEOS_H_ |
| +#define CHROME_BROWSER_CHROMEOS_BLUETOOTH_BLUETOOTH_DEVICE_CHROMEOS_H_ |
| #include <string> |
| #include <vector> |
| #include "base/basictypes.h" |
| -#include "base/callback.h" |
| #include "base/memory/scoped_ptr.h" |
| #include "base/memory/scoped_vector.h" |
| #include "base/memory/weak_ptr.h" |
| #include "base/string16.h" |
| +#include "chrome/browser/chromeos/bluetooth/bluetooth_device.h" |
| #include "chromeos/dbus/bluetooth_agent_service_provider.h" |
| #include "chromeos/dbus/bluetooth_device_client.h" |
| #include "chromeos/dbus/bluetooth_out_of_band_client.h" |
| @@ -21,137 +21,24 @@ |
| namespace chromeos { |
| -class BluetoothAdapter; |
| +class BluetoothAdapterChromeOs; |
| class BluetoothServiceRecord; |
| -class BluetoothSocket; |
| - |
| -// The BluetoothDevice class represents a remote Bluetooth device, both |
| -// its properties and capabilities as discovered by a local adapter and |
| -// actions that may be performed on the remove device such as pairing, |
| -// connection and disconnection. |
| -// |
| -// The class is instantiated and managed by the BluetoothAdapter class |
| -// and pointers should only be obtained from that class and not cached, |
| -// instead use the address() method as a unique key for a device. |
| -// |
| -// Since the lifecycle of BluetoothDevice instances is managed by |
| -// BluetoothAdapter, that class rather than this provides observer methods |
| -// for devices coming and going, as well as properties being updated. |
| -class BluetoothDevice : public BluetoothDeviceClient::Observer, |
| - public BluetoothAgentServiceProvider::Delegate { |
| + |
| +struct BluetoothOutOfBandPairingData; |
| + |
| +// The BluetoothDeviceChromeOs class is an implementation of BluetoothDevice |
| +// for ChromeOS platform. |
| +class BluetoothDeviceChromeOs : public BluetoothDevice, |
| + public BluetoothDeviceClient::Observer, |
| + public BluetoothAgentServiceProvider::Delegate { |
| public: |
| - // Possible values that may be returned by GetDeviceType(), representing |
| - // different types of bluetooth device that we support or are aware of |
| - // decoded from the bluetooth class information. |
| - enum DeviceType { |
| - DEVICE_UNKNOWN, |
| - DEVICE_COMPUTER, |
| - DEVICE_PHONE, |
| - DEVICE_MODEM, |
| - DEVICE_PERIPHERAL, |
| - DEVICE_JOYSTICK, |
| - DEVICE_GAMEPAD, |
| - DEVICE_KEYBOARD, |
| - DEVICE_MOUSE, |
| - DEVICE_TABLET, |
| - DEVICE_KEYBOARD_MOUSE_COMBO |
| - }; |
| - |
| - // Interface for observing changes from bluetooth devices. |
| - class Observer { |
| - public: |
| - virtual ~Observer() {} |
| - |
| - // TODO(keybuk): add observers for pairing and connection. |
| - }; |
| - |
| - // Interface for negotiating pairing of bluetooth devices. |
| - class PairingDelegate { |
| - public: |
| - virtual ~PairingDelegate() {} |
| - |
| - // This method will be called when the Bluetooth daemon requires a |
| - // PIN Code for authentication of the device |device|, the delegate should |
| - // obtain the code from the user and call SetPinCode() on the device to |
| - // provide it, or RejectPairing() or CancelPairing() to reject or cancel |
| - // the request. |
| - // |
| - // PIN Codes are generally required for Bluetooth 2.0 and earlier devices |
| - // for which there is no automatic pairing or special handling. |
| - virtual void RequestPinCode(BluetoothDevice* device) = 0; |
| - |
| - // This method will be called when the Bluetooth daemon requires a |
| - // Passkey for authentication of the device |device|, the delegate should |
| - // obtain the passkey from the user (a numeric in the range 0-999999) and |
| - // call SetPasskey() on the device to provide it, or RejectPairing() or |
| - // CancelPairing() to reject or cancel the request. |
| - // |
| - // Passkeys are generally required for Bluetooth 2.1 and later devices |
| - // which cannot provide input or display on their own, and don't accept |
| - // passkey-less pairing. |
| - virtual void RequestPasskey(BluetoothDevice* device) = 0; |
| - |
| - // This method will be called when the Bluetooth daemon requires that the |
| - // user enter the PIN code |pincode| into the device |device| so that it |
| - // may be authenticated. The DismissDisplayOrConfirm() method |
| - // will be called to dismiss the display once pairing is complete or |
| - // cancelled. |
| - // |
| - // This is used for Bluetooth 2.0 and earlier keyboard devices, the |
| - // |pincode| will always be a six-digit numeric in the range 000000-999999 |
| - // for compatibilty with later specifications. |
| - virtual void DisplayPinCode(BluetoothDevice* device, |
| - const std::string& pincode) = 0; |
| - |
| - // This method will be called when the Bluetooth daemon requires that the |
| - // user enter the Passkey |passkey| into the device |device| so that it |
| - // may be authenticated. The DismissDisplayOrConfirm() method will be |
| - // called to dismiss the display once pairing is complete or cancelled. |
| - // |
| - // This is used for Bluetooth 2.1 and later devices that support input |
| - // but not display, such as keyboards. The Passkey is a numeric in the |
| - // range 0-999999 and should be always presented zero-padded to six |
| - // digits. |
| - virtual void DisplayPasskey(BluetoothDevice* device, |
| - uint32 passkey) = 0; |
| - |
| - // This method will be called when the Bluetooth daemon requires that the |
| - // user confirm that the Passkey |passkey| is displayed on the screen |
| - // of the device |device| so that it may be authenticated. The delegate |
| - // should display to the user and ask for confirmation, then call |
| - // ConfirmPairing() on the device to confirm, RejectPairing() on the device |
| - // to reject or CancelPairing() on the device to cancel authentication |
| - // for any other reason. |
| - // |
| - // This is used for Bluetooth 2.1 and later devices that support display, |
| - // such as other computers or phones. The Passkey is a numeric in the |
| - // range 0-999999 and should be always present zero-padded to six |
| - // digits. |
| - virtual void ConfirmPasskey(BluetoothDevice* device, |
| - uint32 passkey) = 0; |
| - |
| - // This method will be called when any previous DisplayPinCode(), |
| - // DisplayPasskey() or ConfirmPasskey() request should be concluded |
| - // and removed from the user. |
| - virtual void DismissDisplayOrConfirm() = 0; |
| - }; |
| - |
| - virtual ~BluetoothDevice(); |
| - |
| - // Returns the Bluetooth of address the device. This should be used as |
| - // a unique key to identify the device and copied where needed. |
| - virtual const std::string& address() const; |
| - |
| - // Returns the name of the device suitable for displaying, this may |
| - // be a synthesied string containing the address and localized type name |
| - // if the device has no obtained name. |
| - virtual string16 GetName() const; |
| - |
| - // Returns the type of the device, limited to those we support or are |
| - // aware of, by decoding the bluetooth class information. The returned |
| - // values are unique, and do not overlap, so DEVICE_KEYBOARD is not also |
| - // DEVICE_PERIPHERAL. |
| - DeviceType GetDeviceType() const; |
| + virtual ~BluetoothDeviceChromeOs(); |
| + |
| + // BluetoothDevice override |
| + virtual const std::string& address() const OVERRIDE; |
| + |
| + // BluetoothDevice override |
| + virtual string16 GetName() const OVERRIDE; |
| // Returns a localized string containing the device's bluetooth address and |
| // a device type for display when |name_| is empty. |
| @@ -160,57 +47,40 @@ class BluetoothDevice : public BluetoothDeviceClient::Observer, |
| // Indicates whether the class of this device is supported by Chrome OS. |
| bool IsSupported() const; |
| - // Indicates whether the device is paired to the adapter, whether or not |
| - // that pairing is permanent or temporary. |
| - virtual bool IsPaired() const; |
| + // BluetoothDevice override |
| + virtual bool IsPaired() const OVERRIDE; |
| // Indicates whether the device is visible to the adapter, this is not |
| // mutually exclusive to being paired. |
| bool IsVisible() const { return visible_; } |
|
keybuk
2012/09/17 22:19:43
should be an override?
youngki
2012/09/18 18:19:56
Done.
|
| - // Indicates whether the device is bonded to the adapter, bonding is |
| - // formed by pairing and exchanging high-security link keys so that |
| - // connections may be encrypted. |
| - virtual bool IsBonded() const; |
| + // BluetoothDevice override |
| + virtual bool IsBonded() const OVERRIDE; |
| - // Indicates whether the device is currently connected to the adapter |
| - // and at least one service available for use. |
| - virtual bool IsConnected() const; |
| + // BluetoothDevice override |
| + virtual bool IsConnected() const OVERRIDE; |
| // Returns the services (as UUID strings) that this device provides. |
| typedef std::vector<std::string> ServiceList; |
| const ServiceList& GetServices() const { return service_uuids_; } |
|
keybuk
2012/09/17 22:19:43
should be an override?
youngki
2012/09/18 18:19:56
Done.
|
| - // The ErrorCallback is used for methods that can fail in which case it |
| - // is called, in the success case the callback is simply not called. |
| - typedef base::Callback<void()> ErrorCallback; |
| - |
| - // Returns the services (as BluetoothServiceRecord objects) that this device |
| - // provides. |
| - typedef ScopedVector<BluetoothServiceRecord> ServiceRecordList; |
| - typedef base::Callback<void(const ServiceRecordList&)> ServiceRecordsCallback; |
| - void GetServiceRecords(const ServiceRecordsCallback& callback, |
| - const ErrorCallback& error_callback); |
| - |
| - // Indicates whether this device provides the given service. |uuid| should |
| - // be in canonical form (see bluetooth_utils::CanonicalUuid). |
| - virtual bool ProvidesServiceWithUUID(const std::string& uuid) const; |
| + // BluetoothDevice override |
| + virtual void GetServiceRecords(const ServiceRecordsCallback& callback, |
| + const ErrorCallback& error_callback) OVERRIDE; |
| - // The ProvidesServiceCallback is used by ProvidesServiceWithName to indicate |
| - // whether or not a matching service was found. |
| - typedef base::Callback<void(bool)> ProvidesServiceCallback; |
| + // BluetoothDevice override |
| + virtual bool ProvidesServiceWithUUID(const std::string& uuid) const OVERRIDE; |
| - // Indicates whether this device provides the given service. |
| + // BluetoothDevice override |
| virtual void ProvidesServiceWithName(const std::string& name, |
| - const ProvidesServiceCallback& callback); |
| + const ProvidesServiceCallback& callback) |
| + OVERRIDE; |
| - // Indicates whether the device is currently pairing and expecting a |
| - // PIN Code to be returned. |
| - bool ExpectingPinCode() const { return !pincode_callback_.is_null(); } |
| + // BluetoothDevice override |
| + virtual bool ExpectingPinCode() const OVERRIDE; |
| - // Indicates whether the device is currently pairing and expecting a |
| - // Passkey to be returned. |
| - bool ExpectingPasskey() const { return !passkey_callback_.is_null(); } |
| + // BluetoothDevice override |
| + virtual bool ExpectingPasskey() const OVERRIDE; |
| // Indicates whether the device is currently pairing and expecting |
| // confirmation of a displayed passkey. |
| @@ -218,93 +88,53 @@ class BluetoothDevice : public BluetoothDeviceClient::Observer, |
| return !confirmation_callback_.is_null(); |
| } |
|
keybuk
2012/09/17 22:19:43
should be an override?
youngki
2012/09/18 18:19:56
Done.
|
| - // Initiates a connection to the device, pairing first if necessary. |
| - // |
| - // Method calls will be made on the supplied object |pairing_delegate| |
| - // to indicate what display, and in response should make method calls |
| - // back to the device object. Not all devices require user responses |
| - // during pairing, so it is normal for |pairing_delegate| to receive no |
| - // calls. To explicitly force a low-security connection without bonding, |
| - // pass NULL, though this is ignored if the device is already paired. |
| - // |
| - // If the request fails, |error_callback| will be called; otherwise, |
| - // |callback| is called when the request is complete. |
| - void Connect(PairingDelegate* pairing_delegate, |
| - const base::Closure& callback, |
| - const ErrorCallback& error_callback); |
| + // BluetoothDevice override |
| + virtual void Connect(BluetoothDevice::PairingDelegate* pairing_delegate, |
| + const base::Closure& callback, |
| + const ErrorCallback& error_callback) OVERRIDE; |
| - // Sends the PIN code |pincode| to the remote device during pairing. |
| - // |
| - // PIN Codes are generally required for Bluetooth 2.0 and earlier devices |
| - // for which there is no automatic pairing or special handling. |
| - void SetPinCode(const std::string& pincode); |
| + // BluetoothDevice override |
| + virtual void SetPinCode(const std::string& pincode) OVERRIDE; |
| - // Sends the Passkey |passkey| to the remote device during pairing. |
| - // |
| - // Passkeys are generally required for Bluetooth 2.1 and later devices |
| - // which cannot provide input or display on their own, and don't accept |
| - // passkey-less pairing, and are a numeric in the range 0-999999. |
| - void SetPasskey(uint32 passkey); |
| - |
| - // Confirms to the remote device during pairing that a passkey provided by |
| - // the ConfirmPasskey() delegate call is displayed on both devices. |
| - void ConfirmPairing(); |
| - |
| - // Rejects a pairing or connection request from a remote device. |
| - void RejectPairing(); |
| - |
| - // Cancels a pairing or connection attempt to a remote device. |
| - void CancelPairing(); |
| - |
| - // Disconnects the device, terminating the low-level ACL connection |
| - // and any application connections using it. Link keys and other pairing |
| - // information are not discarded, and the device object is not deleted. |
| - // If the request fails, |error_callback| will be called; otherwise, |
| - // |callback| is called when the request is complete. |
| - void Disconnect(const base::Closure& callback, |
| - const ErrorCallback& error_callback); |
| - |
| - // Disconnects the device, terminating the low-level ACL connection |
| - // and any application connections using it, and then discards link keys |
| - // and other pairing information. The device object remainds valid until |
| - // returing from the calling function, after which it should be assumed to |
| - // have been deleted. If the request fails, |error_callback| will be called. |
| - // There is no callback for success beause this object is often deleted |
| - // before that callback would be called. |
| - void Forget(const ErrorCallback& error_callback); |
| - |
| - // SocketCallback is used by ConnectToService to return a BluetoothSocket |
| - // to the caller, or NULL if there was an error. The socket will remain open |
| - // until the last reference to the returned BluetoothSocket is released. |
| - typedef base::Callback<void(scoped_refptr<BluetoothSocket>)> SocketCallback; |
| - |
| - // Attempts to open a socket to a service matching |uuid| on this device. If |
| - // the connection is successful, |callback| is called with a BluetoothSocket. |
| - // Otherwise |callback| is called with NULL. The socket is closed as soon as |
| - // all references to the BluetoothSocket are released. Note that the |
| - // BluetoothSocket object can outlive both this BluetoothDevice and the |
| - // BluetoothAdapter for this device. |
| - void ConnectToService(const std::string& service_uuid, |
| - const SocketCallback& callback); |
| - |
| - // Sets the Out Of Band pairing data for this device to |data|. Exactly one |
| - // of |callback| or |error_callback| will be run. |
| + // BluetoothDevice override |
| + virtual void SetPasskey(uint32 passkey) OVERRIDE; |
| + |
| + // BluetoothDevice override |
| + virtual void ConfirmPairing() OVERRIDE; |
| + |
| + // BluetoothDevice override |
| + virtual void RejectPairing() OVERRIDE; |
| + |
| + // BluetoothDevice override |
| + virtual void CancelPairing() OVERRIDE; |
| + |
| + // BluetoothDevice override |
| + virtual void Disconnect(const base::Closure& callback, |
| + const ErrorCallback& error_callback) OVERRIDE; |
| + |
| + // BluetoothDevice override |
| + virtual void Forget(const ErrorCallback& error_callback) OVERRIDE; |
| + |
| + // BluetoothDevice override |
| + virtual void ConnectToService(const std::string& service_uuid, |
| + const SocketCallback& callback) OVERRIDE; |
| + |
| + // BluetoothDevice override |
| virtual void SetOutOfBandPairingData( |
| const chromeos::BluetoothOutOfBandPairingData& data, |
| const base::Closure& callback, |
| - const ErrorCallback& error_callback); |
| + const ErrorCallback& error_callback) OVERRIDE; |
| - // Clears the Out Of Band pairing data for this device. Exactly one of |
| - // |callback| or |error_callback| will be run. |
| + // BluetoothDevice override |
| virtual void ClearOutOfBandPairingData( |
| const base::Closure& callback, |
| - const ErrorCallback& error_callback); |
| + const ErrorCallback& error_callback) OVERRIDE; |
| private: |
| - friend class BluetoothAdapter; |
| + friend class BluetoothAdapterChromeOs; |
| friend class MockBluetoothDevice; |
| - explicit BluetoothDevice(BluetoothAdapter* adapter); |
| + explicit BluetoothDeviceChromeOs(BluetoothAdapterChromeOs* adapter); |
| // Sets the dbus object path for the device to |object_path|, indicating |
| // that the device has gone from being discovered to paired or bonded. |
| @@ -402,10 +232,10 @@ class BluetoothDevice : public BluetoothDeviceClient::Observer, |
| const ErrorCallback& error_callback, |
| const dbus::ObjectPath& device_path, bool success); |
| - // Called by BluetoothAdapterClient when a call to RemoveDevice() completes, |
| - // |success| indicates whether or not the request succeeded, |error_callback| |
| - // is the callback provided to Forget() and |adapter_path| is the d-bus |
| - // object path of the adapter that performed the removal. |
| + // Called by BluetoothAdapterClient when a call to RemoveDevice() |
| + // completes, |success| indicates whether or not the request succeeded, |
| + // |error_callback| is the callback provided to Forget() and |adapter_path| is |
| + // the d-bus object path of the adapter that performed the removal. |
| void ForgetCallback(const ErrorCallback& error_callback, |
| const dbus::ObjectPath& adapter_path, bool success); |
| @@ -554,11 +384,12 @@ class BluetoothDevice : public BluetoothDeviceClient::Observer, |
| // the request failed before a reply was returned from the device. |
| virtual void Cancel() OVERRIDE; |
| - // Creates a new BluetoothDevice object bound to the adapter |adapter|. |
| - static BluetoothDevice* Create(BluetoothAdapter* adapter); |
| + // Creates a new BluetoothDeviceChromeOs object bound to the adapter |
| + // |adapter|. |
| + static BluetoothDeviceChromeOs* Create(BluetoothAdapterChromeOs* adapter); |
| // The adapter that owns this device instance. |
| - BluetoothAdapter* adapter_; |
| + BluetoothAdapterChromeOs* adapter_; |
| // The dbus object path of the device, will be empty if the device has only |
| // been discovered and not yet paired with. |
| @@ -570,10 +401,6 @@ class BluetoothDevice : public BluetoothDeviceClient::Observer, |
| // The name of the device, as supplied by the remote device. |
| std::string name_; |
| - // The Bluetooth class of the device, a bitmask that may be decoded using |
| - // https://www.bluetooth.org/Technical/AssignedNumbers/baseband.htm |
| - uint32 bluetooth_class_; |
| - |
| // Tracked device state, updated by the adapter managing the lifecyle of |
| // the device. |
| bool visible_; |
| @@ -586,7 +413,7 @@ class BluetoothDevice : public BluetoothDeviceClient::Observer, |
| // During pairing this is set to an object that we don't own, but on which |
| // we can make method calls to request, display or confirm PIN Codes and |
| // Passkeys. Generally it is the object that owns this one. |
| - PairingDelegate* pairing_delegate_; |
| + BluetoothDevice::PairingDelegate* pairing_delegate_; |
| // During pairing this is set to an instance of a D-Bus agent object |
| // intialized with our own class as its delegate. |
| @@ -604,11 +431,11 @@ class BluetoothDevice : public BluetoothDeviceClient::Observer, |
| // 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<BluetoothDevice> weak_ptr_factory_; |
| + base::WeakPtrFactory<BluetoothDeviceChromeOs> weak_ptr_factory_; |
| - DISALLOW_COPY_AND_ASSIGN(BluetoothDevice); |
| + DISALLOW_COPY_AND_ASSIGN(BluetoothDeviceChromeOs); |
| }; |
| } // namespace chromeos |
| -#endif // CHROME_BROWSER_CHROMEOS_BLUETOOTH_BLUETOOTH_DEVICE_H_ |
| +#endif // CHROME_BROWSER_CHROMEOS_BLUETOOTH_BLUETOOTH_DEVICE_CHROMEOS_H_ |
