Android
android.net
public class

android.net.NetworkInfo

java.lang.Object
android.net.NetworkInfo Parcelable

Describes the status of a network interface of a given type (currently either Mobile or Wifi).

Nested Classes
NetworkInfo.DetailedState The fine-grained state of a network connection. 
NetworkInfo.State Coarse-grained network state. 

Summary

Constants

      Value  
Creator<NetworkInfo CREATOR  Implement the Parcelable interface      
Constants inherited from interface android.os.Parcelable

Public Constructors

            NetworkInfo(NetworkType type)

Public Methods

          int  describeContents()
Implement the Parcelable interface
          NetworkInfo.DetailedState  getDetailedState()
Reports the current fine-grained state of the network.
          String  getExtraInfo()
Report the extra information about the network state, if any was provided by the lower networking layers., if one is available.
          String  getReason()
Report the reason an attempt to establish connectivity failed, if one is available.
          NetworkInfo.State  getState()
Reports the current coarse-grained state of the network.
          NetworkType  getType()
Reports the type of network (currently mobile or Wi-Fi) to which the info in this object pertains.
          boolean  isAvailable()
Indicates whether network connectivity is possible.
          boolean  isConnected()
Indicates whether network connectivity exists and it is possible to establish connections and pass data.
          boolean  isConnectedOrConnecting()
Indicates whether network connectivity exists or is in the process of being established.
          boolean  isFailover()
Indicates whether the current attempt to connect to the network resulted from the ConnectivityManager trying to fail over to this network following a disconnect from another network.
          void  setFailover(boolean isFailover)
          void  setIsAvailable(boolean isAvailable)
Sets if the network is available, ie, if the connectivity is possible.
          String  toString()
Returns a string containing a concise, human-readable description of the receiver.
          void  writeToParcel(Parcel dest, int flags)
Implement the Parcelable interface
Methods inherited from class java.lang.Object
Methods inherited from interface android.os.Parcelable

Details

Constants

public static final Creator<NetworkInfo> CREATOR

Implement the Parcelable interface

Public Constructors

public NetworkInfo(NetworkType type)

Public Methods

public int describeContents()

Implement the Parcelable interface

public NetworkInfo.DetailedState getDetailedState()

Reports the current fine-grained state of the network.

Returns

  • the fine-grained state

public String getExtraInfo()

Report the extra information about the network state, if any was provided by the lower networking layers., if one is available.

Returns

  • the extra information, or null if not available

public String getReason()

Report the reason an attempt to establish connectivity failed, if one is available.

Returns

  • the reason for failure, or null if not available

public NetworkInfo.State getState()

Reports the current coarse-grained state of the network.

Returns

  • the coarse-grained state

public NetworkType getType()

Reports the type of network (currently mobile or Wi-Fi) to which the info in this object pertains.

Returns

  • the network type

public boolean isAvailable()

Indicates whether network connectivity is possible. A network is unavailable when a persistent or semi-persistent condition prevents the possibility of connecting to that network. Examples include
  • The device is out of the coverage area for any network of this type.
  • The device is on a network other than the home network (i.e., roaming), and data roaming has been disabled.

Returns

  • true if the network is available, false otherwise

public boolean isConnected()

Indicates whether network connectivity exists and it is possible to establish connections and pass data.

Returns

  • true if network connectivity exists, false otherwise.

public boolean isConnectedOrConnecting()

Indicates whether network connectivity exists or is in the process of being established. This is good for applications that need to do anything related to the network other than read or write data. For the latter, call isConnected() instead, which guarantees that the network is fully usable.

Returns

  • true if network connectivity exists or is in the process of being established, false otherwise.

public boolean isFailover()

Indicates whether the current attempt to connect to the network resulted from the ConnectivityManager trying to fail over to this network following a disconnect from another network.

Returns

  • true if this is a failover attempt, false otherwise.

public void setFailover(boolean isFailover)

public void setIsAvailable(boolean isAvailable)

Sets if the network is available, ie, if the connectivity is possible.

Parameters

isAvailable the new availability value.

public String toString()

Returns a string containing a concise, human-readable description of the receiver.

Returns

  • String a printable representation for the receiver.

public void writeToParcel(Parcel dest, int flags)

Implement the Parcelable interface
Copyright 2007 Google Inc. Build 0.9_r1-98467 - 14 Aug 2008 18:56