1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. 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 CHROMEOS_NETWORK_NETWORK_UTIL_H_ 6 #define CHROMEOS_NETWORK_NETWORK_UTIL_H_ 7 8 // This header is introduced to make it easy to switch from chromeos_network.cc 9 // to Chrome's own DBus code. crosbug.com/16557 10 // All calls to functions in chromeos_network.h should be made through 11 // functions provided by this header. 12 13 #include <string> 14 #include <vector> 15 16 #include "base/basictypes.h" 17 #include "base/callback.h" 18 #include "base/time/time.h" 19 #include "base/values.h" 20 #include "chromeos/chromeos_export.h" 21 22 namespace chromeos { 23 24 // Struct to represent a SMS. 25 struct CHROMEOS_EXPORT SMS { 26 SMS(); 27 ~SMS(); 28 base::Time timestamp; 29 std::string number; 30 std::string text; 31 std::string smsc; // optional; empty if not present in message. 32 int32 validity; // optional; -1 if not present in message. 33 int32 msgclass; // optional; -1 if not present in message. 34 }; 35 36 // Struct for passing wifi access point data. 37 struct CHROMEOS_EXPORT WifiAccessPoint { 38 WifiAccessPoint(); 39 ~WifiAccessPoint(); 40 std::string ssid; // The ssid of the WiFi node if available. 41 std::string mac_address; // The mac address of the WiFi node. 42 base::Time timestamp; // Timestamp when this AP was detected. 43 int signal_strength; // Radio signal strength measured in dBm. 44 int signal_to_noise; // Current signal to noise ratio measured in dB. 45 int channel; // Wifi channel number. 46 }; 47 48 // Struct for passing network scan result data. 49 struct CHROMEOS_EXPORT CellularScanResult { 50 CellularScanResult(); 51 ~CellularScanResult(); 52 std::string status; // The network's availability status. (One of "unknown", 53 // "available", "current", or "forbidden") 54 std::string network_id; // 3GPP operator code ("MCCMNC"). 55 std::string short_name; // Short-format name of the operator. 56 std::string long_name; // Long-format name of the operator. 57 std::string technology; // Access technology. 58 }; 59 60 typedef std::vector<WifiAccessPoint> WifiAccessPointVector; 61 62 // Describes whether there is an error and whether the error came from 63 // the local system or from the server implementing the connect 64 // method. 65 enum NetworkMethodErrorType { 66 NETWORK_METHOD_ERROR_NONE = 0, 67 NETWORK_METHOD_ERROR_LOCAL = 1, 68 NETWORK_METHOD_ERROR_REMOTE = 2, 69 }; 70 71 // Callback for methods that initiate an operation and return no data. 72 typedef base::Callback<void( 73 const std::string& path, 74 NetworkMethodErrorType error, 75 const std::string& error_message)> NetworkOperationCallback; 76 77 namespace network_util { 78 79 // Converts a |prefix_length| to a netmask. (for IPv4 only) 80 // e.g. a |prefix_length| of 24 is converted to a netmask of "255.255.255.0". 81 // Invalid prefix lengths will return the empty string. 82 CHROMEOS_EXPORT std::string PrefixLengthToNetmask(int32 prefix_length); 83 84 // Converts a |netmask| to a prefixlen. (for IPv4 only) 85 // e.g. a |netmask| of 255.255.255.0 is converted to a prefixlen of 24 86 CHROMEOS_EXPORT int32 NetmaskToPrefixLength(const std::string& netmask); 87 88 // Parses |list|, which contains DictionaryValues and returns a vector of 89 // CellularScanResult in |scan_results|. Returns false if parsing fails, 90 // in which case the contents of |scan_results| will be undefined. 91 CHROMEOS_EXPORT bool ParseCellularScanResults( 92 const ListValue& list, std::vector<CellularScanResult>* scan_results); 93 94 } // namespace network_util 95 } // namespace chromeos 96 97 #endif // CHROMEOS_NETWORK_NETWORK_UTIL_H_ 98
