Add chromeos::NetworkStateManager

chromeos/network/managed_state.h

+// Copyright (c) 2012 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.
+
+#ifndef CHROMEOS_NETWORK_MANAGED_STATE_H_
+#define CHROMEOS_NETWORK_MANAGED_STATE_H_
+
+#include <string>
+
+#include "base/basictypes.h"
+#include "base/compiler_specific.h"
+#include "chromeos/chromeos_export.h"
+
+namespace base {
+class Value;
+}
+
+namespace chromeos {
+
+class DeviceState;
+class NetworkState;
+
+// Base class for states managed by NetworkStateManger which are associated
+// with a Shill path (e.g. service path or device path).
+class ManagedState {
+ public:
+  enum ManagedType {
+    MANAGED_TYPE_NETWORK,
+    MANAGED_TYPE_DEVICE
+  };
+
+  virtual ~ManagedState();
+
+  // This will construct and return a new instance of the approprate class
+  // based on |type|.
+  static ManagedState* Create(ManagedType type, const std::string& path);
+
+  // Returns the specific class pointer if this is the correct type, or
+  // NULL if it is not.
+  NetworkState* AsNetworkState();
+  DeviceState* AsDeviceState();
+
+  // Called by NetworkStateHandler when a property changes. Returns true if
+  // the property was recognized and parsed successfully.
+  virtual bool PropertyChanged(const std::string& key,
+                               const base::Value& value) = 0;
+
+  const ManagedType managed_type() const { return managed_type_; }
+  const std::string& path() const { return path_; }
+  const std::string& name() const { return name_; }
+  const std::string& type() const { return type_; }
+  bool is_observed() const { return is_observed_; }
+  void set_is_observed(bool is_observed) { is_observed_ = is_observed; }
+
+ protected:
+  ManagedState(ManagedType type, const std::string& path);
+
+  // Parses common property keys (name, type).
+  bool ManagedStatePropertyChanged(const std::string& key,
+                                   const base::Value& value);
+
+  // Helper methods that log warnings if parsing failed.

[gauravsh, 2012/11/06 01:56:59]

If parsing fails, they also return false, correct? That seems more worth
mentioning then the part about logging. 

Would letting the caller do the logging in case of failure make more sense? will
these messages be too spammy, and should perhaps be logged at a higher verbosity
level?

[stevenjb, 2012/11/06 03:17:03]

Done.
These are never expected to fail; if they do then we have malformed data in a
base::Value, or are calling the wrong method.

+  bool GetBooleanValue(const std::string& key,
+                       const base::Value& value,
+                       bool* out_value);
+  bool GetIntegerValue(const std::string& key,
+                       const base::Value& value,
+                       int* out_value);
+  bool GetStringValue(const std::string& key,
+                      const base::Value& value,
+                      std::string* out_value);
+
+ private:
+  ManagedType managed_type_;
+  std::string path_;

[gauravsh, 2012/11/06 01:56:59]

Either add comments that describe what these are meant to represent, or make the
names more descriptive. path, name and type are very generic names.

[stevenjb, 2012/11/06 03:17:03]

Added comments.

+  std::string name_;
+  std::string type_;
+  bool is_observed_;  // Tracks when the state is being observed.
+
+  DISALLOW_COPY_AND_ASSIGN(ManagedState);
+};
+
+}  // namespace chromeos
+
+#endif  // CHROMEOS_NETWORK_MANAGED_STATE_H_