| // 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_DBUS_SHILL_IPCONFIG_CLIENT_H_ |
| #define CHROMEOS_DBUS_SHILL_IPCONFIG_CLIENT_H_ |
| |
| #include <string> |
| |
| #include "base/basictypes.h" |
| #include "base/callback.h" |
| #include "chromeos/chromeos_export.h" |
| #include "chromeos/dbus/dbus_client.h" |
| #include "chromeos/dbus/shill_client_helper.h" |
| |
| namespace base { |
| |
| class Value; |
| class DictionaryValue; |
| |
| } // namespace base |
| |
| namespace dbus { |
| |
| class ObjectPath; |
| |
| } // namespace dbus |
| |
| namespace chromeos { |
| |
| class ShillPropertyChangedObserver; |
| |
| // ShillIPConfigClient is used to communicate with the Shill IPConfig |
| // service. All methods should be called from the origin thread which |
| // initializes the DBusThreadManager instance. |
| class CHROMEOS_EXPORT ShillIPConfigClient : public DBusClient { |
| public: |
| typedef ShillClientHelper::PropertyChangedHandler PropertyChangedHandler; |
| typedef ShillClientHelper::DictionaryValueCallback DictionaryValueCallback; |
| |
| class TestInterface { |
| public: |
| // Adds an IPConfig entry. |
| virtual void AddIPConfig(const std::string& ip_config_path, |
| const base::DictionaryValue& properties) = 0; |
| |
| protected: |
| virtual ~TestInterface() {} |
| }; |
| |
| virtual ~ShillIPConfigClient(); |
| |
| // Factory function, creates a new instance which is owned by the caller. |
| // For normal usage, access the singleton via DBusThreadManager::Get(). |
| static ShillIPConfigClient* Create(); |
| |
| // Adds a property changed |observer| for the ipconfig at |ipconfig_path|. |
| virtual void AddPropertyChangedObserver( |
| const dbus::ObjectPath& ipconfig_path, |
| ShillPropertyChangedObserver* observer) = 0; |
| |
| // Removes a property changed |observer| for the ipconfig at |ipconfig_path|. |
| virtual void RemovePropertyChangedObserver( |
| const dbus::ObjectPath& ipconfig_path, |
| ShillPropertyChangedObserver* observer) = 0; |
| |
| // Refreshes the active IP configuration after service property changes and |
| // renews the DHCP lease, if any. |
| virtual void Refresh(const dbus::ObjectPath& ipconfig_path, |
| const VoidDBusMethodCallback& callback) = 0; |
| |
| // Calls GetProperties method. |
| // |callback| is called after the method call succeeds. |
| virtual void GetProperties(const dbus::ObjectPath& ipconfig_path, |
| const DictionaryValueCallback& callback) = 0; |
| |
| // Calls SetProperty method. |
| // |callback| is called after the method call succeeds. |
| virtual void SetProperty(const dbus::ObjectPath& ipconfig_path, |
| const std::string& name, |
| const base::Value& value, |
| const VoidDBusMethodCallback& callback) = 0; |
| |
| // Calls ClearProperty method. |
| // |callback| is called after the method call succeeds. |
| virtual void ClearProperty(const dbus::ObjectPath& ipconfig_path, |
| const std::string& name, |
| const VoidDBusMethodCallback& callback) = 0; |
| |
| // Calls Remove method. |
| // |callback| is called after the method call succeeds. |
| virtual void Remove(const dbus::ObjectPath& ipconfig_path, |
| const VoidDBusMethodCallback& callback) = 0; |
| |
| // Returns an interface for testing (stub only), or returns NULL. |
| virtual ShillIPConfigClient::TestInterface* GetTestInterface() = 0; |
| |
| protected: |
| friend class ShillIPConfigClientTest; |
| |
| // Create() should be used instead. |
| ShillIPConfigClient(); |
| |
| private: |
| DISALLOW_COPY_AND_ASSIGN(ShillIPConfigClient); |
| }; |
| |
| } // namespace chromeos |
| |
| #endif // CHROMEOS_DBUS_SHILL_IPCONFIG_CLIENT_H_ |