common/hibernate_interface.h

//
// Copyright (C) 2022 The Android Open Source Project
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//

#ifndef UPDATE_ENGINE_COMMON_HIBERNATE_INTERFACE_H_
#define UPDATE_ENGINE_COMMON_HIBERNATE_INTERFACE_H_

#include <memory>
#include <string>

namespace chromeos_update_engine {

// The abstract hibernate interface defines the interaction with and information
// about the system's hibernation state.
class HibernateInterface {
 public:
  HibernateInterface(const HibernateInterface&) = delete;
  HibernateInterface& operator=(const HibernateInterface&) = delete;

  virtual ~HibernateInterface() = default;

  // Returns true if the system is resuming from hibernate.
  virtual bool IsResuming() = 0;

  // Aborts a resume from hibernate, if one is in progress.
  virtual bool AbortResume(const std::string& reason) = 0;

 protected:
  HibernateInterface() = default;
};

// This factory function creates a new HibernateInterface instance for the
// current platform.
std::unique_ptr<HibernateInterface> CreateHibernateService();

}  // namespace chromeos_update_engine

#endif  // UPDATE_ENGINE_COMMON_HIBERNATE_INTERFACE_H_