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 is dependent on the underlying system.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConnectivityManager.NetworkCallback Base class for NetworkRequest callbacks.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ConnectivityManager()

Method Summary

Modifier and Type	Method and Description
protected void	doNotifyAvailabilityChange(Network network, boolean available, ConnectivityManager.NetworkCallback[] networkCallbacks) Notify the networkCallbacks about an availability change.
protected void	doNotifyCapabilitiesChange(Network network, NetworkCapabilities capabilities, ConnectivityManager.NetworkCallback[] networkCallBacks) Notify the callback of a capabilities change.
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.
Network[]	getAllNetworks() Returns an array of all Network currently tracked by the framework.
NetworkCapabilities	getNetworkCapabilities(Network network) Get the NetworkCapabilities for the given Network.
NetworkInfo	getNetworkInfo(Network network) Returns connection status information about a particular Network.
protected void	notifyNetworkCallbacks(Network network, boolean available) Notifies a network availability change.
protected void	notifyNetworkCallbacks(Network network, NetworkCapabilities capabilities) Notifies a network capability change.
void	registerDefaultNetworkCallback(ConnectivityManager.NetworkCallback networkCallback) Registers to receive notifications about changes in the system default network.
void	registerNetworkCallback(NetworkRequest request, ConnectivityManager.NetworkCallback networkCallback) Registers to receive notifications about all networks which satisfy the given NetworkRequest.
protected void	setActiveNetwork(Network network) Sets the active network.
protected void	setAvailable(boolean available, Network network, NetworkInfo networkInfo) Sets the network availability.
void	unregisterNetworkCallback(ConnectivityManager.NetworkCallback networkCallback) Unregisters callbacks about and possibly releases networks originating from registerNetworkCallback(android.net.NetworkRequest, android.net.ConnectivityManager.NetworkCallback) calls.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConnectivityManager

protected ConnectivityManager()

Method Detail

doNotifyAvailabilityChange

protected void doNotifyAvailabilityChange(Network network,
                                          boolean available,
                                          ConnectivityManager.NetworkCallback[] networkCallbacks)

Notify the networkCallbacks about an availability change.

Parameters:

network - the network.

available - the availability.

networkCallbacks - the callback to call.

doNotifyCapabilitiesChange

protected void doNotifyCapabilitiesChange(Network network,
                                          NetworkCapabilities capabilities,
                                          ConnectivityManager.NetworkCallback[] networkCallBacks)

Notify the callback of a capabilities change.

Parameters:

network - the network.

capabilities - the capabilities.

networkCallBacks - the callback to call.

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.

Returns:

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

getActiveNetworkInfo

public NetworkInfo getActiveNetworkInfo()

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.

Returns:

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

getAllNetworks

public Network[] getAllNetworks()

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

Returns:

an array of Network objects.

getNetworkCapabilities

public NetworkCapabilities getNetworkCapabilities(Network network)

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

Parameters:

network - The Network object identifying the network in question.

Returns:

The NetworkCapabilities for the network, or null.

getNetworkInfo

public NetworkInfo getNetworkInfo(Network network)

Returns connection status information about a particular Network.

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.

notifyNetworkCallbacks

protected void notifyNetworkCallbacks(Network network,
                                      boolean available)

Notifies a network availability change.

Parameters:

network - the network.

available - true if the network is available.

notifyNetworkCallbacks

protected void notifyNetworkCallbacks(Network network,
                                      NetworkCapabilities capabilities)

Notifies a network capability change.

Parameters:

network - the network.

capabilities - the network capabilities.

registerDefaultNetworkCallback

public void registerDefaultNetworkCallback(ConnectivityManager.NetworkCallback networkCallback)

Registers to receive notifications about changes in the system default network. The callbacks will continue to be called until either the application exits or unregisterNetworkCallback(NetworkCallback) is called.

Parameters:

networkCallback - The ConnectivityManager.NetworkCallback that the system will call as the system default network changes. The callback is invoked on the default internal Handler.

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

Parameters:

request - NetworkRequest describing this request.

networkCallback - The ConnectivityManager.NetworkCallback that the system will call as suitable networks change state.

setActiveNetwork

protected void setActiveNetwork(Network network)

Sets the active network.

Parameters:

network - the network to set.

setAvailable

protected void setAvailable(boolean available,
                            Network network,
                            NetworkInfo networkInfo)

Sets the network availability.

Parameters:

available - true if available.

network - the network.

networkInfo - the network info.

unregisterNetworkCallback

public void unregisterNetworkCallback(ConnectivityManager.NetworkCallback networkCallback)

Unregisters callbacks about and possibly releases networks originating from registerNetworkCallback(android.net.NetworkRequest, android.net.ConnectivityManager.NetworkCallback) calls. If the given NetworkCallback had previosuly 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.