Android APIs
public class

ConnectivityManager

extends Object
java.lang.Object
   ↳ android.net.ConnectivityManager

Class Overview

Class that answers queries about the state of network connectivity. It also notifies applications when network connectivity changes. Get an instance of this class by calling Context.getSystemService(Context.CONNECTIVITY_SERVICE).

The primary responsibilities of this class are to:

  1. Monitor network connections (Wi-Fi, GPRS, UMTS, etc.)
  2. Send broadcast intents when network connectivity changes
  3. Attempt to "fail over" to another network when connectivity to a network is lost
  4. Provide an API that allows applications to query the coarse-grained or fine-grained state of the available networks
  5. Provide an API that allows applications to request and select networks for their data traffic

Summary

Nested Classes
class ConnectivityManager.NetworkCallback Base class for NetworkRequest callbacks. 
interface ConnectivityManager.OnNetworkActiveListener Callback for use with addDefaultNetworkActiveListener(ConnectivityManager.OnNetworkActiveListener) to find out when the system default network has gone in to a high power state. 
Constants
String ACTION_BACKGROUND_DATA_SETTING_CHANGED This constant was deprecated in API level 16. As of 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.
String ACTION_CAPTIVE_PORTAL_SIGN_IN The device has connected to a network that has presented a captive portal, which is blocking Internet connectivity.
String CONNECTIVITY_ACTION A change in network connectivity has occurred.
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.
String EXTRA_CAPTIVE_PORTAL The lookup key for a CaptivePortal object included with the ACTION_CAPTIVE_PORTAL_SIGN_IN intent.
String EXTRA_EXTRA_INFO The lookup key for a string that provides optionally supplied extra information about the network state.
String EXTRA_IS_FAILOVER 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.
String EXTRA_NETWORK The lookup key for a Network object included with the intent after successfully finding a network for the applications request.
String EXTRA_NETWORK_INFO This constant was deprecated in API level 14. Since NetworkInfo can vary based on UID, applications should always obtain network information through getActiveNetworkInfo().
String EXTRA_NETWORK_REQUEST The lookup key for a NetworkRequest object included with the intent after successfully finding a network for the applications request.
String EXTRA_NETWORK_TYPE Network type which triggered a CONNECTIVITY_ACTION broadcast.
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.
String EXTRA_OTHER_NETWORK_INFO The lookup key for a NetworkInfo object.
String EXTRA_REASON The lookup key for a string that indicates why an attempt to connect to a network failed.
int TYPE_BLUETOOTH The Bluetooth data connection.
int TYPE_DUMMY Dummy data connection.
int TYPE_ETHERNET The Ethernet data connection.
int TYPE_MOBILE The Mobile data connection.
int TYPE_MOBILE_DUN A DUN-specific Mobile data connection.
int TYPE_MOBILE_HIPRI This constant was deprecated in API level 23. Applications should instead use requestNetwork(NetworkRequest, NetworkCallback) to request a network that uses the TRANSPORT_CELLULAR transport.
int TYPE_MOBILE_MMS This constant was deprecated in API level 23. Applications should instead use requestNetwork(NetworkRequest, NetworkCallback) to request a network that provides the NET_CAPABILITY_MMS capability.
int TYPE_MOBILE_SUPL This constant was deprecated in API level 23. Applications should instead use requestNetwork(NetworkRequest, NetworkCallback) to request a network that provides the NET_CAPABILITY_SUPL capability.
int TYPE_VPN A virtual network using one or more native bearers.
int TYPE_WIFI The WIFI data connection.
int TYPE_WIMAX The WiMAX data connection.
Public Methods
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.
boolean bindProcessToNetwork(Network network)
Binds the current process to network.
Network getActiveNetwork()
Returns a Network object corresponding to the currently active default data network.
NetworkInfo getActiveNetworkInfo()
Returns details about the currently active default data network.
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.
Network[] getAllNetworks()
Returns an array of all Network currently tracked by the framework.
boolean getBackgroundDataSetting()
This method was deprecated in API level 14. As of 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.
Network getBoundNetworkForProcess()
Returns the Network currently bound to this process via bindProcessToNetwork(Network), or null if no Network is explicitly bound.
ProxyInfo getDefaultProxy()
Get the current default HTTP proxy settings.
LinkProperties getLinkProperties(Network network)
Get the LinkProperties for the given Network.
NetworkCapabilities getNetworkCapabilities(Network network)
Get the NetworkCapabilities for the given Network.
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.
NetworkInfo getNetworkInfo(Network network)
Returns connection status information about a particular Network.
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.
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.
boolean isActiveNetworkMetered()
Returns if the currently active data network is metered.
boolean isDefaultNetworkActive()
Return whether the data network is currently active.
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.
void registerNetworkCallback(NetworkRequest request, PendingIntent operation)
Registers a PendingIntent to be sent when a network is available which satisfies the given NetworkRequest.
void registerNetworkCallback(NetworkRequest request, ConnectivityManager.NetworkCallback networkCallback)
Registers to receive notifications about all networks which satisfy the given NetworkRequest.
void releaseNetworkRequest(PendingIntent operation)
Removes a request made via requestNetwork(NetworkRequest, android.app.PendingIntent)

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

void removeDefaultNetworkActiveListener(ConnectivityManager.OnNetworkActiveListener l)
Remove network active listener previously registered with addDefaultNetworkActiveListener(ConnectivityManager.OnNetworkActiveListener).
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.
void reportNetworkConnectivity(Network network, boolean hasConnectivity)
Report to the framework whether a network has working connectivity.
boolean requestBandwidthUpdate(Network network)
Requests bandwidth update for a given Network and returns whether the update request is accepted by ConnectivityService.
void requestNetwork(NetworkRequest request, ConnectivityManager.NetworkCallback networkCallback)
Request a network to satisfy a set of NetworkCapabilities.
void requestNetwork(NetworkRequest request, PendingIntent operation)
Request a network to satisfy a set of NetworkCapabilities.
boolean requestRouteToHost(int networkType, int hostAddress)
This method was deprecated in API level 21. Deprecated in favor of the requestNetwork(NetworkRequest, NetworkCallback), bindProcessToNetwork(Network) and getSocketFactory() API. In M, and above, this method is unsupported and will throw UnsupportedOperationException if called.
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.
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.
int startUsingNetworkFeature(int networkType, String feature)
This method was deprecated in API level 21. Deprecated in favor of the cleaner requestNetwork(NetworkRequest, NetworkCallback) API. In M, and above, this method is unsupported and will throw UnsupportedOperationException if called.
int stopUsingNetworkFeature(int networkType, String feature)
This method was deprecated in API level 21. Deprecated in favor of the cleaner unregisterNetworkCallback(PendingIntent) API. In M, and above, this method is unsupported and will throw UnsupportedOperationException if called.
void unregisterNetworkCallback(PendingIntent operation)
Unregisters a callback previously registered via registerNetworkCallback(NetworkRequest, android.app.PendingIntent).
void unregisterNetworkCallback(ConnectivityManager.NetworkCallback networkCallback)
Unregisters callbacks about and possibly releases networks originating from requestNetwork(NetworkRequest, NetworkCallback) and registerNetworkCallback(NetworkRequest, PendingIntent) calls.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final String ACTION_BACKGROUND_DATA_SETTING_CHANGED

Added in API level 3

This constant was deprecated in API level 16.
As of 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"

public static final String ACTION_CAPTIVE_PORTAL_SIGN_IN

Added in API level 23

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 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 ignoreNetwork().

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

public static final String CONNECTIVITY_ACTION

Added in API level 1

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.

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.

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

public static final int DEFAULT_NETWORK_PREFERENCE

Added in API level 1

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)

public static final String EXTRA_CAPTIVE_PORTAL

Added in API level 23

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 getParcelableExtra(String).

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

public static final String EXTRA_EXTRA_INFO

Added in API level 1

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 getStringExtra(String).

Constant Value: "extraInfo"

public static final String EXTRA_IS_FAILOVER

Added in API level 1

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 getBooleanExtra(String, boolean).

Constant Value: "isFailover"

public static final String EXTRA_NETWORK

Added in API level 22

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

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

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

public static final String EXTRA_NETWORK_INFO

Added in API level 1

This constant was deprecated in API level 14.
Since NetworkInfo can vary based on UID, applications should always obtain network information through getActiveNetworkInfo().

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

Constant Value: "networkInfo"

public static final String EXTRA_NETWORK_REQUEST

Added in API level 22

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

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

public static final String EXTRA_NETWORK_TYPE

Added in API level 17

Network type which triggered a CONNECTIVITY_ACTION broadcast.

Constant Value: "networkType"

public static final String EXTRA_NO_CONNECTIVITY

Added in API level 1

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 getBooleanExtra(String, boolean).

Constant Value: "noConnectivity"

public static final String EXTRA_OTHER_NETWORK_INFO

Added in API level 1

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 getParcelableExtra(String).

Constant Value: "otherNetwork"

public static final String EXTRA_REASON

Added in API level 1

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 getStringExtra(String).

Constant Value: "reason"

public static final int TYPE_BLUETOOTH

Added in API level 13

The Bluetooth data connection. When active, all data traffic will use this network type's interface by default (it has a default route).

Constant Value: 7 (0x00000007)

public static final int TYPE_DUMMY

Added in API level 14

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

Constant Value: 8 (0x00000008)

public static final int TYPE_ETHERNET

Added in API level 13

The Ethernet data connection. When active, all data traffic will use this network type's interface by default (it has a default route).

Constant Value: 9 (0x00000009)

public static final int TYPE_MOBILE

Added in API level 1

The Mobile data connection. When active, all data traffic will use this network type's interface by default (it has a default route)

Constant Value: 0 (0x00000000)

public static final int TYPE_MOBILE_DUN

Added in API level 8

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)

public static final int TYPE_MOBILE_HIPRI

Added in API level 8

This constant was deprecated in API level 23.
Applications should instead use requestNetwork(NetworkRequest, NetworkCallback) to request a network that uses the TRANSPORT_CELLULAR transport.

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)

public static final int TYPE_MOBILE_MMS

Added in API level 8

This constant was deprecated in API level 23.
Applications should instead use requestNetwork(NetworkRequest, NetworkCallback) to request a network that provides the 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)

public static final int TYPE_MOBILE_SUPL

Added in API level 8

This constant was deprecated in API level 23.
Applications should instead use requestNetwork(NetworkRequest, NetworkCallback) to request a network that provides the 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)

public static final int TYPE_VPN

Added in API level 21

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

Constant Value: 17 (0x00000011)

public static final int TYPE_WIFI

Added in API level 1

The WIFI data connection. When active, all data traffic will use this network type's interface by default (it has a default route).

Constant Value: 1 (0x00000001)

public static final int TYPE_WIMAX

Added in API level 8

The WiMAX data connection. When active, all data traffic will use this network type's interface by default (it has a default route).

Constant Value: 6 (0x00000006)

Public Methods

public void addDefaultNetworkActiveListener (ConnectivityManager.OnNetworkActiveListener l)

Added in API level 21

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 bindProcessToNetwork(Network) this function will not reflect the process's default, but the system default.

Parameters
l The listener to be told when the network is active.

public boolean bindProcessToNetwork (Network network)

Added in API level 23

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.

Parameters
network The Network to bind the current process to, or null to clear the current binding.
Returns
  • true on success, false if the Network is no longer valid.

public Network getActiveNetwork ()

Added in API level 23

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.

This method requires the caller to hold the permission ACCESS_NETWORK_STATE.

Returns
  • a Network object for the current default network or null if no default network is currently active

public NetworkInfo getActiveNetworkInfo ()

Added in API level 1

Returns details about the currently active default data network. When connected, this network is the default route for outgoing connections. You should always check isConnected() before initiating network traffic. This may return null when there is no default network.

This method requires the caller to hold the permission ACCESS_NETWORK_STATE.

Returns
  • a NetworkInfo object for the current default network or null if no default network is currently active

public NetworkInfo[] getAllNetworkInfo ()

Added in API level 1

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.

This method requires the caller to hold the permission ACCESS_NETWORK_STATE.

Returns

public Network[] getAllNetworks ()

Added in API level 21

Returns an array of all Network currently tracked by the framework.

This method requires the caller to hold the permission ACCESS_NETWORK_STATE.

Returns

public boolean getBackgroundDataSetting ()

Added in API level 3

This method was deprecated in API level 14.
As of 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.

Returns
  • Whether background data usage is allowed.

public Network getBoundNetworkForProcess ()

Added in API level 23

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

Returns
  • Network to which this process is bound, or null.

public ProxyInfo getDefaultProxy ()

Added in API level 23

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.

Returns
  • the ProxyInfo for the current HTTP proxy, or null if no HTTP proxy is active.

public LinkProperties getLinkProperties (Network network)

Added in API level 21

Get the LinkProperties for the given Network. This will return null if the network is unknown.

This method requires the caller to hold the permission ACCESS_NETWORK_STATE.

Parameters
network The Network object identifying the network in question.
Returns

public NetworkCapabilities getNetworkCapabilities (Network network)

Added in API level 21

Get the NetworkCapabilities for the given Network. This will return null if the network is unknown.

This method requires the caller to hold the permission ACCESS_NETWORK_STATE.

Parameters
network The Network object identifying the network in question.
Returns

public NetworkInfo getNetworkInfo (int networkType)

Added in API level 1

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.

This method requires the caller to hold the permission ACCESS_NETWORK_STATE.

Parameters
networkType integer specifying which networkType in which you're interested.
Returns
  • a NetworkInfo object for the requested network type or null if the type is not supported by the device.

public NetworkInfo getNetworkInfo (Network network)

Added in API level 21

Returns connection status information about a particular Network.

This method requires the caller to hold the permission ACCESS_NETWORK_STATE.

Parameters
network Network specifying which network in which you're interested.
Returns
  • a NetworkInfo object for the requested network or null if the Network is not valid.

public int getNetworkPreference ()

Added in API level 1

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.

This method requires the caller to hold the permission ACCESS_NETWORK_STATE.

Returns
  • an integer representing the preferred network type

public static Network getProcessDefaultNetwork ()

Added in API level 21

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.

Returns
  • Network to which this process is bound, or null.

public boolean isActiveNetworkMetered ()

Added in API level 16

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.

This method requires the caller to hold the permission ACCESS_NETWORK_STATE.

Returns
  • true if large transfers should be avoided, otherwise false.

public boolean isDefaultNetworkActive ()

Added in API level 21

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.

public static boolean isNetworkTypeValid (int networkType)

Added in API level 1

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.

Parameters
networkType the type to be tested
Returns
  • a boolean. true if the type is valid, else false

public void registerNetworkCallback (NetworkRequest request, PendingIntent operation)

Added in API level 23

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 ConnectivityManager.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 registerReceiver(BroadcastReceiver, IntentFilter) 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 filterEquals(Intent)), 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).

This method requires the caller to hold the permission ACCESS_NETWORK_STATE.

Parameters
request NetworkRequest describing this request.
operation Action to perform when the network is available (corresponds to the onAvailable(Network) call. Typically comes from getBroadcast(Context, int, Intent, int). Cannot be null.

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

Added in API level 21

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(PendingIntent) is called

This method requires the caller to hold the permission ACCESS_NETWORK_STATE.

Parameters
request NetworkRequest describing this request.
networkCallback The ConnectivityManager.NetworkCallback that the system will call as suitable networks change state.

public void releaseNetworkRequest (PendingIntent operation)

Added in API level 22

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

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

Parameters
operation A PendingIntent equal (as defined by filterEquals(Intent)) to the PendingIntent passed to requestNetwork(NetworkRequest, android.app.PendingIntent) with the corresponding NetworkRequest you'd like to remove. Cannot be null.

public void removeDefaultNetworkActiveListener (ConnectivityManager.OnNetworkActiveListener l)

Added in API level 21

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

Parameters
l Previously registered listener.

public void reportBadNetwork (Network network)

Added in API level 21

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.

Parameters
network The Network the application was attempting to use or null to indicate the current default network.

public void reportNetworkConnectivity (Network network, boolean hasConnectivity)

Added in API level 23

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.

Parameters
network The Network the application was attempting to use or null to indicate the current default network.
hasConnectivity true if the application was able to successfully access the Internet using network or false if not.

public boolean requestBandwidthUpdate (Network network)

Added in API level 23

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(NetworkRequest, PendingIntent) to listen for network changes.

Parameters
network Network specifying which network you're interested.
Returns
  • true on success, false if the Network is no longer valid.

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

Added in API level 21

Request a network to satisfy a set of NetworkCapabilities. This NetworkRequest will live until released via unregisterNetworkCallback(PendingIntent) or the calling application exits. Status of the request can be followed by listening to the various callbacks described in ConnectivityManager.NetworkCallback. The Network can be used to direct traffic to the network.

It is presently unsupported to request a network with mutable NetworkCapabilities such as NET_CAPABILITY_VALIDATED or 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 satisfing a request with these capabilities.

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

Parameters
request NetworkRequest describing this request.
networkCallback The ConnectivityManager.NetworkCallback to be utilized for this request. Note the callback must not be shared - they uniquely specify this request.
Throws
IllegalArgumentException if request specifies any mutable NetworkCapabilities.

public void requestNetwork (NetworkRequest request, PendingIntent operation)

Added in API level 22

Request a network to satisfy a set of NetworkCapabilities. This function behaves identically to the version that takes a NetworkCallback, but instead of ConnectivityManager.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 registerReceiver(BroadcastReceiver, IntentFilter) 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, ConnectivityManager.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 filterEquals(Intent)), 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 NET_CAPABILITY_VALIDATED or 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 satisfing a request with these capabilities.

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

Parameters
request NetworkRequest describing this request.
operation Action to perform when the network is available (corresponds to the onAvailable(Network) call. Typically comes from getBroadcast(Context, int, Intent, int). Cannot be null.

public boolean requestRouteToHost (int networkType, int hostAddress)

Added in API level 1

This method was deprecated in API level 21.
Deprecated in favor of the requestNetwork(NetworkRequest, NetworkCallback), bindProcessToNetwork(Network) and getSocketFactory() API. In M, and above, this method is unsupported and will throw UnsupportedOperationException if called.

Ensure that a network route exists to deliver traffic to the specified host via the specified network interface. An attempt to add a route that already exists is ignored, but treated as successful.

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

Parameters
networkType the type of the network over which traffic to the specified host is to be routed
hostAddress the IP address of the host to which the route is desired
Returns
  • true on success, false on failure

public void setNetworkPreference (int preference)

Added in API level 1

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.

Parameters
preference the network type to prefer over all others. It is unspecified what happens to the old preferred network in the overall ordering.

public static boolean setProcessDefaultNetwork (Network network)

Added in API level 21

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.

Parameters
network The Network to bind the current process to, or null to clear the current binding.
Returns
  • true on success, false if the Network is no longer valid.

public int startUsingNetworkFeature (int networkType, String feature)

Added in API level 1

This method was deprecated in API level 21.
Deprecated in favor of the cleaner requestNetwork(NetworkRequest, NetworkCallback) API. In M, and above, this method is unsupported and will throw UnsupportedOperationException if called.

Tells the underlying networking system that the caller wants to begin using the named feature. The interpretation of feature is completely up to each networking implementation.

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

Parameters
networkType specifies which network the request pertains to
feature the name of the feature to be used
Returns
  • an integer value representing the outcome of the request. The interpretation of this value is specific to each networking implementation+feature combination, except that the value -1 always indicates failure.

public int stopUsingNetworkFeature (int networkType, String feature)

Added in API level 1

This method was deprecated in API level 21.
Deprecated in favor of the cleaner unregisterNetworkCallback(PendingIntent) API. In M, and above, this method is unsupported and will throw UnsupportedOperationException if called.

Tells the underlying networking system that the caller is finished using the named feature. The interpretation of feature is completely up to each networking implementation.

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

Parameters
networkType specifies which network the request pertains to
feature the name of the feature that is no longer needed
Returns
  • an integer value representing the outcome of the request. The interpretation of this value is specific to each networking implementation+feature combination, except that the value -1 always indicates failure.

public void unregisterNetworkCallback (PendingIntent operation)

Added in API level 23

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

Parameters
operation A PendingIntent equal (as defined by filterEquals(Intent)) to the PendingIntent passed to registerNetworkCallback(NetworkRequest, android.app.PendingIntent). Cannot be null.

public void unregisterNetworkCallback (ConnectivityManager.NetworkCallback networkCallback)

Added in API level 21

Unregisters callbacks about and possibly releases networks originating from requestNetwork(NetworkRequest, NetworkCallback) and registerNetworkCallback(NetworkRequest, PendingIntent) calls. If the given NetworkCallback had previously been used with #requestNetwork, any networks that had been connected to only to satisfy that request will be disconnected.

Parameters
networkCallback The ConnectivityManager.NetworkCallback used when making the request.