Added in API level 1

NetworkInterface

class NetworkInterface

kotlin.Any
↳	java.net.NetworkInterface

This class represents a Network Interface made up of a name, and a list of IP addresses assigned to this interface. It is used to identify the local interface on which a multicast group is joined. Interfaces are normally known by names such as "le0".

Note that information about NetworkInterfaces may be restricted. For example, non-system apps will only have access to information about NetworkInterfaces that are associated with an InetAddress.

Summary

Public methods
Boolean	equals(other: Any?) Compares this object against the specified object.
static NetworkInterface!	getByIndex(index: Int) Get a network interface given its index.
static NetworkInterface!	getByInetAddress(addr: InetAddress!) Convenience method to search for a network interface that has the specified Internet Protocol (IP) address bound to it.
static NetworkInterface!	getByName(name: String!) Searches for the network interface with the specified name.
String!	getDisplayName() Get the display name of this network interface.
ByteArray!	getHardwareAddress() Returns the hardware address (usually MAC) of the interface if it has one and if it can be accessed given the current privileges.
Int	getIndex() Returns the index of this network interface.
Enumeration<InetAddress!>!	getInetAddresses() Convenience method to return an Enumeration with all or a subset of the InetAddresses bound to this network interface.
MutableList<InterfaceAddress!>!	getInterfaceAddresses() Get a List of all or a subset of the InterfaceAddresses of this network interface.
Int	getMTU() Returns the Maximum Transmission Unit (MTU) of this interface.
String!	getName() Get the name of this network interface.
static Enumeration<NetworkInterface!>!	getNetworkInterfaces() Returns all the interfaces on this machine.
NetworkInterface!	getParent() Returns the parent NetworkInterface of this interface if this is a subinterface, or null if it is a physical (non virtual) interface or has no parent.
Enumeration<NetworkInterface!>!	getSubInterfaces() Get an Enumeration with all the subinterfaces (also known as virtual interfaces) attached to this network interface.
Int	hashCode()
Boolean	isLoopback() Returns whether a network interface is a loopback interface.
Boolean	isPointToPoint() Returns whether a network interface is a point to point interface.
Boolean	isUp() Returns whether a network interface is up and running.
Boolean	isVirtual() Returns whether this interface is a virtual interface (also called subinterface).
Boolean	supportsMulticast() Returns whether a network interface supports multicasting or not.
String	toString()

Public methods

equals

Added in API level 1

fun equals(other: Any?): Boolean

Compares this object against the specified object. The result is true if and only if the argument is not null and it represents the same NetworkInterface as this object.

Two instances of NetworkInterface represent the same NetworkInterface if both name and addrs are the same for both.

Parameters
obj	the object to compare against.

Return
Boolean	true if the objects are the same; false otherwise.

See Also

• java.net.InetAddress#getAddress()

getByIndex

Added in API level 19

static fun getByIndex(index: Int): NetworkInterface!

Get a network interface given its index.

Parameters
index	Int: an integer, the index of the interface

Return
NetworkInterface!	the NetworkInterface obtained from its index, or null if an interface with the specified index does not exist or can't be accessed.

Exceptions
java.net.SocketException	if an I/O error occurs.
java.lang.IllegalArgumentException	if index has a negative value

See Also

• #getIndex()

getByInetAddress

Added in API level 1

static fun getByInetAddress(addr: InetAddress!): NetworkInterface!

Convenience method to search for a network interface that has the specified Internet Protocol (IP) address bound to it.

If the specified IP address is bound to multiple network interfaces it is not defined which network interface is returned.

Parameters
addr	InetAddress!: The InetAddress to search with.

Return
NetworkInterface!	A NetworkInterface or null if there is no network interface with the specified IP address.

Exceptions
java.net.SocketException	If an I/O error occurs.
java.lang.NullPointerException	If the specified address is null.

getByName

Added in API level 1

static fun getByName(name: String!): NetworkInterface!

Searches for the network interface with the specified name.

Parameters
name	String!: The name of the network interface.

Return
NetworkInterface!	A NetworkInterface with the specified name, or null if the network interface with the specified name does not exist or can't be accessed.

Exceptions
java.net.SocketException	If an I/O error occurs.
java.lang.NullPointerException	If the specified name is null.

getDisplayName

Added in API level 1

fun getDisplayName(): String!

Get the display name of this network interface. A display name is a human readable String describing the network device.

Return
String!	a non-empty string representing the display name of this network interface, or null if no display name is available.

getHardwareAddress

Added in API level 9

fun getHardwareAddress(): ByteArray!

Returns the hardware address (usually MAC) of the interface if it has one and if it can be accessed given the current privileges. If a security manager is set, then the caller must have the permission NetPermission("getNetworkInformation").

Return
ByteArray!	a byte array containing the address, or null if the address doesn't exist, is not accessible or a security manager is set and the caller does not have the permission NetPermission("getNetworkInformation"). For example, this method will generally return null when called by non-system apps (or 02:00:00:00:00:00 for apps having targetSdkVersion < android.os.Build.VERSION_CODES.R).

Exceptions
java.net.SocketException	if an I/O error occurs.

getIndex

Added in API level 19

fun getIndex(): Int

Returns the index of this network interface. The index is an integer greater or equal to zero, or -1 for unknown. This is a system specific value and interfaces with the same name can have different indexes on different machines.

Return
Int	the index of this network interface or -1 if the index is unknown

See Also

• #getByIndex(int)

getInetAddresses

Added in API level 1

fun getInetAddresses(): Enumeration<InetAddress!>!

Convenience method to return an Enumeration with all or a subset of the InetAddresses bound to this network interface.

If there is a security manager, its checkConnect method is called for each InetAddress. Only InetAddresses where the checkConnect doesn't throw a SecurityException will be returned in the Enumeration. However, if the caller has the NetPermission("getNetworkInformation") permission, then all InetAddresses are returned.

Return
Enumeration<InetAddress!>!	an Enumeration object with all or a subset of the InetAddresses bound to this network interface

getInterfaceAddresses

Added in API level 9

fun getInterfaceAddresses(): MutableList<InterfaceAddress!>!

Get a List of all or a subset of the InterfaceAddresses of this network interface.

If there is a security manager, its checkConnect method is called with the InetAddress for each InterfaceAddress. Only InterfaceAddresses where the checkConnect doesn't throw a SecurityException will be returned in the List.

Return
MutableList<InterfaceAddress!>!	a List object with all or a subset of the InterfaceAddresss of this network interface

getMTU

Added in API level 9

fun getMTU(): Int

Returns the Maximum Transmission Unit (MTU) of this interface.

Return
Int	the value of the MTU for that interface.

Exceptions
java.net.SocketException	if an I/O error occurs.

getName

Added in API level 1

fun getName(): String!

Get the name of this network interface.

Return
String!	the name of this network interface

getNetworkInterfaces

Added in API level 1

static fun getNetworkInterfaces(): Enumeration<NetworkInterface!>!

Returns all the interfaces on this machine. The Enumeration contains at least one element, possibly representing a loopback interface that only supports communication between entities on this machine. NOTE: can use getNetworkInterfaces()+getInetAddresses() to obtain all IP addresses for this node

For non-system apps, this method will only return information for NetworkInterfaces associated with an InetAddress.

ANDROID NOTE: On Android versions before S (API level 31), this method may throw a NullPointerException if called in an environment where there is a virtual interface without a parent interface present.

Return
Enumeration<NetworkInterface!>!	an Enumeration of NetworkInterfaces found on this machine that are accessible.

Exceptions
java.net.SocketException	if an I/O error occurs.

getParent

Added in API level 9

fun getParent(): NetworkInterface!

Returns the parent NetworkInterface of this interface if this is a subinterface, or null if it is a physical (non virtual) interface or has no parent.

Return
NetworkInterface!	The NetworkInterface this interface is attached to.

getSubInterfaces

Added in API level 9

fun getSubInterfaces(): Enumeration<NetworkInterface!>!

Get an Enumeration with all the subinterfaces (also known as virtual interfaces) attached to this network interface.

For instance eth0:1 will be a subinterface to eth0.

Return
Enumeration<NetworkInterface!>!	an Enumeration object with all of the subinterfaces of this network interface

hashCode

Added in API level 1

fun hashCode(): Int

Return
Int	a hash code value for this object.

isLoopback

Added in API level 9

fun isLoopback(): Boolean

Returns whether a network interface is a loopback interface.

Return
Boolean	true if the interface is a loopback interface.

Exceptions
java.net.SocketException	if an I/O error occurs.

isPointToPoint

Added in API level 9

fun isPointToPoint(): Boolean

Returns whether a network interface is a point to point interface. A typical point to point interface would be a PPP connection through a modem.

Return
Boolean	true if the interface is a point to point interface.

Exceptions
java.net.SocketException	if an I/O error occurs.

isUp

Added in API level 9

fun isUp(): Boolean

Returns whether a network interface is up and running.

Return
Boolean	true if the interface is up and running.

Exceptions
java.net.SocketException	if an I/O error occurs.

isVirtual

Added in API level 9

fun isVirtual(): Boolean

Returns whether this interface is a virtual interface (also called subinterface). Virtual interfaces are, on some systems, interfaces created as a child of a physical interface and given different settings (like address or MTU). Usually the name of the interface will the name of the parent followed by a colon (:) and a number identifying the child since there can be several virtual interfaces attached to a single physical interface.

Return
Boolean	true if this interface is a virtual interface.

supportsMulticast

Added in API level 9

fun supportsMulticast(): Boolean

Returns whether a network interface supports multicasting or not.

Return
Boolean	true if the interface supports Multicasting.

Exceptions
java.net.SocketException	if an I/O error occurs.

toString

Added in API level 1

fun toString(): String

Return
String	a string representation of the object.