ConnectivityManager.NetworkCallback

Kotlin |Java

public static class ConnectivityManager.NetworkCallback
extends Object

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

Base class for NetworkRequest callbacks. Used for notifications about network changes. Should be extended by applications wanting notifications. A NetworkCallback is registered by calling ConnectivityManager.requestNetwork(android.net.NetworkRequest, android.net.ConnectivityManager.NetworkCallback), ConnectivityManager.registerNetworkCallback(android.net.NetworkRequest, android.net.ConnectivityManager.NetworkCallback), or ConnectivityManager.registerDefaultNetworkCallback(android.net.ConnectivityManager.NetworkCallback). A NetworkCallback is unregistered by calling ConnectivityManager.unregisterNetworkCallback(android.net.ConnectivityManager.NetworkCallback). A NetworkCallback should be registered at most once at any time. A NetworkCallback that has been unregistered can be registered again.

Summary

Public constructors
`ConnectivityManager.NetworkCallback()`

Public methods
`void`	`onAvailable(Network network)` Called when the framework connects and has declared a new network ready for use.
`void`	`onBlockedStatusChanged(Network network, boolean blocked)` Called when access to the specified network is blocked or unblocked.
`void`	`onCapabilitiesChanged(Network network, NetworkCapabilities networkCapabilities)` Called when the network the framework connected to for this request changes capabilities but still satisfies the stated need.
`void`	`onLinkPropertiesChanged(Network network, LinkProperties linkProperties)` Called when the network the framework connected to for this request changes `LinkProperties`.
`void`	`onLosing(Network network, int maxMsToLive)` Called when the network is about to be disconnected.
`void`	`onLost(Network network)` Called when the framework has a hard loss of the network or when the graceful failure ends.
`void`	`onUnavailable()` Called if no network is found in the timeout time specified in `ConnectivityManager.requestNetwork(android.net.NetworkRequest, android.net.ConnectivityManager.NetworkCallback, int)` call or if the requested network request cannot be fulfilled (whether or not a timeout was specified).

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeout, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long timeout)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

Public constructors

ConnectivityManager.NetworkCallback

public ConnectivityManager.NetworkCallback ()

Public methods

onAvailable

Added in API level 21

public void onAvailable (Network network)

Called when the framework connects and has declared a new network ready for use. This callback may be called more than once if the Network that is satisfying the request changes. This will always immediately be followed by a call to onCapabilitiesChanged(android.net.Network, android.net.NetworkCapabilities) then by a call to onLinkPropertiesChanged(android.net.Network, android.net.LinkProperties), and a call to onBlockedStatusChanged(android.net.Network, boolean).

Parameters
`network`	`Network`: The `Network` of the satisfying network. This value must never be `null`.

onBlockedStatusChanged

Added in Android Q

public void onBlockedStatusChanged (Network network, 
                boolean blocked)

Called when access to the specified network is blocked or unblocked.

Parameters
`network`	`Network`: The `Network` whose blocked status has changed. This value must never be `null`.
`blocked`	`boolean`: The blocked status of this `Network`.

onCapabilitiesChanged

Added in API level 21

public void onCapabilitiesChanged (Network network, 
                NetworkCapabilities networkCapabilities)

Called when the network the framework connected to for this request changes capabilities but still satisfies the stated need.

Parameters
`network`	`Network`: The `Network` whose capabilities have changed. This value must never be `null`.
`networkCapabilities`	`NetworkCapabilities`: The new `NetworkCapabilities` for this network. This value must never be `null`.

onLinkPropertiesChanged

Added in API level 21

public void onLinkPropertiesChanged (Network network, 
                LinkProperties linkProperties)

Called when the network the framework connected to for this request changes LinkProperties.

Parameters
`network`	`Network`: The `Network` whose link properties have changed. This value must never be `null`.
`linkProperties`	`LinkProperties`: The new `LinkProperties` for this network. This value must never be `null`.

onLosing

Added in API level 21

public void onLosing (Network network, 
                int maxMsToLive)

Called when the network is about to be disconnected. Often paired with an NetworkCallback#onAvailable call with the new replacement network for graceful handover. This may not be called if we have a hard loss (loss without warning). This may be followed by either a NetworkCallback#onLost call or a NetworkCallback#onAvailable call for this network depending on whether we lose or regain it.

Parameters
`network`	`Network`: The `Network` that is about to be disconnected. This value must never be `null`.
`maxMsToLive`	`int`: The time in ms the framework will attempt to keep the network connected. Note that the network may suffer a hard loss at any time.

onLost

Added in API level 21

public void onLost (Network network)

Called when the framework has a hard loss of the network or when the graceful failure ends.

Parameters
`network`	`Network`: The `Network` lost. This value must never be `null`.

onUnavailable

Added in API level 26

public void onUnavailable ()

Called if no network is found in the timeout time specified in ConnectivityManager.requestNetwork(android.net.NetworkRequest, android.net.ConnectivityManager.NetworkCallback, int) call or if the requested network request cannot be fulfilled (whether or not a timeout was specified). When this callback is invoked the associated NetworkRequest will have already been removed and released, as if ConnectivityManager.unregisterNetworkCallback(android.net.ConnectivityManager.NetworkCallback) had been called.