Android
android.net
public class

android.net.ConnectivityManager

java.lang.Object
android.net.ConnectivityManager

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

Nested Classes

Summary

Constants

      Value  
String  CONNECTIVITY_ACTION  A change in network connectivity has occurred.  "android.net.conn.CONNECTIVITY_CHANGE" 
ConnectivityManager.NetworkPreference  DEFAULT_NETWORK_PREFERENCE       
String  EXTRA_EXTRA_INFO  The lookup key for a string that provides optionally supplied extra information about the network state.  "extraInfo" 
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.  "isFailover" 
String  EXTRA_NETWORK_INFO  The lookup key for a NetworkInfo object.  "networkInfo" 
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.  "noConnectivity" 
String  EXTRA_OTHER_NETWORK_INFO  The lookup key for a NetworkInfo object.  "otherNetwork" 
String  EXTRA_REASON  The lookup key for a string that indicates why an attempt to connect to a network failed.  "reason" 

Public Methods

          NetworkInfo  getActiveNetworkInfo()
          NetworkInfo[]  getAllNetworkInfo()
          NetworkInfo  getNetworkInfo(NetworkType networkType)
          ConnectivityManager.NetworkPreference  getNetworkPreference()
          void  setNetworkPreference(ConnectivityManager.NetworkPreference preference)
          boolean  setRadio(NetworkType networkType, boolean turnOn)
          boolean  setRadios(boolean turnOn)
          int  startUsingNetworkFeature(NetworkType networkType, String feature)
Tells the underlying networking system that the caller wants to begin using the named feature.
          int  stopUsingNetworkFeature(NetworkType networkType, String feature)
Tells the underlying networking system that the caller is finished using the named feature.
Methods inherited from class java.lang.Object

Details

Constants

public static final String CONNECTIVITY_ACTION

A change in network connectivity has occurred. A 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 reciever 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 ConnectivityManager.NetworkPreference DEFAULT_NETWORK_PREFERENCE

public static final String EXTRA_EXTRA_INFO

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

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_INFO

The lookup key for a NetworkInfo object. Retrieve with getParcelableExtra(String).
Constant Value: "networkInfo"

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 getBooleanExtra(String, boolean).
Constant Value: "noConnectivity"

public static final String EXTRA_OTHER_NETWORK_INFO

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

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 Methods

public NetworkInfo getActiveNetworkInfo()

public NetworkInfo[] getAllNetworkInfo()

public NetworkInfo getNetworkInfo(NetworkType networkType)

public ConnectivityManager.NetworkPreference getNetworkPreference()

public void setNetworkPreference(ConnectivityManager.NetworkPreference preference)

public boolean setRadio(NetworkType networkType, boolean turnOn)

public boolean setRadios(boolean turnOn)

public int startUsingNetworkFeature(NetworkType networkType, String feature)

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.

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(NetworkType networkType, String feature)

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.

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.
Copyright 2007 Google Inc. Build 0.9_r1-98467 - 14 Aug 2008 18:48