ConnectivityManager

ACTION_BACKGROUND_DATA_SETTING_CHANGED

public static final String ACTION_BACKGROUND_DATA_SETTING_CHANGED

This constant was deprecated in API level 16.
As of VERSION_CODES.ICE_CREAM_SANDWICH, availability of background data depends on several combined factors, and this broadcast is no longer sent. Instead, when background data is unavailable, getActiveNetworkInfo() will now appear disconnected. During first boot after a platform upgrade, this broadcast will be sent once if getBackgroundDataSetting() was false before the upgrade.

Broadcast Action: The setting for background data usage has changed values. Use getBackgroundDataSetting() to get the current value.

If an application uses the network in the background, it should listen for this broadcast and stop using the background data if the value is false.

Constant Value: "android.net.conn.BACKGROUND_DATA_SETTING_CHANGED"

ACTION_CAPTIVE_PORTAL_SIGN_IN

public static final String ACTION_CAPTIVE_PORTAL_SIGN_IN

The device has connected to a network that has presented a captive portal, which is blocking Internet connectivity. The user was presented with a notification that network sign in is required, and the user invoked the notification's action indicating they desire to sign in to the network. Apps handling this activity should facilitate signing in to the network. This action includes a Network typed extra called EXTRA_NETWORK that represents the network presenting the captive portal; all communication with the captive portal must be done using this Network object.

This activity includes a CaptivePortal extra named EXTRA_CAPTIVE_PORTAL that can be used to indicate different outcomes of the captive portal sign in to the system:

• When the app handling this action believes the user has signed in to the network and the captive portal has been dismissed, the app should call CaptivePortal.reportCaptivePortalDismissed so the system can reevaluate the network. If reevaluation finds the network no longer subject to a captive portal, the network may become the default active data network.
• When the app handling this action believes the user explicitly wants to ignore the captive portal and the network, the app should call CaptivePortal.ignoreNetwork.

Constant Value: "android.net.conn.CAPTIVE_PORTAL"

ACTION_RESTRICT_BACKGROUND_CHANGED

public static final String ACTION_RESTRICT_BACKGROUND_CHANGED

A change in the background metered network activity restriction has occurred.

Applications should call getRestrictBackgroundStatus() to check if the restriction applies to them.

This is only sent to registered receivers, not manifest receivers.

Constant Value: "android.net.conn.RESTRICT_BACKGROUND_CHANGED"

CONNECTIVITY_ACTION

public static final String CONNECTIVITY_ACTION

This constant was deprecated in API level 28.
apps should use the more versatile requestNetwork(NetworkRequest, PendingIntent), registerNetworkCallback(NetworkRequest, PendingIntent) or registerDefaultNetworkCallback(NetworkCallback) functions instead for faster and more detailed updates about the network changes they care about.

A change in network connectivity has occurred. A default connection has either been established or lost. The NetworkInfo for the affected network is sent as an extra; it should be consulted to see what kind of connectivity event occurred.

Apps targeting Android 7.0 (API level 24) and higher do not receive this broadcast if they declare the broadcast receiver in their manifest. Apps will still receive broadcasts if they register their BroadcastReceiver with Context.registerReceiver() and that context is still valid.

If this is a connection that was the result of failing over from a disconnected network, then the FAILOVER_CONNECTION boolean extra is set to true.

For a loss of connectivity, if the connectivity manager is attempting to connect (or has already connected) to another network, the NetworkInfo for the new network is also passed as an extra. This lets any receivers of the broadcast know that they should not necessarily tell the user that no data traffic will be possible. Instead, the receiver should expect another broadcast soon, indicating either that the failover attempt succeeded (and so there is still overall data connectivity), or that the failover attempt failed, meaning that all connectivity has been lost.

For a disconnect event, the boolean extra EXTRA_NO_CONNECTIVITY is set to true if there are no connected networks at all.

Note that this broadcast is deprecated and generally tries to implement backwards compatibility with older versions of Android. As such, it may not reflect new capabilities of the system, like multiple networks being connected at the same time, the details of newer technology, or changes in tethering state.

Constant Value: "android.net.conn.CONNECTIVITY_CHANGE"

DEFAULT_NETWORK_PREFERENCE

public static final int DEFAULT_NETWORK_PREFERENCE

This constant was deprecated in API level 18.
Since we support so many more networks now, the single network default network preference can't really express the hierarchy. Instead, the default is defined by the networkAttributes in config.xml. You can determine the current value by calling getNetworkPreference() from an App.

If you want to set the default network preference,you can directly change the networkAttributes array in framework's config.xml.

Constant Value: 1 (0x00000001)

EXTRA_CAPTIVE_PORTAL

public static final String EXTRA_CAPTIVE_PORTAL

The lookup key for a CaptivePortal object included with the ACTION_CAPTIVE_PORTAL_SIGN_IN intent. The CaptivePortal object can be used to either indicate to the system that the captive portal has been dismissed or that the user does not want to pursue signing in to captive portal. Retrieve it with Intent.getParcelableExtra(String).

Constant Value: "android.net.extra.CAPTIVE_PORTAL"

EXTRA_CAPTIVE_PORTAL_URL

public static final String EXTRA_CAPTIVE_PORTAL_URL

Key for passing a URL to the captive portal login activity.

Constant Value: "android.net.extra.CAPTIVE_PORTAL_URL"

EXTRA_EXTRA_INFO

public static final String EXTRA_EXTRA_INFO

This constant was deprecated in API level 29.
See NetworkInfo.getExtraInfo().

The lookup key for a string that provides optionally supplied extra information about the network state. The information may be passed up from the lower networking layers, and its meaning may be specific to a particular network type. Retrieve it with Intent.getStringExtra(String).

Constant Value: "extraInfo"

EXTRA_IS_FAILOVER

public static final String EXTRA_IS_FAILOVER

This constant was deprecated in API level 29.
See NetworkInfo.

The lookup key for a boolean that indicates whether a connect event is for a network to which the connectivity manager was failing over following a disconnect on another network. Retrieve it with Intent.getBooleanExtra(String, boolean).

Constant Value: "isFailover"

EXTRA_NETWORK

public static final String EXTRA_NETWORK

The lookup key for a Network object included with the intent after successfully finding a network for the applications request. Retrieve it with Intent.getParcelableExtra(String).

Note that if you intend to invoke Network.openConnection(java.net.URL) then you must get a ConnectivityManager instance before doing so.

Constant Value: "android.net.extra.NETWORK"

EXTRA_NETWORK_INFO

public static final String EXTRA_NETWORK_INFO

This constant was deprecated in API level 15.
The NetworkInfo object is deprecated, as many of its properties can't accurately represent modern network characteristics. Please obtain information about networks from the NetworkCapabilities or LinkProperties objects instead.

The lookup key for a NetworkInfo object. Retrieve with Intent.getParcelableExtra(String).

Constant Value: "networkInfo"

EXTRA_NETWORK_REQUEST

public static final String EXTRA_NETWORK_REQUEST

The lookup key for a NetworkRequest object included with the intent after successfully finding a network for the applications request. Retrieve it with Intent.getParcelableExtra(String).

Constant Value: "android.net.extra.NETWORK_REQUEST"

EXTRA_NETWORK_TYPE

public static final String EXTRA_NETWORK_TYPE

This constant was deprecated in API level 29.
The network type is not rich enough to represent the characteristics of modern networks. Please use NetworkCapabilities instead, in particular the transports.

Network type which triggered a CONNECTIVITY_ACTION broadcast.

Constant Value: "networkType"

EXTRA_NO_CONNECTIVITY

public static final String EXTRA_NO_CONNECTIVITY

The lookup key for a boolean that indicates whether there is a complete lack of connectivity, i.e., no network is available. Retrieve it with Intent.getBooleanExtra(String, boolean).

Constant Value: "noConnectivity"

EXTRA_OTHER_NETWORK_INFO

public static final String EXTRA_OTHER_NETWORK_INFO

This constant was deprecated in API level 29.
See NetworkInfo.

The lookup key for a NetworkInfo object. This is supplied when there is another network that it may be possible to connect to. Retrieve with Intent.getParcelableExtra(String).

Constant Value: "otherNetwork"

EXTRA_REASON

public static final String EXTRA_REASON

The lookup key for a string that indicates why an attempt to connect to a network failed. The string has no particular structure. It is intended to be used in notifications presented to users. Retrieve it with Intent.getStringExtra(String).

Constant Value: "reason"

MULTIPATH_PREFERENCE_HANDOVER

public static final int MULTIPATH_PREFERENCE_HANDOVER

It is acceptable to briefly use multipath data to provide seamless connectivity for time-sensitive user-facing operations when the system default network is temporarily unresponsive. The amount of data should be limited (less than one megabyte for every call to this method), and the operation should be infrequent to ensure that data usage is limited. An example of such an operation might be a time-sensitive foreground activity, such as a voice command, that the user is performing while walking out of range of a Wi-Fi network.

Constant Value: 1 (0x00000001)

MULTIPATH_PREFERENCE_PERFORMANCE

public static final int MULTIPATH_PREFERENCE_PERFORMANCE

It is acceptable to use metered data to improve network latency and performance.

Constant Value: 4 (0x00000004)

MULTIPATH_PREFERENCE_RELIABILITY

public static final int MULTIPATH_PREFERENCE_RELIABILITY

It is acceptable to use small amounts of multipath data on an ongoing basis to provide a backup channel for traffic that is primarily going over another network. An example might be maintaining backup connections to peers or servers for the purpose of fast fallback if the default network is temporarily unresponsive or disconnects. The traffic on backup paths should be negligible compared to the traffic on the main path.

Constant Value: 2 (0x00000002)

RESTRICT_BACKGROUND_STATUS_DISABLED

public static final int RESTRICT_BACKGROUND_STATUS_DISABLED

Device is not restricting metered network activity while application is running on background.

Constant Value: 1 (0x00000001)

RESTRICT_BACKGROUND_STATUS_ENABLED

public static final int RESTRICT_BACKGROUND_STATUS_ENABLED

Device is restricting metered network activity while application is running on background.

In this state, application should not try to use the network while running on background, because it would be denied.

Constant Value: 3 (0x00000003)

RESTRICT_BACKGROUND_STATUS_WHITELISTED

public static final int RESTRICT_BACKGROUND_STATUS_WHITELISTED

Device is restricting metered network activity while application is running on background, but application is allowed to bypass it.

In this state, application should take action to mitigate metered network access. For example, a music streaming application should switch to a low-bandwidth bitrate.

Constant Value: 2 (0x00000002)

TYPE_BLUETOOTH

public static final int TYPE_BLUETOOTH

This constant was deprecated in API level 28.
Applications should instead use NetworkCapabilities.hasTransport or requestNetwork(android.net.NetworkRequest, android.net.ConnectivityManager.NetworkCallback) to request an appropriate network. See NetworkCapabilities for supported transports.

A Bluetooth data connection.

Constant Value: 7 (0x00000007)

TYPE_DUMMY

public static final int TYPE_DUMMY

This constant was deprecated in API level 28.
This is not used any more.

Fake data connection. This should not be used on shipping devices.

Constant Value: 8 (0x00000008)

TYPE_ETHERNET

public static final int TYPE_ETHERNET

This constant was deprecated in API level 28.
Applications should instead use NetworkCapabilities.hasTransport or requestNetwork(android.net.NetworkRequest, android.net.ConnectivityManager.NetworkCallback) to request an appropriate network. See NetworkCapabilities for supported transports.

An Ethernet data connection.

Constant Value: 9 (0x00000009)

TYPE_MOBILE

public static final int TYPE_MOBILE

This constant was deprecated in API level 28.
Applications should instead use NetworkCapabilities.hasTransport or requestNetwork(android.net.NetworkRequest, android.net.ConnectivityManager.NetworkCallback) to request an appropriate network. See NetworkCapabilities for supported transports.

A Mobile data connection. Devices may support more than one.

Constant Value: 0 (0x00000000)

TYPE_MOBILE_DUN

public static final int TYPE_MOBILE_DUN

This constant was deprecated in API level 28.
Applications should instead use NetworkCapabilities.hasCapability or requestNetwork(android.net.NetworkRequest, android.net.ConnectivityManager.NetworkCallback) to request a network that provides the NetworkCapabilities.NET_CAPABILITY_DUN capability.

A DUN-specific Mobile data connection. This network type may use the same network interface as TYPE_MOBILE or it may use a different one. This is sometimes by the system when setting up an upstream connection for tethering so that the carrier is aware of DUN traffic.

Constant Value: 4 (0x00000004)

TYPE_MOBILE_HIPRI

public static final int TYPE_MOBILE_HIPRI

This constant was deprecated in API level 23.
Applications should instead use NetworkCapabilities.hasTransport or requestNetwork(android.net.NetworkRequest, android.net.ConnectivityManager.NetworkCallback) to request an appropriate network. See NetworkCapabilities for supported transports.

A High Priority Mobile data connection. This network type uses the same network interface as TYPE_MOBILE but the routing setup is different.

Constant Value: 5 (0x00000005)

TYPE_MOBILE_MMS

public static final int TYPE_MOBILE_MMS

This constant was deprecated in API level 23.
Applications should instead use NetworkCapabilities.hasCapability or requestNetwork(android.net.NetworkRequest, android.net.ConnectivityManager.NetworkCallback) to request a network that provides the NetworkCapabilities.NET_CAPABILITY_MMS capability.

An MMS-specific Mobile data connection. This network type may use the same network interface as TYPE_MOBILE or it may use a different one. This is used by applications needing to talk to the carrier's Multimedia Messaging Service servers.

Constant Value: 2 (0x00000002)

TYPE_MOBILE_SUPL

public static final int TYPE_MOBILE_SUPL

This constant was deprecated in API level 23.
Applications should instead use NetworkCapabilities.hasCapability or requestNetwork(android.net.NetworkRequest, android.net.ConnectivityManager.NetworkCallback) to request a network that provides the NetworkCapabilities.NET_CAPABILITY_SUPL capability.

A SUPL-specific Mobile data connection. This network type may use the same network interface as TYPE_MOBILE or it may use a different one. This is used by applications needing to talk to the carrier's Secure User Plane Location servers for help locating the device.

Constant Value: 3 (0x00000003)

TYPE_VPN

public static final int TYPE_VPN

This constant was deprecated in API level 28.
Applications should use NetworkCapabilities.TRANSPORT_VPN instead.

A virtual network using one or more native bearers. It may or may not be providing security services.

Constant Value: 17 (0x00000011)

TYPE_WIFI

public static final int TYPE_WIFI

This constant was deprecated in API level 28.
Applications should instead use NetworkCapabilities.hasTransport or requestNetwork(android.net.NetworkRequest, android.net.ConnectivityManager.NetworkCallback) to request an appropriate network. See NetworkCapabilities for supported transports.

A WIFI data connection. Devices may support more than one.

Constant Value: 1 (0x00000001)

TYPE_WIMAX

public static final int TYPE_WIMAX

This constant was deprecated in API level 28.
Applications should instead use NetworkCapabilities.hasTransport or requestNetwork(android.net.NetworkRequest, android.net.ConnectivityManager.NetworkCallback) to request an appropriate network. See NetworkCapabilities for supported transports.

A WiMAX data connection.

Constant Value: 6 (0x00000006)

addDefaultNetworkActiveListener

public void addDefaultNetworkActiveListener (ConnectivityManager.OnNetworkActiveListener l)

Start listening to reports when the system's default data network is active, meaning it is a good time to perform network traffic. Use isDefaultNetworkActive() to determine the current state of the system's default network after registering the listener.

If the process default network has been set with ConnectivityManager.bindProcessToNetwork this function will not reflect the process's default, but the system default.

bindProcessToNetwork

public boolean bindProcessToNetwork (Network network)

Binds the current process to network. All Sockets created in the future (and not explicitly bound via a bound SocketFactory from Network.getSocketFactory()) will be bound to network. All host name resolutions will be limited to network as well. Note that if network ever disconnects, all Sockets created in this way will cease to work and all host name resolutions will fail. This is by design so an application doesn't accidentally use Sockets it thinks are still bound to a particular Network. To clear binding pass null for network. Using individually bound Sockets created by Network.getSocketFactory().createSocket() and performing network-specific host name resolutions via Network.getAllByName is preferred to calling bindProcessToNetwork.

createSocketKeepalive

public SocketKeepalive createSocketKeepalive (Network network, 
                IpSecManager.UdpEncapsulationSocket socket, 
                InetAddress source, 
                InetAddress destination, 
                Executor executor, 
                SocketKeepalive.Callback callback)

Request that keepalives be started on a IPsec NAT-T socket.

getActiveNetwork

public Network getActiveNetwork ()

Returns a Network object corresponding to the currently active default data network. In the event that the current active default data network disconnects, the returned Network object will no longer be usable. This will return null when there is no default network, or when the default network is blocked.
Requires Manifest.permission.ACCESS_NETWORK_STATE

getActiveNetworkInfo

public NetworkInfo getActiveNetworkInfo ()

This method was deprecated in API level 29.
See NetworkInfo.

Returns details about the currently active default data network. When connected, this network is the default route for outgoing connections. You should always check NetworkInfo.isConnected() before initiating network traffic. This may return null when there is no default network. Note that if the default network is a VPN, this method will return the NetworkInfo for one of its underlying networks instead, or null if the VPN agent did not specify any. Apps interested in learning about VPNs should use getNetworkInfo(android.net.Network) instead.
Requires Manifest.permission.ACCESS_NETWORK_STATE

getAllNetworkInfo

public NetworkInfo[] getAllNetworkInfo ()

This method was deprecated in API level 23.
This method does not support multiple connected networks of the same type. Use getAllNetworks() and getNetworkInfo(android.net.Network) instead.

Returns connection status information about all network types supported by the device.
Requires Manifest.permission.ACCESS_NETWORK_STATE

getAllNetworks

public Network[] getAllNetworks ()

This method was deprecated in API level 31.
This method does not provide any notification of network state changes, forcing apps to call it repeatedly. This is inefficient and prone to race conditions. Apps should use methods such as registerNetworkCallback(android.net.NetworkRequest, android.net.ConnectivityManager.NetworkCallback) instead. Apps that desire to obtain information about networks that do not apply to them can use NetworkRequest.Builder.setIncludeOtherUidNetworks.

Returns an array of all Network currently tracked by the framework.
Requires Manifest.permission.ACCESS_NETWORK_STATE

getBackgroundDataSetting

public boolean getBackgroundDataSetting ()

This method was deprecated in API level 15.
As of VERSION_CODES.ICE_CREAM_SANDWICH, availability of background data depends on several combined factors, and this method will always return true. Instead, when background data is unavailable, getActiveNetworkInfo() will now appear disconnected.

Returns the value of the setting for background data usage. If false, applications should not use the network if the application is not in the foreground. Developers should respect this setting, and check the value of this before performing any background data operations.

All applications that have background services that use the network should listen to ACTION_BACKGROUND_DATA_SETTING_CHANGED.

getBoundNetworkForProcess

public Network getBoundNetworkForProcess ()

Returns the Network currently bound to this process via bindProcessToNetwork(Network), or null if no Network is explicitly bound.

getConnectionOwnerUid

public int getConnectionOwnerUid (int protocol, 
                InetSocketAddress local, 
                InetSocketAddress remote)

Returns the uid of the owner of a network connection.

getDefaultProxy

public ProxyInfo getDefaultProxy ()

Get the current default HTTP proxy settings. If a global proxy is set it will be returned, otherwise if this process is bound to a Network using bindProcessToNetwork(Network) then that Network's proxy is returned, otherwise the default network's proxy is returned.

getLinkProperties

public LinkProperties getLinkProperties (Network network)

Get the LinkProperties for the given Network. This will return null if the network is unknown.
Requires Manifest.permission.ACCESS_NETWORK_STATE

getMultipathPreference

public int getMultipathPreference (Network network)

Provides a hint to the calling application on whether it is desirable to use the multinetwork APIs (e.g., Network.openConnection, Network.bindSocket, etc.) for multipath data transfer on this network when it is not the system default network. Applications desiring to use multipath network protocols should call this method before each such operation.
Requires Manifest.permission.ACCESS_NETWORK_STATE

getNetworkCapabilities

public NetworkCapabilities getNetworkCapabilities (Network network)

Get the NetworkCapabilities for the given Network, or null. This will remove any location sensitive data in the returned NetworkCapabilities. Some TransportInfo instances like WifiInfo contain location sensitive information. To retrieve this location sensitive information (subject to the caller's location permissions), use a NetworkCallback with the NetworkCallback.FLAG_INCLUDE_LOCATION_INFO flag instead. This method returns null if the network is unknown or if the |network| argument is null.
Requires Manifest.permission.ACCESS_NETWORK_STATE

getNetworkInfo

public NetworkInfo getNetworkInfo (int networkType)

This method was deprecated in API level 23.
This method does not support multiple connected networks of the same type. Use getAllNetworks() and getNetworkInfo(android.net.Network) instead.

Returns connection status information about a particular network type.
Requires Manifest.permission.ACCESS_NETWORK_STATE

getNetworkInfo

public NetworkInfo getNetworkInfo (Network network)

This method was deprecated in API level 29.
See NetworkInfo.

Returns connection status information about a particular Network.
Requires Manifest.permission.ACCESS_NETWORK_STATE

getNetworkPreference

public int getNetworkPreference ()

This method was deprecated in API level 21.
Functionality has been removed as it no longer makes sense, with many more than two networks - we'd need an array to express preference. Instead we use dynamic network properties of the networks to describe their precedence.

Retrieves the current preferred network type.
Requires Manifest.permission.ACCESS_NETWORK_STATE

getNetworkWatchlistConfigHash

public byte[] getNetworkWatchlistConfigHash ()

The network watchlist is a list of domains and IP addresses that are associated with potentially harmful apps. This method returns the SHA-256 of the watchlist config file currently used by the system for validation purposes.

getProcessDefaultNetwork

public static Network getProcessDefaultNetwork ()

This method was deprecated in API level 23.
Using this function can lead to other functions throwing IllegalStateException. Use getBoundNetworkForProcess() instead. getBoundNetworkForProcess is a direct replacement.

Returns the Network currently bound to this process via bindProcessToNetwork(Network), or null if no Network is explicitly bound.

getRestrictBackgroundStatus

public int getRestrictBackgroundStatus ()

Determines if the calling application is subject to metered network restrictions while running on background.

isActiveNetworkMetered

public boolean isActiveNetworkMetered ()

Returns if the currently active data network is metered. A network is classified as metered when the user is sensitive to heavy data usage on that connection due to monetary costs, data limitations or battery/performance issues. You should check this before doing large data transfers, and warn the user or delay the operation until another network is available.
Requires Manifest.permission.ACCESS_NETWORK_STATE

isDefaultNetworkActive

public boolean isDefaultNetworkActive ()

Return whether the data network is currently active. An active network means that it is currently in a high power state for performing data transmission. On some types of networks, it may be expensive to move and stay in such a state, so it is more power efficient to batch network traffic together when the radio is already in this state. This method tells you whether right now is currently a good time to initiate network traffic, as the network is already active.

isNetworkTypeValid

public static boolean isNetworkTypeValid (int networkType)

This method was deprecated in API level 23.
All APIs accepting a network type are deprecated. There should be no need to validate a network type.

Tests if a given integer represents a valid network type.

registerBestMatchingNetworkCallback

public void registerBestMatchingNetworkCallback (NetworkRequest request, 
                ConnectivityManager.NetworkCallback networkCallback, 
                Handler handler)

Registers to receive notifications about the best matching network which satisfy the given NetworkRequest. The callbacks will continue to be called until either the application exits or unregisterNetworkCallback(android.net.ConnectivityManager.NetworkCallback) is called.

To avoid performance issues due to apps leaking callbacks, the system will limit the number of outstanding requests to 100 per app (identified by their UID), shared with registerNetworkCallback(NetworkRequest, PendingIntent) and its variants and requestNetwork(NetworkRequest, PendingIntent) as well as ConnectivityDiagnosticsManager.registerConnectivityDiagnosticsCallback. Requesting a network with this method will count toward this limit. If this limit is exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources, make sure to unregister the callbacks with unregisterNetworkCallback(android.net.ConnectivityManager.NetworkCallback).

registerDefaultNetworkCallback

public void registerDefaultNetworkCallback (ConnectivityManager.NetworkCallback networkCallback)

Registers to receive notifications about changes in the application's default network. This may be a physical network or a virtual network, such as a VPN that applies to the application. The callbacks will continue to be called until either the application exits or unregisterNetworkCallback(android.net.ConnectivityManager.NetworkCallback) is called.

To avoid performance issues due to apps leaking callbacks, the system will limit the number of outstanding requests to 100 per app (identified by their UID), shared with all variants of this method, of requestNetwork(NetworkRequest, PendingIntent) as well as ConnectivityDiagnosticsManager.registerConnectivityDiagnosticsCallback. Requesting a network with this method will count toward this limit. If this limit is exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources, make sure to unregister the callbacks with unregisterNetworkCallback(android.net.ConnectivityManager.NetworkCallback).
Requires Manifest.permission.ACCESS_NETWORK_STATE

registerDefaultNetworkCallback

public void registerDefaultNetworkCallback (ConnectivityManager.NetworkCallback networkCallback, 
                Handler handler)

Registers to receive notifications about changes in the application's default network. This may be a physical network or a virtual network, such as a VPN that applies to the application. The callbacks will continue to be called until either the application exits or unregisterNetworkCallback(android.net.ConnectivityManager.NetworkCallback) is called.

To avoid performance issues due to apps leaking callbacks, the system will limit the number of outstanding requests to 100 per app (identified by their UID), shared with all variants of this method, of requestNetwork(NetworkRequest, PendingIntent) as well as ConnectivityDiagnosticsManager.registerConnectivityDiagnosticsCallback. Requesting a network with this method will count toward this limit. If this limit is exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources, make sure to unregister the callbacks with unregisterNetworkCallback(android.net.ConnectivityManager.NetworkCallback).
Requires Manifest.permission.ACCESS_NETWORK_STATE

registerNetworkCallback

public void registerNetworkCallback (NetworkRequest request, 
                ConnectivityManager.NetworkCallback networkCallback)

Registers to receive notifications about all networks which satisfy the given NetworkRequest. The callbacks will continue to be called until either the application exits or unregisterNetworkCallback(android.net.ConnectivityManager.NetworkCallback) is called.

To avoid performance issues due to apps leaking callbacks, the system will limit the number of outstanding requests to 100 per app (identified by their UID), shared with all variants of this method, of requestNetwork(NetworkRequest, PendingIntent) as well as ConnectivityDiagnosticsManager.registerConnectivityDiagnosticsCallback. Requesting a network with this method will count toward this limit. If this limit is exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources, make sure to unregister the callbacks with unregisterNetworkCallback(android.net.ConnectivityManager.NetworkCallback).
Requires Manifest.permission.ACCESS_NETWORK_STATE

registerNetworkCallback

public void registerNetworkCallback (NetworkRequest request, 
                PendingIntent operation)

Registers a PendingIntent to be sent when a network is available which satisfies the given NetworkRequest. This function behaves identically to the version that takes a NetworkCallback, but instead of NetworkCallback a PendingIntent is used. This means the request may outlive the calling application and get called back when a suitable network is found.

The operation is an Intent broadcast that goes to a broadcast receiver that you registered with Context.registerReceiver or through the <receiver> tag in an AndroidManifest.xml file

The operation Intent is delivered with two extras, a Network typed extra called EXTRA_NETWORK and a NetworkRequest typed extra called EXTRA_NETWORK_REQUEST containing the original requests parameters.

If there is already a request for this Intent registered (with the equality of two Intents defined by Intent.filterEquals), then it will be removed and replaced by this one, effectively releasing the previous NetworkRequest.

The request may be released normally by calling unregisterNetworkCallback(android.app.PendingIntent).

To avoid performance issues due to apps leaking callbacks, the system will limit the number of outstanding requests to 100 per app (identified by their UID), shared with all variants of this method, of requestNetwork(NetworkRequest, PendingIntent) as well as ConnectivityDiagnosticsManager.registerConnectivityDiagnosticsCallback. Requesting a network with this method will count toward this limit. If this limit is exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources, make sure to unregister the callbacks with unregisterNetworkCallback(android.app.PendingIntent) or releaseNetworkRequest(android.app.PendingIntent).
Requires Manifest.permission.ACCESS_NETWORK_STATE

registerNetworkCallback

public void registerNetworkCallback (NetworkRequest request, 
                ConnectivityManager.NetworkCallback networkCallback, 
                Handler handler)

Registers to receive notifications about all networks which satisfy the given NetworkRequest. The callbacks will continue to be called until either the application exits or unregisterNetworkCallback(android.net.ConnectivityManager.NetworkCallback) is called.

To avoid performance issues due to apps leaking callbacks, the system will limit the number of outstanding requests to 100 per app (identified by their UID), shared with all variants of this method, of requestNetwork(NetworkRequest, PendingIntent) as well as ConnectivityDiagnosticsManager.registerConnectivityDiagnosticsCallback. Requesting a network with this method will count toward this limit. If this limit is exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources, make sure to unregister the callbacks with unregisterNetworkCallback(android.net.ConnectivityManager.NetworkCallback).
Requires Manifest.permission.ACCESS_NETWORK_STATE

releaseNetworkRequest

public void releaseNetworkRequest (PendingIntent operation)

Removes a request made via requestNetwork(android.net.NetworkRequest, android.app.PendingIntent)

This method has the same behavior as unregisterNetworkCallback(android.app.PendingIntent) with respect to releasing network resources and disconnecting.

removeDefaultNetworkActiveListener

public void removeDefaultNetworkActiveListener (ConnectivityManager.OnNetworkActiveListener l)

Remove network active listener previously registered with addDefaultNetworkActiveListener(OnNetworkActiveListener).

reportBadNetwork

public void reportBadNetwork (Network network)

This method was deprecated in API level 23.
Use reportNetworkConnectivity(Network, boolean) which allows reporting both working and non-working connectivity.

Report a problem network to the framework. This provides a hint to the system that there might be connectivity problems on this network and may cause the framework to re-evaluate network connectivity and/or switch to another network.

reportNetworkConnectivity

public void reportNetworkConnectivity (Network network, 
                boolean hasConnectivity)

Report to the framework whether a network has working connectivity. This provides a hint to the system that a particular network is providing working connectivity or not. In response the framework may re-evaluate the network's connectivity and might take further action thereafter.

requestBandwidthUpdate

public boolean requestBandwidthUpdate (Network network)

Requests bandwidth update for a given Network and returns whether the update request is accepted by ConnectivityService. Once accepted, ConnectivityService will poll underlying network connection for updated bandwidth information. The caller will be notified via ConnectivityManager.NetworkCallback if there is an update. Notice that this method assumes that the caller has previously called registerNetworkCallback(android.net.NetworkRequest, android.net.ConnectivityManager.NetworkCallback) to listen for network changes.

requestNetwork

public void requestNetwork (NetworkRequest request, 
                ConnectivityManager.NetworkCallback networkCallback)

Request a network to satisfy a set of NetworkCapabilities.

This method will attempt to find the best network that matches the passed NetworkRequest, and to bring up one that does if none currently satisfies the criteria. The platform will evaluate which network is the best at its own discretion. Throughput, latency, cost per byte, policy, user preference and other considerations may be factored in the decision of what is considered the best network.

As long as this request is outstanding, the platform will try to maintain the best network matching this request, while always attempting to match the request to a better network if possible. If a better match is found, the platform will switch this request to the now-best network and inform the app of the newly best network by invoking NetworkCallback.onAvailable(Network) on the provided callback. Note that the platform will not try to maintain any other network than the best one currently matching the request: a network not matching any network request may be disconnected at any time.

For example, an application could use this method to obtain a connected cellular network even if the device currently has a data connection over Ethernet. This may cause the cellular radio to consume additional power. Or, an application could inform the system that it wants a network supporting sending MMSes and have the system let it know about the currently best MMS-supporting network through the provided NetworkCallback.

The status of the request can be followed by listening to the various callbacks described in NetworkCallback. The Network object passed to the callback methods can be used to direct traffic to the network (although accessing some networks may be subject to holding specific permissions). Callers will learn about the specific characteristics of the network through NetworkCallback.onCapabilitiesChanged(Network, NetworkCapabilities) and NetworkCallback.onLinkPropertiesChanged(Network, LinkProperties). The methods of the provided NetworkCallback will only be invoked due to changes in the best network matching the request at any given time; therefore when a better network matching the request becomes available, the NetworkCallback.onAvailable(Network) method is called with the new network after which no further updates are given about the previously-best network, unless it becomes the best again at some later time. All callbacks are invoked in order on the same thread, which by default is a thread created by the framework running in the app. See requestNetwork(android.net.NetworkRequest, android.net.ConnectivityManager.NetworkCallback, android.os.Handler) to change where the callbacks are invoked.

ThisNetworkRequest will live until released via unregisterNetworkCallback(android.net.ConnectivityManager.NetworkCallback) or the calling application exits, at which point the system may let go of the network at any time.

A version of this method which takes a timeout is requestNetwork(android.net.NetworkRequest, android.net.ConnectivityManager.NetworkCallback, int), that an app can use to only wait for a limited amount of time for the network to become unavailable.

It is presently unsupported to request a network with mutable NetworkCapabilities such as NetworkCapabilities.NET_CAPABILITY_VALIDATED or NetworkCapabilities.NET_CAPABILITY_CAPTIVE_PORTAL as these NetworkCapabilities represent states that a particular network may never attain, and whether a network will attain these states is unknown prior to bringing up the network so the framework does not know how to go about satisfying a request with these capabilities.

This method requires the caller to hold either the Manifest.permission.CHANGE_NETWORK_STATE permission or the ability to modify system settings as determined by Settings.System.canWrite(Context).

To avoid performance issues due to apps leaking callbacks, the system will limit the number of outstanding requests to 100 per app (identified by their UID), shared with all variants of this method, of registerNetworkCallback(NetworkRequest, PendingIntent) as well as ConnectivityDiagnosticsManager.registerConnectivityDiagnosticsCallback. Requesting a network with this method will count toward this limit. If this limit is exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources, make sure to unregister the callbacks with unregisterNetworkCallback(android.net.ConnectivityManager.NetworkCallback).

requestNetwork

public void requestNetwork (NetworkRequest request, 
                ConnectivityManager.NetworkCallback networkCallback, 
                int timeoutMs)

Request a network to satisfy a set of NetworkCapabilities, limited by a timeout. This function behaves identically to the non-timed-out version requestNetwork(android.net.NetworkRequest, android.net.ConnectivityManager.NetworkCallback), but if a suitable network is not found within the given time (in milliseconds) the NetworkCallback.onUnavailable() callback is called. The request can still be released normally by calling unregisterNetworkCallback(android.net.ConnectivityManager.NetworkCallback) but does not have to be released if timed-out (it is automatically released). Unregistering a request that timed out is not an error.

Do not use this method to poll for the existence of specific networks (e.g. with a small timeout) - registerNetworkCallback(android.net.NetworkRequest, android.net.ConnectivityManager.NetworkCallback) is provided for that purpose. Calling this method will attempt to bring up the requested network.

This method has the same permission requirements as requestNetwork(android.net.NetworkRequest, android.net.ConnectivityManager.NetworkCallback), is subject to the same limitations, and throws the same exceptions in the same conditions.

requestNetwork

public void requestNetwork (NetworkRequest request, 
                ConnectivityManager.NetworkCallback networkCallback, 
                Handler handler)

Request a network to satisfy a set of NetworkCapabilities. This method behaves identically to requestNetwork(android.net.NetworkRequest, android.net.ConnectivityManager.NetworkCallback) but runs all the callbacks on the passed Handler.

This method has the same permission requirements as requestNetwork(android.net.NetworkRequest, android.net.ConnectivityManager.NetworkCallback), is subject to the same limitations, and throws the same exceptions in the same conditions.

requestNetwork

public void requestNetwork (NetworkRequest request, 
                PendingIntent operation)

Request a network to satisfy a set of NetworkCapabilities. This function behaves identically to the version that takes a NetworkCallback, but instead of NetworkCallback a PendingIntent is used. This means the request may outlive the calling application and get called back when a suitable network is found.

The operation is an Intent broadcast that goes to a broadcast receiver that you registered with Context.registerReceiver or through the <receiver> tag in an AndroidManifest.xml file

The operation Intent is delivered with two extras, a Network typed extra called EXTRA_NETWORK and a NetworkRequest typed extra called EXTRA_NETWORK_REQUEST containing the original requests parameters. It is important to create a new, NetworkCallback based request before completing the processing of the Intent to reserve the network or it will be released shortly after the Intent is processed.

If there is already a request for this Intent registered (with the equality of two Intents defined by Intent.filterEquals), then it will be removed and replaced by this one, effectively releasing the previous NetworkRequest.

The request may be released normally by calling releaseNetworkRequest(android.app.PendingIntent).

It is presently unsupported to request a network with either NetworkCapabilities.NET_CAPABILITY_VALIDATED or NetworkCapabilities.NET_CAPABILITY_CAPTIVE_PORTAL as these NetworkCapabilities represent states that a particular network may never attain, and whether a network will attain these states is unknown prior to bringing up the network so the framework does not know how to go about satisfying a request with these capabilities.

To avoid performance issues due to apps leaking callbacks, the system will limit the number of outstanding requests to 100 per app (identified by their UID), shared with all variants of this method, of registerNetworkCallback(NetworkRequest, PendingIntent) as well as ConnectivityDiagnosticsManager.registerConnectivityDiagnosticsCallback. Requesting a network with this method will count toward this limit. If this limit is exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources, make sure to unregister the callbacks with unregisterNetworkCallback(android.app.PendingIntent) or releaseNetworkRequest(android.app.PendingIntent).

This method requires the caller to hold either the Manifest.permission.CHANGE_NETWORK_STATE permission or the ability to modify system settings as determined by Settings.System.canWrite(Context).

requestNetwork

public void requestNetwork (NetworkRequest request, 
                ConnectivityManager.NetworkCallback networkCallback, 
                Handler handler, 
                int timeoutMs)

Request a network to satisfy a set of NetworkCapabilities, limited by a timeout. This method behaves identically to requestNetwork(android.net.NetworkRequest, android.net.ConnectivityManager.NetworkCallback, int) but runs all the callbacks on the passed Handler.

This method has the same permission requirements as requestNetwork(android.net.NetworkRequest, android.net.ConnectivityManager.NetworkCallback), is subject to the same limitations, and throws the same exceptions in the same conditions.

reserveNetwork

public void reserveNetwork (NetworkRequest request, 
                Handler handler, 
                ConnectivityManager.NetworkCallback networkCallback)

Reserve a network to satisfy a set of NetworkCapabilities. Some types of networks require the system to generate (i.e. reserve) some set of information before a network can be connected. For such networks, reserveNetwork(NetworkRequest, Handler, NetworkCallback) can be used which may lead to a call to NetworkCallback.onReserved(NetworkCapabilities) containing the NetworkCapabilities that were reserved. A reservation reserves at most one network. If the network connects, a reservation request behaves similar to a request filed using requestNetwork(NetworkRequest, PendingIntent). The provided NetworkCallback will only be called for the reserved network. If the system determines that the requested reservation can never be fulfilled, ConnectivityManager.NetworkCallback.onUnavailable() is called, the reservation is released by the system, and the provided callback can be reused. Otherwise, the reservation remains in place until the requested network connects. There is no guarantee that the reserved network will ever connect.

setNetworkPreference

public void setNetworkPreference (int preference)

This method was deprecated in API level 21.
Functionality has been removed as it no longer makes sense, with many more than two networks - we'd need an array to express preference. Instead we use dynamic network properties of the networks to describe their precedence.

Specifies the preferred network type. When the device has more than one type available the preferred network type will be used.

setProcessDefaultNetwork

public static boolean setProcessDefaultNetwork (Network network)

This method was deprecated in API level 23.
This function can throw IllegalStateException. Use bindProcessToNetwork(Network) instead. bindProcessToNetwork is a direct replacement.

Binds the current process to network. All Sockets created in the future (and not explicitly bound via a bound SocketFactory from Network.getSocketFactory()) will be bound to network. All host name resolutions will be limited to network as well. Note that if network ever disconnects, all Sockets created in this way will cease to work and all host name resolutions will fail. This is by design so an application doesn't accidentally use Sockets it thinks are still bound to a particular Network. To clear binding pass null for network. Using individually bound Sockets created by Network.getSocketFactory().createSocket() and performing network-specific host name resolutions via Network.getAllByName is preferred to calling setProcessDefaultNetwork.

unregisterNetworkCallback

public void unregisterNetworkCallback (ConnectivityManager.NetworkCallback networkCallback)

Unregisters a NetworkCallback and possibly releases networks originating from requestNetwork(android.net.NetworkRequest, android.net.ConnectivityManager.NetworkCallback) and registerNetworkCallback(android.net.NetworkRequest, android.net.ConnectivityManager.NetworkCallback) calls. If the given NetworkCallback had previously been used with #requestNetwork, any networks that the device brought up only to satisfy that request will be disconnected. Notifications that would have triggered that NetworkCallback will immediately stop triggering it as soon as this call returns.

unregisterNetworkCallback

public void unregisterNetworkCallback (PendingIntent operation)

Unregisters a callback previously registered via registerNetworkCallback(android.net.NetworkRequest, android.app.PendingIntent).