common/excluder_interface.h

//
// Copyright (C) 2020 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_EXCLUDER_INTERFACE_H_
#define UPDATE_ENGINE_COMMON_EXCLUDER_INTERFACE_H_

#include <memory>
#include <string>

#include <base/macros.h>

namespace chromeos_update_engine {

class PrefsInterface;

class ExcluderInterface {
 public:
  virtual ~ExcluderInterface() = default;

  // Returns true on successfuly excluding |name|, otherwise false. On a
  // successful |Exclude()| the passed in |name| will be considered excluded
  // and calls to |IsExcluded()| will return true. The exclusions are persisted.
  virtual bool Exclude(const std::string& name) = 0;

  // Returns true if |name| reached the exclusion limit, otherwise false.
  virtual bool IsExcluded(const std::string& name) = 0;

  // Returns true on sucessfully reseting the entire exclusion state, otherwise
  // false. On a successful |Reset()| there will be no excluded |name| in the
  // exclusion state.
  virtual bool Reset() = 0;

  // Not copyable or movable
  ExcluderInterface(const ExcluderInterface&) = delete;
  ExcluderInterface& operator=(const ExcluderInterface&) = delete;
  ExcluderInterface(ExcluderInterface&&) = delete;
  ExcluderInterface& operator=(ExcluderInterface&&) = delete;

 protected:
  ExcluderInterface() = default;
};

std::unique_ptr<ExcluderInterface> CreateExcluder(PrefsInterface* prefs);

}  // namespace chromeos_update_engine

#endif  // UPDATE_ENGINE_COMMON_EXCLUDER_INTERFACE_H_