1/* //device/java/android/android/os/INetworkManagementService.aidl
2**
3** Copyright 2007, The Android Open Source Project
4**
5** Licensed under the Apache License, Version 2.0 (the "License");
6** you may not use this file except in compliance with the License.
7** You may obtain a copy of the License at
8**
9**     http://www.apache.org/licenses/LICENSE-2.0
10**
11** Unless required by applicable law or agreed to in writing, software
12** distributed under the License is distributed on an "AS IS" BASIS,
13** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14** See the License for the specific language governing permissions and
15** limitations under the License.
16*/
17
18package android.os;
19
20import android.net.InterfaceConfiguration;
21import android.net.INetworkManagementEventObserver;
22import android.net.NetworkStats;
23import android.net.RouteInfo;
24import android.net.wifi.WifiConfiguration;
25
26/**
27 * @hide
28 */
29interface INetworkManagementService
30{
31    /**
32     ** GENERAL
33     **/
34
35    /**
36     * Register an observer to receive events
37     */
38    void registerObserver(INetworkManagementEventObserver obs);
39
40    /**
41     * Unregister an observer from receiving events.
42     */
43    void unregisterObserver(INetworkManagementEventObserver obs);
44
45    /**
46     * Returns a list of currently known network interfaces
47     */
48    String[] listInterfaces();
49
50    /**
51     * Retrieves the specified interface config
52     *
53     */
54    InterfaceConfiguration getInterfaceConfig(String iface);
55
56    /**
57     * Sets the configuration of the specified interface
58     */
59    void setInterfaceConfig(String iface, in InterfaceConfiguration cfg);
60
61    /**
62     * Clear all IP addresses on the specified interface
63     */
64    void clearInterfaceAddresses(String iface);
65
66    /**
67     * Set interface down
68     */
69    void setInterfaceDown(String iface);
70
71    /**
72     * Set interface up
73     */
74    void setInterfaceUp(String iface);
75
76    /**
77     * Set interface IPv6 privacy extensions
78     */
79    void setInterfaceIpv6PrivacyExtensions(String iface, boolean enable);
80
81    /**
82     * Disable IPv6 on an interface
83     */
84    void disableIpv6(String iface);
85
86    /**
87     * Enable IPv6 on an interface
88     */
89    void enableIpv6(String iface);
90
91    /**
92     * Retrieves the network routes currently configured on the specified
93     * interface
94     */
95    RouteInfo[] getRoutes(String iface);
96
97    /**
98     * Add the specified route to the interface.
99     */
100    void addRoute(String iface, in RouteInfo route);
101
102    /**
103     * Remove the specified route from the interface.
104     */
105    void removeRoute(String iface, in RouteInfo route);
106
107    /**
108     * Add the specified route to a secondary interface
109     * This will go into a special route table to be accessed
110     * via ip rules
111     */
112    void addSecondaryRoute(String iface, in RouteInfo route);
113
114    /**
115     * Remove the specified secondary route.
116     */
117    void removeSecondaryRoute(String iface, in RouteInfo route);
118
119    /**
120     * Shuts down the service
121     */
122    void shutdown();
123
124    /**
125     ** TETHERING RELATED
126     **/
127
128    /**
129     * Returns true if IP forwarding is enabled
130     */
131    boolean getIpForwardingEnabled();
132
133    /**
134     * Enables/Disables IP Forwarding
135     */
136    void setIpForwardingEnabled(boolean enabled);
137
138    /**
139     * Start tethering services with the specified dhcp server range
140     * arg is a set of start end pairs defining the ranges.
141     */
142    void startTethering(in String[] dhcpRanges);
143
144    /**
145     * Stop currently running tethering services
146     */
147    void stopTethering();
148
149    /**
150     * Returns true if tethering services are started
151     */
152    boolean isTetheringStarted();
153
154    /**
155     * Tethers the specified interface
156     */
157    void tetherInterface(String iface);
158
159    /**
160     * Untethers the specified interface
161     */
162    void untetherInterface(String iface);
163
164    /**
165     * Returns a list of currently tethered interfaces
166     */
167    String[] listTetheredInterfaces();
168
169    /**
170     * Sets the list of DNS forwarders (in order of priority)
171     */
172    void setDnsForwarders(in String[] dns);
173
174    /**
175     * Returns the list of DNS fowarders (in order of priority)
176     */
177    String[] getDnsForwarders();
178
179    /**
180     *  Enables Network Address Translation between two interfaces.
181     *  The address and netmask of the external interface is used for
182     *  the NAT'ed network.
183     */
184    void enableNat(String internalInterface, String externalInterface);
185
186    /**
187     *  Disables Network Address Translation between two interfaces.
188     */
189    void disableNat(String internalInterface, String externalInterface);
190
191    /**
192     ** PPPD
193     **/
194
195    /**
196     * Returns the list of currently known TTY devices on the system
197     */
198    String[] listTtys();
199
200    /**
201     * Attaches a PPP server daemon to the specified TTY with the specified
202     * local/remote addresses.
203     */
204    void attachPppd(String tty, String localAddr, String remoteAddr, String dns1Addr,
205            String dns2Addr);
206
207    /**
208     * Detaches a PPP server daemon from the specified TTY.
209     */
210    void detachPppd(String tty);
211
212    /**
213     * Load firmware for operation in the given mode. Currently the three
214     * modes supported are "AP", "STA" and "P2P".
215     */
216    void wifiFirmwareReload(String wlanIface, String mode);
217
218    /**
219     * Start Wifi Access Point
220     */
221    void startAccessPoint(in WifiConfiguration wifiConfig, String wlanIface, String softapIface);
222
223    /**
224     * Stop Wifi Access Point
225     */
226    void stopAccessPoint(String wlanIface);
227
228    /**
229     * Set Access Point config
230     */
231    void setAccessPoint(in WifiConfiguration wifiConfig, String wlanIface, String softapIface);
232
233    /**
234     ** DATA USAGE RELATED
235     **/
236
237    /**
238     * Return global network statistics summarized at an interface level,
239     * without any UID-level granularity.
240     */
241    NetworkStats getNetworkStatsSummary();
242
243    /**
244     * Return detailed network statistics with UID-level granularity,
245     * including interface and tag details.
246     */
247    NetworkStats getNetworkStatsDetail();
248
249    /**
250     * Return detailed network statistics for the requested UID,
251     * including interface and tag details.
252     */
253    NetworkStats getNetworkStatsUidDetail(int uid);
254
255    /**
256     * Return summary of network statistics for the requested pairs of
257     * tethering interfaces.  Even indexes are remote interface, and odd
258     * indexes are corresponding local interfaces.
259     */
260    NetworkStats getNetworkStatsTethering(in String[] ifacePairs);
261
262    /**
263     * Set quota for an interface.
264     */
265    void setInterfaceQuota(String iface, long quotaBytes);
266
267    /**
268     * Remove quota for an interface.
269     */
270    void removeInterfaceQuota(String iface);
271
272    /**
273     * Set alert for an interface; requires that iface already has quota.
274     */
275    void setInterfaceAlert(String iface, long alertBytes);
276
277    /**
278     * Remove alert for an interface.
279     */
280    void removeInterfaceAlert(String iface);
281
282    /**
283     * Set alert across all interfaces.
284     */
285    void setGlobalAlert(long alertBytes);
286
287    /**
288     * Control network activity of a UID over interfaces with a quota limit.
289     */
290    void setUidNetworkRules(int uid, boolean rejectOnQuotaInterfaces);
291
292    /**
293     * Return status of bandwidth control module.
294     */
295    boolean isBandwidthControlEnabled();
296
297    /**
298     * Configures bandwidth throttling on an interface.
299     */
300    void setInterfaceThrottle(String iface, int rxKbps, int txKbps);
301
302    /**
303     * Returns the currently configured RX throttle values
304     * for the specified interface
305     */
306    int getInterfaceRxThrottle(String iface);
307
308    /**
309     * Returns the currently configured TX throttle values
310     * for the specified interface
311     */
312    int getInterfaceTxThrottle(String iface);
313
314    /**
315     * Sets the name of the default interface in the DNS resolver.
316     */
317    void setDefaultInterfaceForDns(String iface);
318
319    /**
320     * Bind name servers to an interface in the DNS resolver.
321     */
322    void setDnsServersForInterface(String iface, in String[] servers);
323
324    /**
325     * Flush the DNS cache associated with the default interface.
326     */
327    void flushDefaultDnsCache();
328
329    /**
330     * Flush the DNS cache associated with the specified interface.
331     */
332    void flushInterfaceDnsCache(String iface);
333}
334