// Copyright 2020 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CHROMEOS_ASH_COMPONENTS_PHONEHUB_TETHER_CONTROLLER_H_
#define CHROMEOS_ASH_COMPONENTS_PHONEHUB_TETHER_CONTROLLER_H_
#include <ostream>
#include "base/observer_list.h"
#include "base/observer_list_types.h"
namespace ash {
namespace phonehub {
// Exposes Instant Tethering functionality to Phone Hub.
class TetherController {
public:
// Note: Numerical values should stay in sync with JS enums within the debug
// UI at //chrome/browser/resources/chromeos/multidevice_internals/types.js.
enum class Status {
// The device is ineligible for Instant Tethering, potentially due to the
// flag being disabled (on Chrome OS or on the phone) or due to an
// enterprise policy.
kIneligibleForFeature = 0,
// Instant Tethering is available for use, but currently a connection is
// unavailable. There are a variety of reasons why this may be the case:
// the feature could have been disabled in settings, or the phone may not
// have Google Play Services notifications enabled, which are required
// for the feature. Note that the phone having no reception or no SIM card
// does not count in this case; instead, kNoReception is used.
kConnectionUnavailable = 1,
// It is possible to connect, but no connection is active or in progress.
// This state can occur if a previously-active connection has been
// disconnected.
kConnectionAvailable = 2,
// Initiating an Instant Tethering connection.
kConnecting = 3,
// Connected via Instant Tethering.
kConnected = 4,
// The phone has no reception (including no SIM).
kNoReception = 5,
};
class Observer : public base::CheckedObserver {
public:
~Observer() override = default;
// Called the status has changed; use GetStatus() to get the new status.
virtual void OnTetherStatusChanged() = 0;
// Called when AttemptConnection() is called, a scan for a tether network is
// requested, but no tether network was found.
virtual void OnAttemptConnectionScanFailed() {}
};
TetherController(const TetherController&) = delete;
TetherController& operator=(const TetherController&) = delete;
virtual ~TetherController();
virtual Status GetStatus() const = 0;
// Attempts to find an available Instant Tethering connection. For a
// connection to be available, the phone must be nearby, have reception, and
// have Google Play Services notifications enabled. This function is a no-op
// if the state is not kConnectionUnavailable.
virtual void ScanForAvailableConnection() = 0;
// Initiates an Instant Tethering connection. This function is a no-op if the
// state is not one of kConnectionUnavailable or kConnectionAvailable.
virtual void AttemptConnection() = 0;
// Disconnects from an active Instant Tethering connection or connection
// attempt. This function is a no-op if the state is not one of kConnecting or
// kConnected.
virtual void Disconnect() = 0;
void AddObserver(Observer* observer);
void RemoveObserver(Observer* observer);
protected:
TetherController();
void NotifyStatusChanged();
void NotifyAttemptConnectionScanFailed();
private:
base::ObserverList<Observer> observer_list_;
};
std::ostream& operator<<(std::ostream& stream, TetherController::Status status);
} // namespace phonehub
} // namespace ash
#endif // CHROMEOS_ASH_COMPONENTS_PHONEHUB_TETHER_CONTROLLER_H_
Codebase Browser
chromium