LinkProperties

LinkProperties

LinkProperties()

Constructs a new LinkProperties with default values.

addRoute

fun addRoute(route: RouteInfo): Boolean

Adds a RouteInfo to this LinkProperties. If there is a RouteInfo with the same destination, gateway and interface with different properties (e.g., different MTU), it will be updated. If the RouteInfo had an interface name set and that differs from the interface set for this LinkProperties an IllegalArgumentException will be thrown. The proper course is to add either un-named or properly named RouteInfo.

clear

fun clear(): Unit

Clears this object to its initial state.

describeContents

fun describeContents(): Int

Implement the Parcelable interface

equals

fun equals(other: Any?): Boolean

Compares this LinkProperties instance against the target LinkProperties in obj. Two LinkPropertieses are equal if all their fields are equal in values. For collection fields, such as mDnses, containsAll() is used to check if two collections contains the same elements, independent of order. There are two thoughts regarding containsAll() 1. Duplicated elements. eg, (A, B, B) and (A, A, B) are equal. 2. Worst case performance is O(n^2).

getDhcpServerAddress

fun getDhcpServerAddress(): Inet4Address?

Get DHCP server address

getDnsServers

fun getDnsServers(): MutableList<InetAddress!>

Returns all the InetAddress for DNS servers on this link.

getDomains

fun getDomains(): String?

Get the DNS domains search path set for this link. May be null if not set.

getHttpProxy

fun getHttpProxy(): ProxyInfo?

Gets the recommended ProxyInfo (or null) set on this link.

getInterfaceName

fun getInterfaceName(): String?

Gets the interface name for this link. May be null if not set.

getLinkAddresses

fun getLinkAddresses(): MutableList<LinkAddress!>

Returns all the LinkAddress on this link. Typically a link will have one IPv4 address and one or more IPv6 addresses.

getMtu

fun getMtu(): Int

Gets any non-default MTU size set for this link. Note that if the default is being used this will return 0.

getNat64Prefix

fun getNat64Prefix(): IpPrefix?

Returns the NAT64 prefix in use on this link, if any.

getPrivateDnsServerName

fun getPrivateDnsServerName(): String?

Returns the private DNS server name that is in use. If not null, private DNS is in strict mode. In this mode, applications should ensure that all DNS queries are encrypted and sent to this hostname and that queries are only sent if the hostname's certificate is valid. If null and isPrivateDnsActive is true, private DNS is in opportunistic mode, and applications should ensure that DNS queries are encrypted and sent to a DNS server returned by getDnsServers. System DNS will handle each of these cases correctly, but applications implementing their own DNS lookups must make sure to follow these requirements.

getRoutes

fun getRoutes(): MutableList<RouteInfo!>

Returns all the RouteInfo set on this link. Only unicast routes are returned for apps targeting Android S or below.

hashCode

fun hashCode(): Int

Generate hashcode based on significant fields Equal objects must produce the same hash code, while unequal objects may have the same hash codes.

isPrivateDnsActive

fun isPrivateDnsActive(): Boolean

Returns whether private DNS is currently in use on this network. When private DNS is in use, applications must not send unencrypted DNS queries as doing so could reveal private user information. Furthermore, if private DNS is in use and getPrivateDnsServerName is not null, DNS queries must be sent to the specified DNS server.

isWakeOnLanSupported

fun isWakeOnLanSupported(): Boolean

Returns whether the network interface supports WakeOnLAN

setDhcpServerAddress

fun setDhcpServerAddress(serverAddress: Inet4Address?): Unit

Set DHCP server address.

setDnsServers

fun setDnsServers(dnsServers: MutableCollection<InetAddress!>): Unit

Replaces the DNS servers in this LinkProperties with the given Collection of InetAddress objects.

setDomains

fun setDomains(domains: String?): Unit

Sets the DNS domain search path used on this link.

setHttpProxy

fun setHttpProxy(proxy: ProxyInfo?): Unit

Sets the recommended ProxyInfo to use on this link, or null for none. Note that Http Proxies are only a hint - the system recommends their use, but it does not enforce it and applications may ignore them.

setInterfaceName

fun setInterfaceName(iface: String?): Unit

Sets the interface name for this link. All RouteInfo already set for this will have their interface changed to match this new value.

setLinkAddresses

fun setLinkAddresses(addresses: MutableCollection<LinkAddress!>): Unit

Replaces the LinkAddress in this LinkProperties with the given Collection of LinkAddress.

setMtu

fun setMtu(mtu: Int): Unit

Sets the Maximum Transmission Unit size to use on this link. This should not be used unless the system default (1500) is incorrect. Values less than 68 or greater than 10000 will be ignored.

setNat64Prefix

fun setNat64Prefix(prefix: IpPrefix?): Unit

Sets the NAT64 prefix in use on this link. Currently, only 96-bit prefixes (i.e., where the 32-bit IPv4 address is at the end of the 128-bit IPv6 address) are supported or null for no prefix.

toString

fun toString(): String

writeToParcel

fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

Implement the Parcelable interface.

CREATOR

static val CREATOR: Parcelable.Creator<LinkProperties!>

Implement the Parcelable interface.