components/download/internal/background_service/scheduler/device_status.h

// Copyright 2017 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef COMPONENTS_DOWNLOAD_INTERNAL_BACKGROUND_SERVICE_SCHEDULER_DEVICE_STATUS_H_
#define COMPONENTS_DOWNLOAD_INTERNAL_BACKGROUND_SERVICE_SCHEDULER_DEVICE_STATUS_H_

#include "components/download/public/background_service/download_params.h"

namespace download {

// Battery status used in download service.
enum class BatteryStatus {
  CHARGING = 0,
  NOT_CHARGING = 1,
  UNKNOWN = 2,
};

// NetworkStatus should mostly one to one map to
// SchedulingParams::NetworkRequirements. Has coarser granularity than
// network connection type.
enum class NetworkStatus {
  DISCONNECTED = 0,
  UNMETERED = 1,  // WIFI or Ethernet.
  METERED = 2,    // Mobile networks.
};

// Contains battery and network status.
struct DeviceStatus {
  // Optimal battery percentage that always start the background task.
  static const int kBatteryPercentageAlwaysStart;

  DeviceStatus();
  DeviceStatus(BatteryStatus battery, NetworkStatus network);
  DeviceStatus(BatteryStatus battery,
               int battery_percentage,
               NetworkStatus network);

  struct Result {
    Result();
    bool MeetsRequirements() const;
    bool meets_battery_requirement;
    bool meets_network_requirement;
  };

  BatteryStatus battery_status;

  // Battery percentage which is in the range of [0, 100].
  int battery_percentage;

  NetworkStatus network_status;

  friend bool operator==(const DeviceStatus&, const DeviceStatus&) = default;

  // Returns if the current device status meets all the conditions defined in
  // the scheduling parameters.
  Result MeetsCondition(const SchedulingParams& params,
                        int download_battery_percentage) const;
};

// The criteria when the background download task should start.
struct Criteria {
  Criteria(int optimal_battery_percentage);
  Criteria(bool requires_battery_charging,
           bool requires_unmetered_network,
           int optimal_battery_percentage);
  bool operator==(const Criteria& other) const;
  bool requires_battery_charging;
  bool requires_unmetered_network;
  int optimal_battery_percentage;
};

}  // namespace download

#endif  // COMPONENTS_DOWNLOAD_INTERNAL_BACKGROUND_SERVICE_SCHEDULER_DEVICE_STATUS_H_