shill/static_ip_parameters.h

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

#ifndef SHILL_STATIC_IP_PARAMETERS_H_
#define SHILL_STATIC_IP_PARAMETERS_H_

#include <string>

#include "shill/network/network_config.h"
#include "shill/store/key_value_store.h"
#include "shill/store/property_store.h"

namespace shill {
class StoreInterface;

// Holder for static IP parameters. Includes methods for reading and displaying
// values over a control API and methods for loading and storing this to a
// persistent store. This class is an internal implementation of the Service
// class.
class StaticIPParameters {
 public:
  // Converts the StaticIPParameters from NetworkConfig to KeyValueStore.
  static KeyValueStore NetworkConfigToKeyValues(const NetworkConfig& props);

  StaticIPParameters();
  StaticIPParameters(const StaticIPParameters&) = delete;
  StaticIPParameters& operator=(const StaticIPParameters&) = delete;

  ~StaticIPParameters();

  // Take a property store and add static IP parameters to them.
  void PlumbPropertyStore(PropertyStore* store);

  // Load static IP parameters from a persistent store with id |storage_id|.
  // Return whether any property is changed.
  bool Load(const StoreInterface* storage, const std::string& storage_id);

  // Save static IP parameters to a persistent store with id |storage_id|.
  void Save(StoreInterface* storage, const std::string& storage_id);

  // Reset all states to defaults (e.g. when a service is unloaded).
  void Reset();

  const NetworkConfig& config() const { return config_; }

 private:
  KeyValueStore GetStaticIPConfig(Error* error);
  bool SetStaticIP(const KeyValueStore& value, Error* error);

  NetworkConfig config_;
};

}  // namespace shill

#endif  // SHILL_STATIC_IP_PARAMETERS_H_