blob: f4c87a637db42741e1045ab708406e2e8163c003 [file] [log] [blame]
// Copyright 2015 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.
#include <ostream>
#include "base/macros.h"
#include "chromeos/components/multidevice/remote_device_ref.h"
namespace chromeos {
namespace secure_channel {
class ClientChannel;
} // namespace secure_channel
} // namespace chromeos
namespace proximity_auth {
class Messenger;
// Controls the life cycle of connecting and authenticating to a remote device.
// After the life cycle is started, it can be in the following states:
// Continuiously attempts to create a connection to the remote device.
// After connecting, transitions to the AUTHENTICATING state.
// Verifies that the connected device has the correct credentials. On
// success, transitions to SECURE_CHANNEL_ESTABLISHED; otherwise,
// transitions to AUTHENTICATION_FAILED.
// Can send and receive messages securely from the remote device. Upon
// disconnection, transitions to FINDING_CONNECTION.
// Recovery state after authentication fails. After a brief wait,
// transition to FINDING_CONNECTION.
// To stop the life cycle and clean up the connection, simply destroying this
// object.
class RemoteDeviceLifeCycle {
// The possible states in the life cycle.
enum class State {
// Interface for observing changes to the life cycle.
class Observer {
virtual ~Observer() {}
// Called when the state in the life cycle changes.
virtual void OnLifeCycleStateChanged(State old_state, State new_state) = 0;
virtual ~RemoteDeviceLifeCycle() {}
// Starts the life cycle.
virtual void Start() = 0;
// Returns the RemoteDeviceRef instance that this life cycle manages.
virtual chromeos::multidevice::RemoteDeviceRef GetRemoteDevice() const = 0;
// Returns the active channel to the remote device, or null if the device is
// not yet connected.
virtual chromeos::secure_channel::ClientChannel* GetChannel() const = 0;
// Returns the current state of in the life cycle.
virtual State GetState() const = 0;
// Returns the client for sending and receiving messages. This function will
// only return an instance if the state is SECURE_CHANNEL_ESTABLISHED;
// otherwise, it will return nullptr.
virtual Messenger* GetMessenger() = 0;
// Adds an observer.
virtual void AddObserver(Observer* observer) = 0;
// Removes an observer.
virtual void RemoveObserver(Observer* observer) = 0;
std::ostream& operator<<(std::ostream& stream,
const RemoteDeviceLifeCycle::State& state);
} // namespace proximity_auth