components/proximity_auth/proximity_monitor.h

   1 // Copyright 2015 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef COMPONENTS_PROXIMITY_AUTH_PROXIMITY_MONITOR_H
   6 #define COMPONENTS_PROXIMITY_AUTH_PROXIMITY_MONITOR_H
   7
   8 namespace proximity_auth {
   9
  10 // An interface that is responsible for tracking whether the remote device is
  11 // sufficiently close to the local device to permit unlocking.
  12 class ProximityMonitor {
  13  public:
  14   enum class Strategy { NONE, CHECK_RSSI, CHECK_TRANSMIT_POWER };
  15
  16   virtual ~ProximityMonitor() {}
  17
  18   // Activates the proximity monitor. No-op if the proximity monitor is already
  19   // active.
  20   virtual void Start() = 0;
  21
  22   // Deactivates the proximity monitor. No-op if the proximity monitor is
  23   // already inactive.
  24   virtual void Stop() = 0;
  25
  26   // Returns the strategy used to determine whether the remote device is in
  27   // proximity.
  28   virtual Strategy GetStrategy() const = 0;
  29
  30   // Returns |true| iff the remote device is close enough to the local device,
  31   // given the user's current settings.
  32   virtual bool IsUnlockAllowed() const = 0;
  33
  34   // Returns |true| iff the remote device is close enough to the local device,
  35   // according to its RSSI measurement.
  36   virtual bool IsInRssiRange() const = 0;
  37
  38   // Records the current proximity measurements to UMA. This should be called
  39   // when the user successfully authenticates using proximity auth.
  40   virtual void RecordProximityMetricsOnAuthSuccess() = 0;
  41 };
  42
  43 }  // namespace proximity_auth
  44
  45 #endif  // COMPONENTS_PROXIMITY_AUTH_PROXIMITY_MONITOR_H