network_util.h revision eb525c5499e34cc9c4b825d6d9e75bb07cc06ace 
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 "chromeos/chromeos_export.h"
20
21namespace chromeos {
22
23// Struct to represent a SMS.
24struct CHROMEOS_EXPORT SMS {
25  SMS();
26  ~SMS();
27  base::Time timestamp;
28  std::string number;
29  std::string text;
30  std::string smsc;  // optional; empty if not present in message.
31  int32 validity;  // optional; -1 if not present in message.
32  int32 msgclass;  // optional; -1 if not present in message.
33};
34
35// Struct for passing wifi access point data.
36struct CHROMEOS_EXPORT WifiAccessPoint {
37  WifiAccessPoint();
38  ~WifiAccessPoint();
39  std::string ssid;  // The ssid of the WiFi node if available.
40  std::string mac_address;  // The mac address of the WiFi node.
41  base::Time timestamp;  // Timestamp when this AP was detected.
42  int signal_strength;  // Radio signal strength measured in dBm.
43  int signal_to_noise;  // Current signal to noise ratio measured in dB.
44  int channel;  // Wifi channel number.
45};
46
47typedef std::vector<WifiAccessPoint> WifiAccessPointVector;
48
49// Describes whether there is an error and whether the error came from
50// the local system or from the server implementing the connect
51// method.
52enum NetworkMethodErrorType {
53  NETWORK_METHOD_ERROR_NONE = 0,
54  NETWORK_METHOD_ERROR_LOCAL = 1,
55  NETWORK_METHOD_ERROR_REMOTE = 2,
56};
57
58// Callback for methods that initiate an operation and return no data.
59typedef base::Callback<void(
60    const std::string& path,
61    NetworkMethodErrorType error,
62    const std::string& error_message)> NetworkOperationCallback;
63
64namespace network_util {
65
66// Converts a |prefix_length| to a netmask. (for IPv4 only)
67// e.g. a |prefix_length| of 24 is converted to a netmask of "255.255.255.0".
68// Invalid prefix lengths will return the empty string.
69CHROMEOS_EXPORT std::string PrefixLengthToNetmask(int32 prefix_length);
70
71// Converts a |netmask| to a prefixlen. (for IPv4 only)
72// e.g. a |netmask| of 255.255.255.0 is converted to a prefixlen of 24
73CHROMEOS_EXPORT int32 NetmaskToPrefixLength(const std::string& netmask);
74
75}  // namespace network_util
76}  // namespace chromeos
77
78#endif  // CHROMEOS_NETWORK_NETWORK_UTIL_H_
79