android.net
Class ConnectivityManager

java.lang.Object
  android.net.ConnectivityManager

public class ConnectivityManager
extends Object

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

Field Summary

static String	CONNECTIVITY_ACTION A change in network connectivity has occurred.
static int	DEFAULT_NETWORK_PREFERENCE
static String	EXTRA_EXTRA_INFO The lookup key for a string that provides optionally supplied extra information about the network state.
static 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.
static String	EXTRA_NETWORK_INFO The lookup key for a NetworkInfo object.
static 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.
static String	EXTRA_OTHER_NETWORK_INFO The lookup key for a NetworkInfo object.
static String	EXTRA_REASON The lookup key for a string that indicates why an attempt to connect to a network failed.
static int	TYPE_MOBILE
static int	TYPE_WIFI

Constructor Summary

ConnectivityManager(IConnectivityManager service)

Method Summary

NetworkInfo	getActiveNetworkInfo()
NetworkInfo[]	getAllNetworkInfo()
NetworkInfo	getNetworkInfo(int networkType)
int	getNetworkPreference()
static boolean	isNetworkTypeValid(int networkType)
boolean	requestRouteToHost(int networkType, int hostAddress) Ensure that a network route exists to deliver traffic to the specified host via the specified network interface.
void	setNetworkPreference(int preference)
boolean	setRadio(int networkType, boolean turnOn)
boolean	setRadios(boolean turnOn)
int	startUsingNetworkFeature(int networkType, String feature) Tells the underlying networking system that the caller wants to begin using the named feature.
int	stopUsingNetworkFeature(int networkType, String feature) Tells the underlying networking system that the caller is finished using the named feature.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CONNECTIVITY_ACTION

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.

See Also:

Constant Field Values

EXTRA_NETWORK_INFO

public static final String EXTRA_NETWORK_INFO

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

See Also:

Constant Field Values

EXTRA_IS_FAILOVER

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

See Also:

Constant Field Values

EXTRA_OTHER_NETWORK_INFO

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

See Also:

Constant Field Values

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

See Also:

Constant Field Values

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

See Also:

Constant Field Values

EXTRA_EXTRA_INFO

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

See Also:

Constant Field Values

TYPE_MOBILE

public static final int TYPE_MOBILE

See Also:

Constant Field Values

TYPE_WIFI

public static final int TYPE_WIFI

See Also:

Constant Field Values

DEFAULT_NETWORK_PREFERENCE

public static final int DEFAULT_NETWORK_PREFERENCE

See Also:

Constant Field Values

Constructor Detail

ConnectivityManager

public ConnectivityManager(IConnectivityManager service)

Method Detail

isNetworkTypeValid

public static boolean isNetworkTypeValid(int networkType)

setNetworkPreference

public void setNetworkPreference(int preference)

getNetworkPreference

public int getNetworkPreference()

getActiveNetworkInfo

public NetworkInfo getActiveNetworkInfo()

getNetworkInfo

public NetworkInfo getNetworkInfo(int networkType)

getAllNetworkInfo

public NetworkInfo[] getAllNetworkInfo()

setRadios

public boolean setRadios(boolean turnOn)

setRadio

public boolean setRadio(int networkType,
                        boolean turnOn)

startUsingNetworkFeature

public int startUsingNetworkFeature(int 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.

stopUsingNetworkFeature

public int stopUsingNetworkFeature(int 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.

requestRouteToHost

public boolean requestRouteToHost(int networkType,
                                  int hostAddress)

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.

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