Darin Petkov | 41c0e0a | 2012-01-09 16:38:53 +0100 | [diff] [blame] | 1 | // Copyright (c) 2012 The Chromium OS Authors. All rights reserved. |
Darin Petkov | 887f298 | 2011-07-14 16:10:17 -0700 | [diff] [blame] | 2 | // Use of this source code is governed by a BSD-style license that can be |
| 3 | // found in the LICENSE file. |
| 4 | |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 5 | #ifndef SHILL_MODEM_MANAGER_H_ |
| 6 | #define SHILL_MODEM_MANAGER_H_ |
Darin Petkov | 887f298 | 2011-07-14 16:10:17 -0700 | [diff] [blame] | 7 | |
Darin Petkov | 5c97ac5 | 2011-07-19 16:30:49 -0700 | [diff] [blame] | 8 | #include <map> |
Hristo Stefanov | ed2c28c | 2011-11-29 15:37:30 -0800 | [diff] [blame] | 9 | #include <string> |
Darin Petkov | 5c97ac5 | 2011-07-19 16:30:49 -0700 | [diff] [blame] | 10 | #include <tr1/memory> |
David Rochberg | 7cb06f6 | 2012-03-05 11:23:44 -0500 | [diff] [blame] | 11 | #include <vector> |
Darin Petkov | 5c97ac5 | 2011-07-19 16:30:49 -0700 | [diff] [blame] | 12 | |
Darin Petkov | 887f298 | 2011-07-14 16:10:17 -0700 | [diff] [blame] | 13 | #include <base/basictypes.h> |
Darin Petkov | c90fe52 | 2011-07-15 13:59:47 -0700 | [diff] [blame] | 14 | #include <base/memory/scoped_ptr.h> |
Eric Shienbrood | 9a24553 | 2012-03-07 14:20:39 -0500 | [diff] [blame] | 15 | #include <base/memory/weak_ptr.h> |
Darin Petkov | 887f298 | 2011-07-14 16:10:17 -0700 | [diff] [blame] | 16 | #include <gtest/gtest_prod.h> // for FRIEND_TEST |
| 17 | |
David Rochberg | 7cb06f6 | 2012-03-05 11:23:44 -0500 | [diff] [blame] | 18 | #include "shill/dbus_objectmanager_proxy_interface.h" |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 19 | #include "shill/dbus_properties_proxy_interface.h" |
Darin Petkov | 887f298 | 2011-07-14 16:10:17 -0700 | [diff] [blame] | 20 | #include "shill/glib.h" |
| 21 | |
Darin Petkov | 137884a | 2011-10-26 18:52:47 +0200 | [diff] [blame] | 22 | struct mobile_provider_db; |
| 23 | |
Darin Petkov | 887f298 | 2011-07-14 16:10:17 -0700 | [diff] [blame] | 24 | namespace shill { |
| 25 | |
| 26 | class ControlInterface; |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 27 | |
David Rochberg | 7cb06f6 | 2012-03-05 11:23:44 -0500 | [diff] [blame] | 28 | class DBusObjectManagerProxyInterface; |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 29 | class DBusPropertiesProxyInterface; |
Darin Petkov | 887f298 | 2011-07-14 16:10:17 -0700 | [diff] [blame] | 30 | class EventDispatcher; |
| 31 | class Manager; |
Thieu Le | 3426c8f | 2012-01-11 17:35:11 -0800 | [diff] [blame] | 32 | class Metrics; |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 33 | class Modem1; |
Darin Petkov | 5c97ac5 | 2011-07-19 16:30:49 -0700 | [diff] [blame] | 34 | class Modem; |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 35 | class ModemClassic; |
Darin Petkov | c90fe52 | 2011-07-15 13:59:47 -0700 | [diff] [blame] | 36 | class ModemManagerProxyInterface; |
Darin Petkov | ab565bb | 2011-10-06 02:55:51 -0700 | [diff] [blame] | 37 | class ProxyFactory; |
Darin Petkov | 887f298 | 2011-07-14 16:10:17 -0700 | [diff] [blame] | 38 | |
Darin Petkov | 5c97ac5 | 2011-07-19 16:30:49 -0700 | [diff] [blame] | 39 | // Handles a modem manager service and creates and destroys modem instances. |
Darin Petkov | 887f298 | 2011-07-14 16:10:17 -0700 | [diff] [blame] | 40 | class ModemManager { |
| 41 | public: |
| 42 | ModemManager(const std::string &service, |
| 43 | const std::string &path, |
| 44 | ControlInterface *control_interface, |
| 45 | EventDispatcher *dispatcher, |
Thieu Le | 3426c8f | 2012-01-11 17:35:11 -0800 | [diff] [blame] | 46 | Metrics *metrics, |
Darin Petkov | 887f298 | 2011-07-14 16:10:17 -0700 | [diff] [blame] | 47 | Manager *manager, |
Darin Petkov | 137884a | 2011-10-26 18:52:47 +0200 | [diff] [blame] | 48 | GLib *glib, |
| 49 | mobile_provider_db *provider_db); |
David Rochberg | 7cb06f6 | 2012-03-05 11:23:44 -0500 | [diff] [blame] | 50 | virtual ~ModemManager(); |
Darin Petkov | 887f298 | 2011-07-14 16:10:17 -0700 | [diff] [blame] | 51 | |
| 52 | // Starts watching for and handling the DBus modem manager service. |
| 53 | void Start(); |
| 54 | |
| 55 | // Stops watching for the DBus modem manager service and destroys any |
Darin Petkov | 5c97ac5 | 2011-07-19 16:30:49 -0700 | [diff] [blame] | 56 | // associated modems. |
Darin Petkov | 887f298 | 2011-07-14 16:10:17 -0700 | [diff] [blame] | 57 | void Stop(); |
| 58 | |
Darin Petkov | 41c0e0a | 2012-01-09 16:38:53 +0100 | [diff] [blame] | 59 | void OnDeviceInfoAvailable(const std::string &link_name); |
| 60 | |
David Rochberg | 81030ea | 2012-03-02 15:44:25 -0500 | [diff] [blame] | 61 | protected: |
| 62 | typedef std::map<std::string, std::tr1::shared_ptr<Modem> > Modems; |
| 63 | |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 64 | ControlInterface *control_interface() const { return control_interface_; } |
| 65 | EventDispatcher *dispatcher() const { return dispatcher_; } |
| 66 | Manager *manager() const { return manager_; } |
| 67 | Metrics *metrics() const { return metrics_; } |
David Rochberg | 81030ea | 2012-03-02 15:44:25 -0500 | [diff] [blame] | 68 | const std::string &owner() const { return owner_; } |
David Rochberg | 81030ea | 2012-03-02 15:44:25 -0500 | [diff] [blame] | 69 | const std::string &path() const { return path_; } |
| 70 | ProxyFactory *proxy_factory() const { return proxy_factory_; } |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 71 | mobile_provider_db *provider_db() const { return provider_db_; } |
David Rochberg | 81030ea | 2012-03-02 15:44:25 -0500 | [diff] [blame] | 72 | |
| 73 | // Connect/Disconnect to a modem manager service. |
| 74 | // Inheriting classes must call this superclass method. |
| 75 | virtual void Connect(const std::string &owner); |
| 76 | // Inheriting classes must call this superclass method. |
| 77 | virtual void Disconnect(); |
| 78 | |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 79 | bool ModemExists(const std::string &path) const; |
| 80 | // Put the modem into our modem map |
| 81 | void RecordAddedModem(std::tr1::shared_ptr<Modem> modem); |
| 82 | |
| 83 | // Removes a modem on |path|. |
| 84 | void RemoveModem(const std::string &path); |
| 85 | |
Darin Petkov | 887f298 | 2011-07-14 16:10:17 -0700 | [diff] [blame] | 86 | private: |
David Rochberg | 7cb06f6 | 2012-03-05 11:23:44 -0500 | [diff] [blame] | 87 | friend class ModemManagerCoreTest; |
| 88 | friend class ModemManagerClassicTest; |
| 89 | friend class ModemManager1Test; |
| 90 | |
Darin Petkov | 887f298 | 2011-07-14 16:10:17 -0700 | [diff] [blame] | 91 | FRIEND_TEST(ModemInfoTest, RegisterModemManager); |
David Rochberg | 7cb06f6 | 2012-03-05 11:23:44 -0500 | [diff] [blame] | 92 | FRIEND_TEST(ModemManager1Test, AddRemoveInterfaces); |
| 93 | FRIEND_TEST(ModemManager1Test, Connect); |
| 94 | FRIEND_TEST(ModemManagerClassicTest, Connect); |
| 95 | FRIEND_TEST(ModemManagerCoreTest, AddRemoveModem); |
| 96 | FRIEND_TEST(ModemManagerCoreTest, Connect); |
| 97 | FRIEND_TEST(ModemManagerCoreTest, Disconnect); |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 98 | FRIEND_TEST(ModemManagerCoreTest, ModemExists); |
David Rochberg | 7cb06f6 | 2012-03-05 11:23:44 -0500 | [diff] [blame] | 99 | FRIEND_TEST(ModemManagerCoreTest, OnAppearVanish); |
| 100 | FRIEND_TEST(ModemManagerCoreTest, Start); |
| 101 | FRIEND_TEST(ModemManagerCoreTest, Stop); |
Darin Petkov | 887f298 | 2011-07-14 16:10:17 -0700 | [diff] [blame] | 102 | |
Darin Petkov | 887f298 | 2011-07-14 16:10:17 -0700 | [diff] [blame] | 103 | // DBus service watcher callbacks. |
| 104 | static void OnAppear(GDBusConnection *connection, |
| 105 | const gchar *name, |
| 106 | const gchar *name_owner, |
| 107 | gpointer user_data); |
| 108 | static void OnVanish(GDBusConnection *connection, |
| 109 | const gchar *name, |
| 110 | gpointer user_data); |
| 111 | |
Darin Petkov | ab565bb | 2011-10-06 02:55:51 -0700 | [diff] [blame] | 112 | // Store cached copies of singletons for speed/ease of testing. |
| 113 | ProxyFactory *proxy_factory_; |
| 114 | |
Darin Petkov | 887f298 | 2011-07-14 16:10:17 -0700 | [diff] [blame] | 115 | const std::string service_; |
| 116 | const std::string path_; |
| 117 | guint watcher_id_; |
| 118 | |
Darin Petkov | c90fe52 | 2011-07-15 13:59:47 -0700 | [diff] [blame] | 119 | std::string owner_; // DBus service owner. |
Darin Petkov | 887f298 | 2011-07-14 16:10:17 -0700 | [diff] [blame] | 120 | |
Darin Petkov | 5c97ac5 | 2011-07-19 16:30:49 -0700 | [diff] [blame] | 121 | Modems modems_; // Maps a modem |path| to a modem instance. |
| 122 | |
Darin Petkov | 887f298 | 2011-07-14 16:10:17 -0700 | [diff] [blame] | 123 | ControlInterface *control_interface_; |
| 124 | EventDispatcher *dispatcher_; |
Thieu Le | 3426c8f | 2012-01-11 17:35:11 -0800 | [diff] [blame] | 125 | Metrics *metrics_; |
Darin Petkov | 887f298 | 2011-07-14 16:10:17 -0700 | [diff] [blame] | 126 | Manager *manager_; |
| 127 | GLib *glib_; |
Darin Petkov | 137884a | 2011-10-26 18:52:47 +0200 | [diff] [blame] | 128 | mobile_provider_db *provider_db_; |
Darin Petkov | 887f298 | 2011-07-14 16:10:17 -0700 | [diff] [blame] | 129 | |
| 130 | DISALLOW_COPY_AND_ASSIGN(ModemManager); |
| 131 | }; |
| 132 | |
Jason Glasgow | 9c09e36 | 2012-04-18 15:16:29 -0400 | [diff] [blame] | 133 | class ModemManagerClassic : public ModemManager { |
David Rochberg | 81030ea | 2012-03-02 15:44:25 -0500 | [diff] [blame] | 134 | public: |
| 135 | ModemManagerClassic(const std::string &service, |
| 136 | const std::string &path, |
| 137 | ControlInterface *control_interface, |
| 138 | EventDispatcher *dispatcher, |
| 139 | Metrics *metrics, |
| 140 | Manager *manager, |
| 141 | GLib *glib, |
| 142 | mobile_provider_db *provider_db); |
| 143 | |
| 144 | virtual ~ModemManagerClassic(); |
| 145 | |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 146 | // Called by our dbus proxy |
| 147 | void OnDeviceAdded(const std::string &path); |
| 148 | void OnDeviceRemoved(const std::string &path); |
| 149 | |
David Rochberg | 81030ea | 2012-03-02 15:44:25 -0500 | [diff] [blame] | 150 | protected: |
| 151 | virtual void Connect(const std::string &owner); |
| 152 | virtual void Disconnect(); |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 153 | |
| 154 | virtual void AddModemClassic(const std::string &path); |
| 155 | virtual void InitModemClassic(std::tr1::shared_ptr<ModemClassic> modem); |
David Rochberg | 81030ea | 2012-03-02 15:44:25 -0500 | [diff] [blame] | 156 | |
| 157 | private: |
| 158 | scoped_ptr<ModemManagerProxyInterface> proxy_; // DBus service proxy |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 159 | scoped_ptr<DBusPropertiesProxyInterface> dbus_properties_proxy_; |
David Rochberg | 81030ea | 2012-03-02 15:44:25 -0500 | [diff] [blame] | 160 | |
David Rochberg | 7cb06f6 | 2012-03-05 11:23:44 -0500 | [diff] [blame] | 161 | FRIEND_TEST(ModemManagerClassicTest, Connect); |
David Rochberg | 81030ea | 2012-03-02 15:44:25 -0500 | [diff] [blame] | 162 | |
| 163 | DISALLOW_COPY_AND_ASSIGN(ModemManagerClassic); |
| 164 | }; |
David Rochberg | 7cb06f6 | 2012-03-05 11:23:44 -0500 | [diff] [blame] | 165 | |
Eric Shienbrood | 9a24553 | 2012-03-07 14:20:39 -0500 | [diff] [blame] | 166 | class ModemManager1 : public ModemManager { |
David Rochberg | 7cb06f6 | 2012-03-05 11:23:44 -0500 | [diff] [blame] | 167 | public: |
| 168 | ModemManager1(const std::string &service, |
| 169 | const std::string &path, |
| 170 | ControlInterface *control_interface, |
| 171 | EventDispatcher *dispatcher, |
| 172 | Metrics *metrics, |
| 173 | Manager *manager, |
| 174 | GLib *glib, |
| 175 | mobile_provider_db *provider_db); |
| 176 | |
| 177 | virtual ~ModemManager1(); |
| 178 | |
David Rochberg | 7cb06f6 | 2012-03-05 11:23:44 -0500 | [diff] [blame] | 179 | protected: |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 180 | void AddModem1(const std::string &path, |
| 181 | const DBusInterfaceToProperties &i_to_p); |
| 182 | virtual void InitModem1(std::tr1::shared_ptr<Modem1> modem, |
| 183 | const DBusInterfaceToProperties &i_to_p); |
| 184 | |
David Rochberg | 7cb06f6 | 2012-03-05 11:23:44 -0500 | [diff] [blame] | 185 | // ModemManager methods |
| 186 | virtual void Connect(const std::string &owner); |
| 187 | virtual void Disconnect(); |
David Rochberg | 7cb06f6 | 2012-03-05 11:23:44 -0500 | [diff] [blame] | 188 | |
| 189 | // DBusObjectManagerProxyDelegate signal methods |
Eric Shienbrood | 9a24553 | 2012-03-07 14:20:39 -0500 | [diff] [blame] | 190 | virtual void OnInterfacesAddedSignal( |
David Rochberg | 7cb06f6 | 2012-03-05 11:23:44 -0500 | [diff] [blame] | 191 | const ::DBus::Path &object_path, |
| 192 | const DBusInterfaceToProperties &interface_to_properties); |
Eric Shienbrood | 9a24553 | 2012-03-07 14:20:39 -0500 | [diff] [blame] | 193 | virtual void OnInterfacesRemovedSignal( |
David Rochberg | 7cb06f6 | 2012-03-05 11:23:44 -0500 | [diff] [blame] | 194 | const ::DBus::Path &object_path, |
| 195 | const std::vector<std::string> &interfaces); |
| 196 | |
| 197 | // DBusObjectManagerProxyDelegate method callbacks |
Eric Shienbrood | 9a24553 | 2012-03-07 14:20:39 -0500 | [diff] [blame] | 198 | virtual void OnGetManagedObjectsReply( |
David Rochberg | 7cb06f6 | 2012-03-05 11:23:44 -0500 | [diff] [blame] | 199 | const DBusObjectsWithProperties &objects_with_properties, |
Eric Shienbrood | 9a24553 | 2012-03-07 14:20:39 -0500 | [diff] [blame] | 200 | const Error &error); |
David Rochberg | 7cb06f6 | 2012-03-05 11:23:44 -0500 | [diff] [blame] | 201 | |
| 202 | private: |
| 203 | FRIEND_TEST(ModemManager1Test, Connect); |
| 204 | FRIEND_TEST(ModemManager1Test, AddRemoveInterfaces); |
| 205 | |
| 206 | scoped_ptr<DBusObjectManagerProxyInterface> proxy_; |
Eric Shienbrood | 9a24553 | 2012-03-07 14:20:39 -0500 | [diff] [blame] | 207 | base::WeakPtrFactory<ModemManager1> weak_ptr_factory_; |
David Rochberg | 7cb06f6 | 2012-03-05 11:23:44 -0500 | [diff] [blame] | 208 | |
| 209 | DISALLOW_COPY_AND_ASSIGN(ModemManager1); |
| 210 | }; |
Darin Petkov | 887f298 | 2011-07-14 16:10:17 -0700 | [diff] [blame] | 211 | } // namespace shill |
| 212 | |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 213 | #endif // SHILL_MODEM_MANAGER_H_ |