summaryrefslogtreecommitdiffstats
path: root/chromeos/dbus/bluetooth_adapter_client.h
diff options
context:
space:
mode:
authorkeybuk@chromium.org <keybuk@chromium.org@0039d316-1c4b-4281-b951-d872f2087c98>2013-06-12 14:47:32 +0000
committerkeybuk@chromium.org <keybuk@chromium.org@0039d316-1c4b-4281-b951-d872f2087c98>2013-06-12 14:47:32 +0000
commit627f4f4ec29191d02998358a0b9d8896547ffca1 (patch)
treedba063c373e62ef6dca9cd8dd0fc05150aa8efd4 /chromeos/dbus/bluetooth_adapter_client.h
parent5ddc6f5f34fc08363a5acbdd089a1d8be680e8fb (diff)
downloadchromium_src-627f4f4ec29191d02998358a0b9d8896547ffca1.zip
chromium_src-627f4f4ec29191d02998358a0b9d8896547ffca1.tar.gz
chromium_src-627f4f4ec29191d02998358a0b9d8896547ffca1.tar.bz2
Bluetooth: drop "Experimental" from Chrome OS backend
BUG=221813 TEST=device_unittests Review URL: https://chromiumcodereview.appspot.com/14932007 git-svn-id: svn://svn.chromium.org/chrome/trunk/src@205777 0039d316-1c4b-4281-b951-d872f2087c98
Diffstat (limited to 'chromeos/dbus/bluetooth_adapter_client.h')
-rw-r--r--chromeos/dbus/bluetooth_adapter_client.h161
1 files changed, 161 insertions, 0 deletions
diff --git a/chromeos/dbus/bluetooth_adapter_client.h b/chromeos/dbus/bluetooth_adapter_client.h
new file mode 100644
index 0000000..60eaff8
--- /dev/null
+++ b/chromeos/dbus/bluetooth_adapter_client.h
@@ -0,0 +1,161 @@
+// 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 CHROMEOS_DBUS_BLUETOOTH_ADAPTER_CLIENT_H_
+#define CHROMEOS_DBUS_BLUETOOTH_ADAPTER_CLIENT_H_
+
+#include <string>
+#include <vector>
+
+#include "base/callback.h"
+#include "base/observer_list.h"
+#include "base/values.h"
+#include "chromeos/chromeos_export.h"
+#include "chromeos/dbus/dbus_client_implementation_type.h"
+#include "dbus/object_path.h"
+#include "dbus/property.h"
+
+namespace dbus {
+class Bus;
+} // namespace dbus
+
+namespace chromeos {
+
+// BluetoothAdapterClient is used to communicate with objects representing
+// local Bluetooth Adapters.
+class CHROMEOS_EXPORT BluetoothAdapterClient {
+ public:
+ // Structure of properties associated with bluetooth adapters.
+ struct Properties : public dbus::PropertySet {
+ // The Bluetooth device address of the adapter. Read-only.
+ dbus::Property<std::string> address;
+
+ // The Bluetooth system name, generally derived from the hostname.
+ dbus::Property<std::string> name;
+
+ // The Bluetooth friendly name of the adapter, unlike remote devices,
+ // this property can be changed to change the presentation for when
+ // the adapter is discoverable.
+ dbus::Property<std::string> alias;
+
+ // The Bluetooth class of the adapter device. Read-only.
+ dbus::Property<uint32> bluetooth_class;
+
+ // Whether the adapter radio is powered.
+ dbus::Property<bool> powered;
+
+ // Whether the adapter is discoverable by other Bluetooth devices.
+ // |discovering_timeout| is used to automatically disable after a time
+ // period.
+ dbus::Property<bool> discoverable;
+
+ // Whether the adapter accepts incoming pairing requests from other
+ // Bluetooth devices. |pairable_timeout| is used to automatically disable
+ // after a time period.
+ dbus::Property<bool> pairable;
+
+ // The timeout in seconds to cease accepting incoming pairing requests
+ // after |pairable| is set to true. Zero means adapter remains pairable
+ // forever.
+ dbus::Property<uint32> pairable_timeout;
+
+ // The timeout in seconds to cease the adapter being discoverable by
+ // other Bluetooth devices after |discoverable| is set to true. Zero
+ // means adapter remains discoverable forever.
+ dbus::Property<uint32> discoverable_timeout;
+
+ // Indicates that the adapter is discovering other Bluetooth Devices.
+ // Read-only. Use StartDiscovery() to begin discovery.
+ dbus::Property<bool> discovering;
+
+ // List of 128-bit UUIDs that represent the available local services.
+ // Read-only.
+ dbus::Property<std::vector<std::string> > uuids;
+
+ // Local Device ID information in Linux kernel modalias format. Read-only.
+ dbus::Property<std::string> modalias;
+
+ Properties(dbus::ObjectProxy* object_proxy,
+ const std::string& interface_name,
+ const PropertyChangedCallback& callback);
+ virtual ~Properties();
+ };
+
+ // Interface for observing changes from a local bluetooth adapter.
+ class Observer {
+ public:
+ virtual ~Observer() {}
+
+ // Called when the adapter with object path |object_path| is added to the
+ // system.
+ virtual void AdapterAdded(const dbus::ObjectPath& object_path) {}
+
+ // Called when the adapter with object path |object_path| is removed from
+ // the system.
+ virtual void AdapterRemoved(const dbus::ObjectPath& object_path) {}
+
+ // Called when the adapter with object path |object_path| has a
+ // change in value of the property named |property_name|.
+ virtual void AdapterPropertyChanged(const dbus::ObjectPath& object_path,
+ const std::string& property_name) {}
+ };
+
+ virtual ~BluetoothAdapterClient();
+
+ // Adds and removes observers for events on all local bluetooth
+ // adapters. Check the |object_path| parameter of observer methods to
+ // determine which adapter is issuing the event.
+ virtual void AddObserver(Observer* observer) = 0;
+ virtual void RemoveObserver(Observer* observer) = 0;
+
+ // Returns the list of adapter object paths known to the system.
+ virtual std::vector<dbus::ObjectPath> GetAdapters() = 0;
+
+ // Obtain the properties for the adapter with object path |object_path|,
+ // any values should be copied if needed.
+ virtual Properties* GetProperties(const dbus::ObjectPath& object_path) = 0;
+
+ // The ErrorCallback is used by adapter methods to indicate failure.
+ // It receives two arguments: the name of the error in |error_name| and
+ // an optional message in |error_message|.
+ typedef base::Callback<void(const std::string& error_name,
+ const std::string& error_message)> ErrorCallback;
+
+ // Starts a device discovery on the adapter with object path |object_path|.
+ virtual void StartDiscovery(const dbus::ObjectPath& object_path,
+ const base::Closure& callback,
+ const ErrorCallback& error_callback) = 0;
+
+ // Cancels any previous device discovery on the adapter with object path
+ // |object_path|.
+ virtual void StopDiscovery(const dbus::ObjectPath& object_path,
+ const base::Closure& callback,
+ const ErrorCallback& error_callback) = 0;
+
+ // Removes from the adapter with object path |object_path| the remote
+ // device with object path |object_path| from the list of known devices
+ // and discards any pairing information.
+ virtual void RemoveDevice(const dbus::ObjectPath& object_path,
+ const dbus::ObjectPath& device_path,
+ const base::Closure& callback,
+ const ErrorCallback& error_callback) = 0;
+
+ // Creates the instance.
+ static BluetoothAdapterClient* Create(DBusClientImplementationType type,
+ dbus::Bus* bus);
+
+ // Constants used to indicate exceptional error conditions.
+ static const char kNoResponseError[];
+ static const char kUnknownAdapterError[];
+
+ protected:
+ BluetoothAdapterClient();
+
+ private:
+ DISALLOW_COPY_AND_ASSIGN(BluetoothAdapterClient);
+};
+
+} // namespace chromeos
+
+#endif // CHROMEOS_DBUS_BLUETOOTH_ADAPTER_CLIENT_H_