summaryrefslogtreecommitdiff
path: root/chromium/device/bluetooth/bluetooth_discovery_session.h
diff options
context:
space:
mode:
Diffstat (limited to 'chromium/device/bluetooth/bluetooth_discovery_session.h')
-rw-r--r--chromium/device/bluetooth/bluetooth_discovery_session.h23
1 files changed, 9 insertions, 14 deletions
diff --git a/chromium/device/bluetooth/bluetooth_discovery_session.h b/chromium/device/bluetooth/bluetooth_discovery_session.h
index 2f94f3324b4..1d1ac97efbc 100644
--- a/chromium/device/bluetooth/bluetooth_discovery_session.h
+++ b/chromium/device/bluetooth/bluetooth_discovery_session.h
@@ -47,12 +47,10 @@ class DEVICE_BLUETOOTH_EXPORT BluetoothDiscoverySession {
INACTIVE
};
- // Destructor automatically terminates the discovery session. If this
- // results in a call to the underlying system to stop device discovery
- // (i.e. this instance represents the last active discovery session),
- // the call may not always succeed. To be notified of such failures,
- // users are highly encouraged to call BluetoothDiscoverySession::Stop,
- // instead of relying on the destructor.
+ // Terminates the discovery session. If this is the last active discovery
+ // session, a call to the underlying system to stop device discovery is made.
+ // Users may call BluetoothDiscoverySession::Stop() if they need to observe
+ // the result of that operation, but this is usually unnecessary.
virtual ~BluetoothDiscoverySession();
// Returns true if the session is active, false otherwise. If false, the
@@ -63,14 +61,11 @@ class DEVICE_BLUETOOTH_EXPORT BluetoothDiscoverySession {
// discovery continues.
virtual bool IsActive() const;
- // Requests this discovery session instance to stop. If this instance is
- // active, the session will stop. On success, |callback| is called and
- // on error |error_callback| is called. After a successful invocation, the
- // adapter may or may not stop device discovery, depending on whether or not
- // other active discovery sessions are present. Users are highly encouraged
- // to call this method to end a discovery session, instead of relying on the
- // destructor, so that they can be notified of the result via the callback
- // arguments.
+ // Requests this discovery session instance to stop. If this is the last
+ // active discovery session, a call to the underlying system to stop device
+ // discovery is made, and |error_callback| will be invoked if such a call
+ // fails. Typically, users can ignore this and simply destroy the instance
+ // instead of calling Stop().
virtual void Stop(base::Closure callback = base::DoNothing(),
ErrorCallback error_callback = base::DoNothing());