NetworkAgentInfo.java revision e73cc4646bed3926024c9f54ca59e3a82a97b56c
17b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwalt/* 27b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwalt * Copyright (C) 2014 The Android Open Source Project 37b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwalt * 47b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwalt * Licensed under the Apache License, Version 2.0 (the "License"); 57b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwalt * you may not use this file except in compliance with the License. 67b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwalt * You may obtain a copy of the License at 77b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwalt * 87b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwalt * http://www.apache.org/licenses/LICENSE-2.0 97b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwalt * 107b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwalt * Unless required by applicable law or agreed to in writing, software 117b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwalt * distributed under the License is distributed on an "AS IS" BASIS, 127b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwalt * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 137b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwalt * See the License for the specific language governing permissions and 147b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwalt * limitations under the License. 157b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwalt */ 167b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwalt 177b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwaltpackage com.android.server.connectivity; 187b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwalt 19ca8f16ad14819ba17f5ff3d2e2bf6fbc9bbaa9f7Paul Jensenimport android.content.Context; 207b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwaltimport android.net.LinkProperties; 217b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwaltimport android.net.Network; 227b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwaltimport android.net.NetworkCapabilities; 237b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwaltimport android.net.NetworkInfo; 248cd33ed84e94036a5e1201485af7603dc6fb0d9bSreeram Ramachandranimport android.net.NetworkMisc; 257b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwaltimport android.net.NetworkRequest; 26ca8f16ad14819ba17f5ff3d2e2bf6fbc9bbaa9f7Paul Jensenimport android.os.Handler; 277b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwaltimport android.os.Messenger; 287b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwaltimport android.util.SparseArray; 297b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwalt 307b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwaltimport com.android.internal.util.AsyncChannel; 31ca8f16ad14819ba17f5ff3d2e2bf6fbc9bbaa9f7Paul Jensenimport com.android.server.connectivity.NetworkMonitor; 327b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwalt 337b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwaltimport java.util.ArrayList; 347b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwalt 357b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwalt/** 367b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwalt * A bag class used by ConnectivityService for holding a collection of most recent 377b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwalt * information published by a particular NetworkAgent as well as the 387b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwalt * AsyncChannel/messenger for reaching that NetworkAgent and lists of NetworkRequests 397b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwalt * interested in using it. 407b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwalt */ 417b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwaltpublic class NetworkAgentInfo { 427b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwalt public NetworkInfo networkInfo; 4360061a6ebf4ef758c4a47d210de0e5be2484be5bPaul Jensen public Network network; 447b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwalt public LinkProperties linkProperties; 457b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwalt public NetworkCapabilities networkCapabilities; 46ca8f16ad14819ba17f5ff3d2e2bf6fbc9bbaa9f7Paul Jensen public final NetworkMonitor networkMonitor; 478cd33ed84e94036a5e1201485af7603dc6fb0d9bSreeram Ramachandran public final NetworkMisc networkMisc; 48eec75412a971a5ccb769364120c769c331946eb3Paul Jensen public boolean created; 497ccd3dfd53d8d45c447398ff137f052865dfd3b3Paul Jensen public boolean validated; 50ca8f16ad14819ba17f5ff3d2e2bf6fbc9bbaa9f7Paul Jensen 512161a8ea123134ee3f9a10c0f8f56aabd8289f69Paul Jensen // This represents the last score received from the NetworkAgent. 522161a8ea123134ee3f9a10c0f8f56aabd8289f69Paul Jensen private int currentScore; 532161a8ea123134ee3f9a10c0f8f56aabd8289f69Paul Jensen // Penalty applied to scores of Networks that have not been validated. 542161a8ea123134ee3f9a10c0f8f56aabd8289f69Paul Jensen private static final int UNVALIDATED_SCORE_PENALTY = 40; 552161a8ea123134ee3f9a10c0f8f56aabd8289f69Paul Jensen 56e73cc4646bed3926024c9f54ca59e3a82a97b56cRobert Greenwalt // Score for explicitly connected network. 57e73cc4646bed3926024c9f54ca59e3a82a97b56cRobert Greenwalt private static final int EXPLICITLY_SELECTED_NETWORK_SCORE = 100; 58e73cc4646bed3926024c9f54ca59e3a82a97b56cRobert Greenwalt 597b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwalt // The list of NetworkRequests being satisfied by this Network. 607b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwalt public final SparseArray<NetworkRequest> networkRequests = new SparseArray<NetworkRequest>(); 619258c64bef1a01fe89bc7c1fa402c44c0e6a1255Robert Greenwalt public final ArrayList<NetworkRequest> networkLingered = new ArrayList<NetworkRequest>(); 627b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwalt 637b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwalt public final Messenger messenger; 647b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwalt public final AsyncChannel asyncChannel; 657b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwalt 6660061a6ebf4ef758c4a47d210de0e5be2484be5bPaul Jensen public NetworkAgentInfo(Messenger messenger, AsyncChannel ac, NetworkInfo info, 678cd33ed84e94036a5e1201485af7603dc6fb0d9bSreeram Ramachandran LinkProperties lp, NetworkCapabilities nc, int score, Context context, Handler handler, 688cd33ed84e94036a5e1201485af7603dc6fb0d9bSreeram Ramachandran NetworkMisc misc) { 697b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwalt this.messenger = messenger; 707b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwalt asyncChannel = ac; 7160061a6ebf4ef758c4a47d210de0e5be2484be5bPaul Jensen network = null; 727b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwalt networkInfo = info; 737b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwalt linkProperties = lp; 747b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwalt networkCapabilities = nc; 757b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwalt currentScore = score; 76ca8f16ad14819ba17f5ff3d2e2bf6fbc9bbaa9f7Paul Jensen networkMonitor = new NetworkMonitor(context, handler, this); 778cd33ed84e94036a5e1201485af7603dc6fb0d9bSreeram Ramachandran networkMisc = misc; 78eec75412a971a5ccb769364120c769c331946eb3Paul Jensen created = false; 797ccd3dfd53d8d45c447398ff137f052865dfd3b3Paul Jensen validated = false; 807b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwalt } 817b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwalt 8271bf33a02f49444fbfa35b267c70592f3b07a07dRobert Greenwalt public void addRequest(NetworkRequest networkRequest) { 8371bf33a02f49444fbfa35b267c70592f3b07a07dRobert Greenwalt networkRequests.put(networkRequest.requestId, networkRequest); 8471bf33a02f49444fbfa35b267c70592f3b07a07dRobert Greenwalt } 8571bf33a02f49444fbfa35b267c70592f3b07a07dRobert Greenwalt 866bc2c2c34f2b23eae79ad733c97a691734055c4fPaul Jensen public boolean isVPN() { 876bc2c2c34f2b23eae79ad733c97a691734055c4fPaul Jensen return networkCapabilities.hasTransport(NetworkCapabilities.TRANSPORT_VPN); 886bc2c2c34f2b23eae79ad733c97a691734055c4fPaul Jensen } 896bc2c2c34f2b23eae79ad733c97a691734055c4fPaul Jensen 902161a8ea123134ee3f9a10c0f8f56aabd8289f69Paul Jensen // Get the current score for this Network. This may be modified from what the 912161a8ea123134ee3f9a10c0f8f56aabd8289f69Paul Jensen // NetworkAgent sent, as it has modifiers applied to it. 922161a8ea123134ee3f9a10c0f8f56aabd8289f69Paul Jensen public int getCurrentScore() { 932161a8ea123134ee3f9a10c0f8f56aabd8289f69Paul Jensen // TODO: We may want to refactor this into a NetworkScore class that takes a base score from 942161a8ea123134ee3f9a10c0f8f56aabd8289f69Paul Jensen // the NetworkAgent and signals from the NetworkAgent and uses those signals to modify the 952161a8ea123134ee3f9a10c0f8f56aabd8289f69Paul Jensen // score. The NetworkScore class would provide a nice place to centralize score constants 962161a8ea123134ee3f9a10c0f8f56aabd8289f69Paul Jensen // so they are not scattered about the transports. 972161a8ea123134ee3f9a10c0f8f56aabd8289f69Paul Jensen 982161a8ea123134ee3f9a10c0f8f56aabd8289f69Paul Jensen int score = currentScore; 992161a8ea123134ee3f9a10c0f8f56aabd8289f69Paul Jensen 1002161a8ea123134ee3f9a10c0f8f56aabd8289f69Paul Jensen if (!validated) score -= UNVALIDATED_SCORE_PENALTY; 1012161a8ea123134ee3f9a10c0f8f56aabd8289f69Paul Jensen if (score < 0) score = 0; 1022161a8ea123134ee3f9a10c0f8f56aabd8289f69Paul Jensen 103e73cc4646bed3926024c9f54ca59e3a82a97b56cRobert Greenwalt if (networkMisc.explicitlySelected) score = EXPLICITLY_SELECTED_NETWORK_SCORE; 104e73cc4646bed3926024c9f54ca59e3a82a97b56cRobert Greenwalt 1052161a8ea123134ee3f9a10c0f8f56aabd8289f69Paul Jensen return score; 1062161a8ea123134ee3f9a10c0f8f56aabd8289f69Paul Jensen } 1072161a8ea123134ee3f9a10c0f8f56aabd8289f69Paul Jensen 1082161a8ea123134ee3f9a10c0f8f56aabd8289f69Paul Jensen public void setCurrentScore(int newScore) { 1092161a8ea123134ee3f9a10c0f8f56aabd8289f69Paul Jensen currentScore = newScore; 1102161a8ea123134ee3f9a10c0f8f56aabd8289f69Paul Jensen } 1112161a8ea123134ee3f9a10c0f8f56aabd8289f69Paul Jensen 1127b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwalt public String toString() { 1137b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwalt return "NetworkAgentInfo{ ni{" + networkInfo + "} network{" + 1147b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwalt network + "} lp{" + 1157b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwalt linkProperties + "} nc{" + 1162161a8ea123134ee3f9a10c0f8f56aabd8289f69Paul Jensen networkCapabilities + "} Score{" + getCurrentScore() + "} " + 117e73cc4646bed3926024c9f54ca59e3a82a97b56cRobert Greenwalt "validated{" + validated + "} created{" + created + "} " + 118e73cc4646bed3926024c9f54ca59e3a82a97b56cRobert Greenwalt "explicitlySelected{" + networkMisc.explicitlySelected + "} }"; 1197b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwalt } 1207b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwalt 1217b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwalt public String name() { 1227b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwalt return "NetworkAgentInfo [" + networkInfo.getTypeName() + " (" + 12360061a6ebf4ef758c4a47d210de0e5be2484be5bPaul Jensen networkInfo.getSubtypeName() + ") - " + 12460061a6ebf4ef758c4a47d210de0e5be2484be5bPaul Jensen (network == null ? "null" : network.toString()) + "]"; 1257b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwalt } 1267b81602f3c18df8a4ca0342c514af8f7e394c0d7Robert Greenwalt} 127