diff options
author | tommycli <tommycli@chromium.org> | 2015-11-04 09:07:14 -0800 |
---|---|---|
committer | Commit bot <commit-bot@chromium.org> | 2015-11-04 17:08:15 +0000 |
commit | b391a8d38a119bb6625f1429c262c46960d52580 (patch) | |
tree | 9910ddf3cfc878a75f998acb215bea9801abbd9b /chromeos/dbus/bluetooth_gatt_characteristic_client.h | |
parent | 38cb3fcf4e18ce504aa08ad8bb0ccc220e14a8e2 (diff) | |
download | chromium_src-b391a8d38a119bb6625f1429c262c46960d52580.zip chromium_src-b391a8d38a119bb6625f1429c262c46960d52580.tar.gz chromium_src-b391a8d38a119bb6625f1429c262c46960d52580.tar.bz2 |
Revert of Reland: Refactor DBusThreadManager to split away BT clients. (patchset #1 id:1 of https://codereview.chromium.org/1411793010/ )
Reason for revert:
Crashes memory bot http://build.chromium.org/p/chromium.memory.fyi/builders/Chromium%20OS%20%28valgrind%29%284%29
Original issue's description:
> Reland: Refactor DBusThreadManager to split away BT clients.
>
> This is a reland of https://codereview.chromium.org/1347193004/
>
> This CL doesn't change any of the code except for merge and lint changes.
>
> The original CL was triggering a test crash in Valgrind. On this patch,
> I've run Valgrind multiple times locally and also additionally run TSan.
> Since I am seeing no failures, after talking to glider@ (who works on
> Valgrind), I'm attempting to re-land this CL.
>
> TBR=armansito@chromium.org, glider@chromium.org, isherman@chromium.org, oshima@chromium.org, sky@chromium.org, stevenjb@chromium.org
> BUG=None.
>
> Committed: https://crrev.com/3c56b94daaf6513891e7da3094ab5054ffbd6262
> Cr-Commit-Position: refs/heads/master@{#357707}
TBR=armansito@chromium.org,glider@chromium.org,isherman@chromium.org,oshima@chromium.org,sky@chromium.org,stevenjb@chromium.org,rkc@chromium.org
NOPRESUBMIT=true
NOTREECHECKS=true
NOTRY=true
BUG=None.
Review URL: https://codereview.chromium.org/1409383004
Cr-Commit-Position: refs/heads/master@{#357834}
Diffstat (limited to 'chromeos/dbus/bluetooth_gatt_characteristic_client.h')
-rw-r--r-- | chromeos/dbus/bluetooth_gatt_characteristic_client.h | 143 |
1 files changed, 143 insertions, 0 deletions
diff --git a/chromeos/dbus/bluetooth_gatt_characteristic_client.h b/chromeos/dbus/bluetooth_gatt_characteristic_client.h new file mode 100644 index 0000000..b040b56 --- /dev/null +++ b/chromeos/dbus/bluetooth_gatt_characteristic_client.h @@ -0,0 +1,143 @@ +// Copyright 2014 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_GATT_CHARACTERISTIC_CLIENT_H_ +#define CHROMEOS_DBUS_BLUETOOTH_GATT_CHARACTERISTIC_CLIENT_H_ + +#include <string> +#include <vector> + +#include "base/basictypes.h" +#include "base/callback.h" +#include "chromeos/chromeos_export.h" +#include "chromeos/dbus/dbus_client.h" +#include "dbus/object_path.h" +#include "dbus/property.h" + +namespace chromeos { + +// BluetoothGattCharacteristicClient is used to communicate with remote GATT +// characteristic objects exposed by the Bluetooth daemon. +class CHROMEOS_EXPORT BluetoothGattCharacteristicClient : public DBusClient { + public: + // Structure of properties associated with GATT characteristics. + struct Properties : public dbus::PropertySet { + // The 128-bit characteristic UUID. [read-only] + dbus::Property<std::string> uuid; + + // Object path of the GATT service the characteristic belongs to. + // [read-only] + dbus::Property<dbus::ObjectPath> service; + + // The cached value of the characteristic. This property gets updated only + // after a successful read request and when a notification or indication is + // received. [read-only] + dbus::Property<std::vector<uint8_t>> value; + + // Whether or not this characteristic is currently sending ValueUpdated + // signals. [read-only] + dbus::Property<bool> notifying; + + // List of flags representing the GATT "Characteristic Properties bit field" + // and properties read from the GATT "Characteristic Extended Properties" + // descriptor bit field. [read-only, optional] + dbus::Property<std::vector<std::string>> flags; + + // Array of object paths representing the descriptors of this + // characteristic. [read-only] + dbus::Property<std::vector<dbus::ObjectPath>> descriptors; + + Properties(dbus::ObjectProxy* object_proxy, + const std::string& interface_name, + const PropertyChangedCallback& callback); + ~Properties() override; + }; + + // Interface for observing changes from a remote GATT characteristic. + class Observer { + public: + virtual ~Observer() {} + + // Called when the GATT characteristic with object path |object_path| is + // added to the system. + virtual void GattCharacteristicAdded(const dbus::ObjectPath& object_path) {} + + // Called when the GATT characteristic with object path |object_path| is + // removed from the system. + virtual void GattCharacteristicRemoved( + const dbus::ObjectPath& object_path) {} + + // Called when the GATT characteristic with object path |object_path| has a + // change in the value of the property named |property_name|. + virtual void GattCharacteristicPropertyChanged( + const dbus::ObjectPath& object_path, + const std::string& property_name) {} + }; + + // Callbacks used to report the result of asynchronous methods. + typedef base::Callback<void(const std::string& error_name, + const std::string& error_message)> ErrorCallback; + typedef base::Callback<void(const std::vector<uint8>& value)> ValueCallback; + + ~BluetoothGattCharacteristicClient() override; + + // Adds and removes observers for events on all remote GATT characteristics. + // Check the |object_path| parameter of observer methods to determine which + // GATT characteristic is issuing the event. + virtual void AddObserver(Observer* observer) = 0; + virtual void RemoveObserver(Observer* observer) = 0; + + // Returns the list of GATT characteristic object paths known to the system. + virtual std::vector<dbus::ObjectPath> GetCharacteristics() = 0; + + // Obtain the properties for the GATT characteristic with object path + // |object_path|. Values should be copied if needed. + virtual Properties* GetProperties(const dbus::ObjectPath& object_path) = 0; + + // Issues a request to read the value of GATT characteristic with object path + // |object_path| and returns the value in |callback| on success. On error, + // invokes |error_callback|. + virtual void ReadValue(const dbus::ObjectPath& object_path, + const ValueCallback& callback, + const ErrorCallback& error_callback) = 0; + + // Issues a request to write the value of GATT characteristic with object path + // |object_path| with value |value|. Invokes |callback| on success and + // |error_callback| on failure. + virtual void WriteValue(const dbus::ObjectPath& object_path, + const std::vector<uint8>& value, + const base::Closure& callback, + const ErrorCallback& error_callback) = 0; + + // Starts a notification session from this characteristic with object path + // |object_path| if it supports value notifications or indications. Invokes + // |callback| on success and |error_callback| on failure. + virtual void StartNotify(const dbus::ObjectPath& object_path, + const base::Closure& callback, + const ErrorCallback& error_callback) = 0; + + // Cancels any previous StartNotify transaction for characteristic with + // object path |object_path|. Invokes |callback| on success and + // |error_callback| on failure. + virtual void StopNotify(const dbus::ObjectPath& object_path, + const base::Closure& callback, + const ErrorCallback& error_callback) = 0; + + // Creates the instance. + static BluetoothGattCharacteristicClient* Create(); + + // Constants used to indicate exceptional error conditions. + static const char kNoResponseError[]; + static const char kUnknownCharacteristicError[]; + + protected: + BluetoothGattCharacteristicClient(); + + private: + DISALLOW_COPY_AND_ASSIGN(BluetoothGattCharacteristicClient); +}; + +} // namespace chromeos + +#endif // CHROMEOS_DBUS_BLUETOOTH_GATT_CHARACTERISTIC_CLIENT_H_ |