Eric Shienbrood | 5de44ab | 2011-12-05 10:46:27 -0500 | [diff] [blame^] | 1 | // Copyright (c) 2012 The Chromium OS Authors. All rights reserved. |
Darin Petkov | a1e0a1c | 2011-08-25 15:08:33 -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 | |
| 5 | #ifndef SHILL_MODEM_GSM_NETWORK_PROXY_INTERFACE_ |
| 6 | #define SHILL_MODEM_GSM_NETWORK_PROXY_INTERFACE_ |
| 7 | |
Darin Petkov | c086531 | 2011-09-16 15:31:20 -0700 | [diff] [blame] | 8 | #include <map> |
Darin Petkov | a1e0a1c | 2011-08-25 15:08:33 -0700 | [diff] [blame] | 9 | #include <string> |
Darin Petkov | c086531 | 2011-09-16 15:31:20 -0700 | [diff] [blame] | 10 | #include <vector> |
Darin Petkov | a1e0a1c | 2011-08-25 15:08:33 -0700 | [diff] [blame] | 11 | |
| 12 | #include <base/basictypes.h> |
Darin Petkov | 9bac6fe | 2011-08-26 12:49:05 -0700 | [diff] [blame] | 13 | #include <dbus-c++/types.h> |
Darin Petkov | a1e0a1c | 2011-08-25 15:08:33 -0700 | [diff] [blame] | 14 | |
| 15 | namespace shill { |
| 16 | |
Eric Shienbrood | 5de44ab | 2011-12-05 10:46:27 -0500 | [diff] [blame^] | 17 | class AsyncCallHandler; |
| 18 | class Error; |
| 19 | |
| 20 | typedef DBus::Struct<unsigned int, std::string, std::string> |
| 21 | GSMRegistrationInfo; |
| 22 | typedef std::map<std::string, std::string> GSMScanResult; |
| 23 | typedef std::vector<GSMScanResult> GSMScanResults; |
| 24 | |
Darin Petkov | a1e0a1c | 2011-08-25 15:08:33 -0700 | [diff] [blame] | 25 | // These are the methods that a ModemManager.Modem.Gsm.Network proxy must |
| 26 | // support. The interface is provided so that it can be mocked in tests. |
Eric Shienbrood | 5de44ab | 2011-12-05 10:46:27 -0500 | [diff] [blame^] | 27 | // All calls are made asynchronously. Call completion is signalled through |
| 28 | // the corresponding 'OnXXXCallback' method in the ProxyDelegate interface. |
Darin Petkov | a1e0a1c | 2011-08-25 15:08:33 -0700 | [diff] [blame] | 29 | class ModemGSMNetworkProxyInterface { |
| 30 | public: |
| 31 | virtual ~ModemGSMNetworkProxyInterface() {} |
| 32 | |
Eric Shienbrood | 5de44ab | 2011-12-05 10:46:27 -0500 | [diff] [blame^] | 33 | virtual void GetRegistrationInfo(AsyncCallHandler *call_handler, |
| 34 | int timeout) = 0; |
Darin Petkov | 22b72bf | 2011-08-29 14:01:20 -0700 | [diff] [blame] | 35 | virtual uint32 GetSignalQuality() = 0; |
Eric Shienbrood | 5de44ab | 2011-12-05 10:46:27 -0500 | [diff] [blame^] | 36 | virtual void Register(const std::string &network_id, |
| 37 | AsyncCallHandler *call_handler, int timeout) = 0; |
| 38 | virtual void Scan(AsyncCallHandler *call_handler, int timeout) = 0; |
Darin Petkov | 9bac6fe | 2011-08-26 12:49:05 -0700 | [diff] [blame] | 39 | |
| 40 | // Properties. |
| 41 | virtual uint32 AccessTechnology() = 0; |
Darin Petkov | a1e0a1c | 2011-08-25 15:08:33 -0700 | [diff] [blame] | 42 | }; |
| 43 | |
Eric Shienbrood | 5de44ab | 2011-12-05 10:46:27 -0500 | [diff] [blame^] | 44 | // ModemManager.Modem.Gsm.Network method reply callback and signal |
| 45 | // delegate to be associated with the proxy. |
Darin Petkov | 580c7af | 2011-10-24 12:32:50 +0200 | [diff] [blame] | 46 | class ModemGSMNetworkProxyDelegate { |
Darin Petkov | a1e0a1c | 2011-08-25 15:08:33 -0700 | [diff] [blame] | 47 | public: |
Darin Petkov | 580c7af | 2011-10-24 12:32:50 +0200 | [diff] [blame] | 48 | virtual ~ModemGSMNetworkProxyDelegate() {} |
Darin Petkov | a1e0a1c | 2011-08-25 15:08:33 -0700 | [diff] [blame] | 49 | |
| 50 | virtual void OnGSMNetworkModeChanged(uint32 mode) = 0; |
Eric Shienbrood | 5de44ab | 2011-12-05 10:46:27 -0500 | [diff] [blame^] | 51 | // The following callback handler is used for both the |
| 52 | // RegistrationInfo signal and the GetRegistrationInfo |
| 53 | // method reply. For the signal case, the |call_handler| |
| 54 | // is NULL. |
Darin Petkov | a1e0a1c | 2011-08-25 15:08:33 -0700 | [diff] [blame] | 55 | virtual void OnGSMRegistrationInfoChanged( |
| 56 | uint32 status, |
| 57 | const std::string &operator_code, |
Eric Shienbrood | 5de44ab | 2011-12-05 10:46:27 -0500 | [diff] [blame^] | 58 | const std::string &operator_name, |
| 59 | const Error &error, |
| 60 | AsyncCallHandler *call_handler) = 0; |
Darin Petkov | a1e0a1c | 2011-08-25 15:08:33 -0700 | [diff] [blame] | 61 | virtual void OnGSMSignalQualityChanged(uint32 quality) = 0; |
Eric Shienbrood | 5de44ab | 2011-12-05 10:46:27 -0500 | [diff] [blame^] | 62 | virtual void OnScanCallback(const GSMScanResults &results, |
| 63 | const Error &error, |
| 64 | AsyncCallHandler *call_handler) = 0; |
| 65 | virtual void OnRegisterCallback(const Error &error, |
| 66 | AsyncCallHandler *call_handler) = 0; |
Darin Petkov | a1e0a1c | 2011-08-25 15:08:33 -0700 | [diff] [blame] | 67 | }; |
| 68 | |
| 69 | } // namespace shill |
| 70 | |
| 71 | #endif // SHILL_MODEM_GSM_NETWORK_PROXY_INTERFACE_ |