blob: 1ca925579fbb8848fb0e2e91cafdffb741c49802 [file] [log] [blame]
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001/*
2 * Copyright (C) 2008 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package android.net;
18
Wink Savillec7a98342010-08-13 16:11:42 -070019import android.content.Context;
20import android.os.Handler;
Robert Greenwalt665e1ae2012-08-21 19:27:00 -070021import android.os.Messenger;
22
23import static com.android.internal.util.Protocol.BASE_NETWORK_STATE_TRACKER;
Wink Savillec7a98342010-08-13 16:11:42 -070024
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080025/**
Wink Savillec7a98342010-08-13 16:11:42 -070026 * Interface provides the {@link com.android.server.ConnectivityService}
27 * with three services. Events to the ConnectivityService when
28 * changes occur, an API for controlling the network and storage
29 * for network specific information.
30 *
31 * The Connectivity will call startMonitoring before any other
32 * method is called.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080033 *
34 * {@hide}
35 */
Irfan Sheriffd649c122010-06-09 15:39:36 -070036public interface NetworkStateTracker {
Robert Greenwalt42acef32009-08-12 16:08:25 -070037
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080038 /**
Wink Savillec7a98342010-08-13 16:11:42 -070039 * -------------------------------------------------------------
40 * Event Interface back to ConnectivityService.
41 *
42 * The events that are to be sent back to the Handler passed
43 * to startMonitoring when the particular event occurs.
44 * -------------------------------------------------------------
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080045 */
Wink Savillec7a98342010-08-13 16:11:42 -070046
47 /**
48 * The network state has changed and the NetworkInfo object
49 * contains the new state.
50 *
51 * msg.what = EVENT_STATE_CHANGED
52 * msg.obj = NetworkInfo object
53 */
Robert Greenwalt665e1ae2012-08-21 19:27:00 -070054 public static final int EVENT_STATE_CHANGED = BASE_NETWORK_STATE_TRACKER;
Wink Savillec7a98342010-08-13 16:11:42 -070055
56 /**
57 * msg.what = EVENT_CONFIGURATION_CHANGED
58 * msg.obj = NetworkInfo object
59 */
Robert Greenwalt665e1ae2012-08-21 19:27:00 -070060 public static final int EVENT_CONFIGURATION_CHANGED = BASE_NETWORK_STATE_TRACKER + 1;
Wink Savillec7a98342010-08-13 16:11:42 -070061
62 /**
63 * msg.what = EVENT_RESTORE_DEFAULT_NETWORK
64 * msg.obj = FeatureUser object
65 */
Robert Greenwalt665e1ae2012-08-21 19:27:00 -070066 public static final int EVENT_RESTORE_DEFAULT_NETWORK = BASE_NETWORK_STATE_TRACKER + 2;
Wink Savillec7a98342010-08-13 16:11:42 -070067
68 /**
Robert Greenwaltd14e1762012-08-20 11:15:39 -070069 * msg.what = EVENT_NETWORK_SUBTYPE_CHANGED
70 * msg.obj = NetworkInfo object
71 */
Robert Greenwalt665e1ae2012-08-21 19:27:00 -070072 public static final int EVENT_NETWORK_SUBTYPE_CHANGED = BASE_NETWORK_STATE_TRACKER + 3;
73
74 /**
75 * msg.what = EVENT_NETWORK_CONNECTED
76 * msg.obj = LinkProperties object
77 */
78 public static final int EVENT_NETWORK_CONNECTED = BASE_NETWORK_STATE_TRACKER + 4;
79
80 /**
81 * msg.what = EVENT_NETWORK_CONNECTION_DISCONNECTED
82 * msg.obj = LinkProperties object, same iface name
83 */
84 public static final int EVENT_NETWORK_DISCONNECTED = BASE_NETWORK_STATE_TRACKER + 5;
85
Robert Greenwaltd14e1762012-08-20 11:15:39 -070086 /**
Wink Savillec7a98342010-08-13 16:11:42 -070087 * -------------------------------------------------------------
88 * Control Interface
89 * -------------------------------------------------------------
90 */
91 /**
92 * Begin monitoring data connectivity.
93 *
94 * This is the first method called when this interface is used.
95 *
96 * @param context is the current Android context
97 * @param target is the Hander to which to return the events.
98 */
99 public void startMonitoring(Context context, Handler target);
100
101 /**
Irfan Sheriffd649c122010-06-09 15:39:36 -0700102 * Fetch NetworkInfo for the network
103 */
104 public NetworkInfo getNetworkInfo();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800105
106 /**
Wink Savillef61101f2010-09-16 16:36:42 -0700107 * Return the LinkProperties for the connection.
108 *
109 * @return a copy of the LinkProperties, is never null.
Robert Greenwalt47f69fe2010-06-15 15:43:39 -0700110 */
Robert Greenwalt37e65eb2010-08-30 10:56:47 -0700111 public LinkProperties getLinkProperties();
Robert Greenwalt47f69fe2010-06-15 15:43:39 -0700112
113 /**
Wink Savillef61101f2010-09-16 16:36:42 -0700114 * A capability is an Integer/String pair, the capabilities
115 * are defined in the class LinkSocket#Key.
116 *
117 * @return a copy of this connections capabilities, may be empty but never null.
118 */
119 public LinkCapabilities getLinkCapabilities();
120
121 /**
Vinit Deshapnde1f12cb52013-08-21 13:09:01 -0700122 * Get interesting information about this network link
123 * @return a copy of link information, null if not available
124 */
Vinit Deshapnde6a2d3252013-09-04 14:11:24 -0700125 public LinkQualityInfo getLinkQualityInfo();
Vinit Deshapnde1f12cb52013-08-21 13:09:01 -0700126
127 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800128 * Return the system properties name associated with the tcp buffer sizes
129 * for this network.
130 */
Irfan Sheriffd649c122010-06-09 15:39:36 -0700131 public String getTcpBufferSizesPropName();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800132
133 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800134 * Disable connectivity to a network
135 * @return {@code true} if a teardown occurred, {@code false} if the
136 * teardown did not occur.
137 */
Irfan Sheriffd649c122010-06-09 15:39:36 -0700138 public boolean teardown();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800139
140 /**
141 * Reenable connectivity to a network after a {@link #teardown()}.
Robert Greenwalt02648a42010-05-18 10:52:51 -0700142 * @return {@code true} if we're connected or expect to be connected
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800143 */
Irfan Sheriffd649c122010-06-09 15:39:36 -0700144 public boolean reconnect();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800145
146 /**
Irfan Sheriffda6da092012-08-16 12:49:23 -0700147 * Ready to switch on to the network after captive portal check
148 */
149 public void captivePortalCheckComplete();
150
151 /**
Wink Savilled747cbc2013-08-07 16:22:47 -0700152 * Captive portal check has completed
153 */
154 public void captivePortalCheckCompleted(boolean isCaptive);
155
156 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800157 * Turn the wireless radio off for a network.
158 * @param turnOn {@code true} to turn the radio on, {@code false}
159 */
Irfan Sheriffd649c122010-06-09 15:39:36 -0700160 public boolean setRadio(boolean turnOn);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800161
162 /**
163 * Returns an indication of whether this network is available for
164 * connections. A value of {@code false} means that some quasi-permanent
165 * condition prevents connectivity to this network.
Robert Greenwalt12e24ae2011-10-17 22:10:03 -0700166 *
167 * NOTE that this is broken on multi-connection devices. Should be fixed in J release
168 * TODO - fix on multi-pdp devices
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800169 */
Irfan Sheriffd649c122010-06-09 15:39:36 -0700170 public boolean isAvailable();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800171
172 /**
Jeff Sharkey8e28b7d2011-08-19 02:24:24 -0700173 * User control of data connection through this network, typically persisted
174 * internally.
Wink Savillee7982682010-12-07 10:31:02 -0800175 */
Jeff Sharkey8e28b7d2011-08-19 02:24:24 -0700176 public void setUserDataEnable(boolean enabled);
177
178 /**
179 * Policy control of data connection through this network, typically not
180 * persisted internally. Usually used when {@link NetworkPolicy#limitBytes}
181 * is passed.
182 */
183 public void setPolicyDataEnable(boolean enabled);
Wink Savillee7982682010-12-07 10:31:02 -0800184
185 /**
Wink Savillec7a98342010-08-13 16:11:42 -0700186 * -------------------------------------------------------------
187 * Storage API used by ConnectivityService for saving
188 * Network specific information.
189 * -------------------------------------------------------------
190 */
191
192 /**
193 * Check if private DNS route is set for the network
194 */
195 public boolean isPrivateDnsRouteSet();
196
197 /**
198 * Set a flag indicating private DNS route is set
199 */
200 public void privateDnsRouteSet(boolean enabled);
201
202 /**
203 * Check if default route is set
204 */
205 public boolean isDefaultRouteSet();
206
207 /**
208 * Set a flag indicating default route is set for the network
209 */
210 public void defaultRouteSet(boolean enabled);
211
212 /**
213 * Check if tear down was requested
214 */
215 public boolean isTeardownRequested();
216
217 /**
218 * Indicate tear down requested from connectivity
219 */
220 public void setTeardownRequested(boolean isRequested);
Robert Greenwaltd55a6b42011-03-25 13:09:25 -0700221
222 /**
223 * An external dependency has been met/unmet
224 */
225 public void setDependencyMet(boolean met);
Lorenzo Colitti69edd642013-03-07 11:01:12 -0800226
227 /**
228 * Informs the state tracker that another interface is stacked on top of it.
229 **/
230 public void addStackedLink(LinkProperties link);
231
232 /**
233 * Informs the state tracker that a stacked interface has been removed.
234 **/
235 public void removeStackedLink(LinkProperties link);
Robert Greenwalt665e1ae2012-08-21 19:27:00 -0700236
237 /*
238 * Called once to setup async channel between this and
239 * the underlying network specific code.
240 */
241 public void supplyMessenger(Messenger messenger);
Vinit Deshapnde1f12cb52013-08-21 13:09:01 -0700242
243 /*
244 * Network interface name that we'll lookup for sampling data
245 */
246 public String getNetworkInterfaceName();
247
248 /*
249 * Save the starting sample
250 */
251 public void startSampling(SamplingDataTracker.SamplingSnapshot s);
252
253 /*
254 * Save the ending sample
255 */
256 public void stopSampling(SamplingDataTracker.SamplingSnapshot s);
257
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800258}