summaryrefslogtreecommitdiffstats
path: root/device/bluetooth/dbus/bluetooth_profile_service_provider.h
diff options
context:
space:
mode:
authorrkc <rkc@chromium.org>2015-11-04 17:55:40 -0800
committerCommit bot <commit-bot@chromium.org>2015-11-05 01:56:30 +0000
commit06c92c041f3b7b62bcddec714fb886b431865057 (patch)
tree1745f16086c453e1671e6b02df73626cded2f295 /device/bluetooth/dbus/bluetooth_profile_service_provider.h
parenta9ed17edd6831510d2d50680824740a485ae25d6 (diff)
downloadchromium_src-06c92c041f3b7b62bcddec714fb886b431865057.zip
chromium_src-06c92c041f3b7b62bcddec714fb886b431865057.tar.gz
chromium_src-06c92c041f3b7b62bcddec714fb886b431865057.tar.bz2
Reland: Refactor DBusThreadManager to split away BT clients.
This is a reland of 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: c56b94daaf6513891e7da3094ab5054ffbd6262 Cr-Commit-Position: refs/heads/master@{#357707} Review URL: https://codereview.chromium.org/1411793010 Cr-Commit-Position: refs/heads/master@{#357976}
Diffstat (limited to 'device/bluetooth/dbus/bluetooth_profile_service_provider.h')
-rw-r--r--device/bluetooth/dbus/bluetooth_profile_service_provider.h120
1 files changed, 120 insertions, 0 deletions
diff --git a/device/bluetooth/dbus/bluetooth_profile_service_provider.h b/device/bluetooth/dbus/bluetooth_profile_service_provider.h
new file mode 100644
index 0000000..f2db22c
--- /dev/null
+++ b/device/bluetooth/dbus/bluetooth_profile_service_provider.h
@@ -0,0 +1,120 @@
+// 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 DEVICE_BLUETOOTH_DBUS_BLUETOOTH_PROFILE_SERVICE_PROVIDER_H_
+#define DEVICE_BLUETOOTH_DBUS_BLUETOOTH_PROFILE_SERVICE_PROVIDER_H_
+
+#include <string>
+
+#include "base/basictypes.h"
+#include "base/callback.h"
+#include "base/memory/scoped_ptr.h"
+#include "dbus/bus.h"
+#include "dbus/file_descriptor.h"
+#include "dbus/object_path.h"
+#include "device/bluetooth/bluetooth_export.h"
+
+namespace bluez {
+
+// BluetoothProfileServiceProvider is used to provide a D-Bus object that the
+// Bluetooth daemon can communicate with to connect application profiles.
+//
+// Instantiate with a chosen D-Bus object path and delegate object, and pass
+// the D-Bus object path as the |agent_path| argument to the
+// chromeos::BluetoothProfileManagerClient::RegisterProfile() method.
+//
+// When an incoming profile connection occurs, or after initiating a connection
+// using the chromeos::BluetoothDeviceClient::ConnectProfile() method, the
+// Bluetooth daemon will make calls to this profile object and they will be
+// passed on to your Delegate object for handling. Responses should be returned
+// using the callbacks supplied to those methods.
+class DEVICE_BLUETOOTH_EXPORT BluetoothProfileServiceProvider {
+ public:
+ // Interface for reacting to profile requests.
+ class Delegate {
+ public:
+ virtual ~Delegate() {}
+
+ // Possible status values that may be returned to callbacks on a new
+ // connection or a requested disconnection. Success indicates acceptance,
+ // reject indicates the user rejected or denied the request; cancelled
+ // means the user cancelled the request without confirming either way.
+ enum Status { SUCCESS, REJECTED, CANCELLED };
+
+ // Connection-specific options.
+ struct DEVICE_BLUETOOTH_EXPORT Options {
+ Options() {}
+ ~Options() {}
+
+ // Profile version.
+ uint16 version;
+
+ // Profile features.
+ uint16 features;
+ };
+
+ // The ConfirmationCallback is used for methods which require confirmation;
+ // it should be called with one argument, the |status| of the request
+ // (success, rejected or cancelled).
+ typedef base::Callback<void(Status)> ConfirmationCallback;
+
+ // This method will be called when the profile is unregistered from the
+ // Bluetooth daemon, generally at shutdown or at the applications' request.
+ // It may be used to perform cleanup tasks. This corresponds to the
+ // org.bluez.Profile1.Release method and is renamed to avoid a conflict
+ // with base::Refcounted<T>.
+ virtual void Released() = 0;
+
+ // This method will be called when a profile connection to the device
+ // with object path |device_path| is established. |callback| must be called
+ // to confirm the connection, or indicate rejection or cancellation.
+ //
+ // A file descriptor for the connection socket is provided in |fd|, and
+ // details about the specific implementation of the profile in |options|.
+ //
+ // IMPORTANT: Ownership of the file descriptor object |fd| is passed to
+ // the delegate by this call. The delegate is responsible for checking the
+ // validity of |fd| on a thread where I/O is permitted before taking the
+ // value. If the value is not taken, the file descriptor is closed.
+ //
+ // Ownership of |options| is NOT passed so information out of it must be
+ // copied if required.
+ virtual void NewConnection(const dbus::ObjectPath& device_path,
+ scoped_ptr<dbus::FileDescriptor> fd,
+ const Options& options,
+ const ConfirmationCallback& callback) = 0;
+
+ // This method will be called when a profile connection to the device
+ // with object path |device_path| is disconnected. Any file descriptors
+ // owned by the service should be cleaned up and |callback| called to
+ // confirm, or indicate rejection or cancellation of the disconnection.
+ virtual void RequestDisconnection(const dbus::ObjectPath& device_path,
+ const ConfirmationCallback& callback) = 0;
+
+ // This method will be called by the Bluetooth daemon to indicate that
+ // a profile request failed before a reply was returned from the device.
+ virtual void Cancel() = 0;
+ };
+
+ virtual ~BluetoothProfileServiceProvider();
+
+ // Creates the instance where |bus| is the D-Bus bus connection to export
+ // the object onto, |object_path| is the object path that it should have
+ // and |delegate| is the object to which all method calls will be passed
+ // and responses generated from.
+ static BluetoothProfileServiceProvider* Create(
+ dbus::Bus* bus,
+ const dbus::ObjectPath& object_path,
+ Delegate* delegate);
+
+ protected:
+ BluetoothProfileServiceProvider();
+
+ private:
+ DISALLOW_COPY_AND_ASSIGN(BluetoothProfileServiceProvider);
+};
+
+} // namespace bluez
+
+#endif // DEVICE_BLUETOOTH_DBUS_BLUETOOTH_PROFILE_SERVICE_PROVIDER_H_