Chrome OS: Add bluetooth API for device discovery

chrome/browser/chromeos/bluetooth/bluetooth_device.h

Index: chrome/browser/chromeos/bluetooth/bluetooth_device.h
diff --git a/chrome/browser/chromeos/bluetooth/bluetooth_device.h b/chrome/browser/chromeos/bluetooth/bluetooth_device.h
new file mode 100644
index 0000000000000000000000000000000000000000..554291fc3c2875875582836fde409fb792bd984d
--- /dev/null
+++ b/chrome/browser/chromeos/bluetooth/bluetooth_device.h
@@ -0,0 +1,55 @@
+// Copyright (c) 2011 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_CHROMEOS_BLUETOOTH_BLUETOOTH_DEVICE_H_
+#define CHROME_BROWSER_CHROMEOS_BLUETOOTH_BLUETOOTH_DEVICE_H_
+#pragma once
+
+#include <string>
+
+#include "base/basictypes.h"
+
+namespace base {
+class DictionaryValue;
+}  // namespace base
+
+using base::DictionaryValue;
+
+namespace chromeos {
+
+class BluetoothDevice {
+ public:
+  virtual ~BluetoothDevice();
+
+  // Returns the MAC address for this device.
+  virtual const std::string& Address() const = 0;

[satorux1, 2011/10/26 19:26:55]

GetAddress()? As it's essentially an accessor, address() may also be ok.

http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml#Function_Names

[Vince Laviano, 2011/10/26 21:41:55]

I had originally named them that way in my CL at
http://codereview.chromium.org/8233042/ and received some code review comments
from tfarina@ pointing to a document that said that accessors that are virtual
functions ought not to be named in unix_hacker_style because it suggests that
they are inexpensive when they may not be.  So, I changed the accessor names to
be CamelCase. I could either add a Get prefix to these CamelCase names, or
revert back to my original unix_hacker_style naming.

+
+  // Returns the bluetooth class for this device.
+  virtual uint32 BluetoothClass() const = 0;

[satorux1, 2011/10/26 19:26:55]

uint32 doesn't seem to be a good type. Can you return an enum instead like:

enum BluetoothClass {
  SomeClass,
  SomeOtherClass,
};

[Vince Laviano, 2011/10/26 21:41:55]

This is a bitfield that contains 3 subfields representing service class, major
device class, and minor device class. We could mask out the subfields and
provide access to them as 3 separate method calls, each returning an enum value,
but I think that would be better done in a future CL once we  know what clients
care about. If we implement this in full generality, we'll have a pretty lengthy
set of enums, since each major device class applies its own meaning to the bits
in the minor device class field. See
http://bluetooth-pentest.narod.ru/software/bluetooth_class_of_device-service_...
to get a sense of how this works.

[satorux1, 2011/10/26 22:28:10]

Please add that information as a comment here.

+
+  // Returns the suggested icon for this device.
+  virtual const std::string& Icon() const = 0;

[satorux1, 2011/10/26 19:26:55]

What will string contain? An URL to an image? Please add a bit more comment, and
rename the function to something more descriptive.

[Vince Laviano, 2011/10/26 21:41:55]

"icon" is a property defined in the BlueZ D-Bus API, and I'd like to maintain a
name that's consistent with BlueZ.

It contains one of the strings defined in table 6 at
http://standards.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.htm...
that describes which sort of icon ought to be displayed for the device (but
doesn't specify a particular image). I'll add a comment explaining this.

+
+  // Returns the name for this device.
+  virtual const std::string& Name() const = 0;

[satorux1, 2011/10/26 19:26:55]

Maybe a bit redundant but DeviceName() may be a bit clearer.

[Vince Laviano, 2011/10/26 21:41:55]

Ditto. Would like to retain the BlueZ property name.

+
+  // Returns whether or not this device is paired.
+  virtual bool Paired() const = 0;
+
+  // Returns a dictionary representation of this device.
+  virtual const DictionaryValue& DictionaryRep() const = 0;

[satorux1, 2011/10/26 19:26:55]

AsDictionary() may be a bit better name?

[Vince Laviano, 2011/10/26 21:41:55]

Done.

+
+  // Creates a device with property values based on |properties|.
+  static BluetoothDevice* Create(const DictionaryValue& properties);
+
+ protected:
+  BluetoothDevice();
+
+ private:
+  DISALLOW_COPY_AND_ASSIGN(BluetoothDevice);
+};
+
+}  // namespace chromeos
+
+#endif  // CHROME_BROWSER_CHROMEOS_BLUETOOTH_BLUETOOTH_DEVICE_H_