WifiAwareNetworkInfo

Kotlin |Java

class WifiAwareNetworkInfo : Parcelable, TransportInfo

kotlin.Any
↳	android.net.wifi.aware.WifiAwareNetworkInfo

Wi-Fi Aware-specific network information. The information can be extracted from the android.net.NetworkCapabilities of the network using NetworkCapabilities.getTransportInfo(). The NetworkCapabilities is provided by the connectivity service to apps, e.g. received through the android.net.ConnectivityManager.NetworkCallback#onCapabilitiesChanged(android.net.Network,android.net.NetworkCapabilities) callback.

The Wi-Fi Aware-specific network information include the peer's scoped link-local IPv6 address for the Wi-Fi Aware link, as well as (optionally) the port and transport protocol specified by the peer. The scoped link-local IPv6, port, and transport protocol can then be used to create a java.net.Socket connection to the peer.

Note: these are the peer's IPv6 and port information - not the local device's!

Summary

Inherited constants

From class Parcelable

Int

CONTENTS_FILE_DESCRIPTOR

Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor.

Int

PARCELABLE_WRITE_RETURN_VALUE

Flag for use with writeToParcel: the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point.

Public methods
Int	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
Boolean	`equals(other: Any?)` Indicates whether some other object is "equal to" this one.
MutableList<WifiAwareChannelInfo!>	`getChannelInfoList()` Get a list `WifiAwareChannelInfo` which is used by this Aware data-path
Inet6Address?	`getPeerIpv6Addr()` Get the scoped link-local IPv6 address of the Wi-Fi Aware peer (not of the local device!).
Int	`getPort()` Get the port number to be used to create a network connection to the Wi-Fi Aware peer.
Int	`getTransportProtocol()` Get the transport protocol to be used to communicate over a network connection to the Wi-Fi Aware peer.
Int	`hashCode()` Returns a hash code value for the object.
String	`toString()` Returns a string representation of the object.
Unit	`writeToParcel(dest: Parcel, flags: Int)` Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<WifiAwareNetworkInfo!>	`CREATOR`

Public methods

describeContents

Added in API level 29

fun describeContents(): Int

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Return
`Int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `CONTENTS_FILE_DESCRIPTOR`

equals

Added in API level 29

fun equals(other: Any?): Boolean

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
`obj`	the reference object with which to compare.

Return
`Boolean`	`true` if this object is the same as the obj argument; `false` otherwise.

getChannelInfoList

Added in API level 33

fun getChannelInfoList(): MutableList<WifiAwareChannelInfo!>

Get a list WifiAwareChannelInfo which is used by this Aware data-path

Return
`MutableList<WifiAwareChannelInfo!>`	A list of `WifiAwareChannelInfo` This value cannot be `null`.

getPeerIpv6Addr

Added in API level 29

fun getPeerIpv6Addr(): Inet6Address?

Get the scoped link-local IPv6 address of the Wi-Fi Aware peer (not of the local device!).

Return
`Inet6Address?`	An IPv6 address. This value may be `null`.

getPort

Added in API level 29

fun getPort(): Int

Get the port number to be used to create a network connection to the Wi-Fi Aware peer. The port information is provided by the app running on the peer which requested the connection, using the WifiAwareNetworkSpecifier.Builder.setPort(int).

Return
`Int`	A port number on the peer. A value of 0 indicates that no port was specified by the peer.

getTransportProtocol

Added in API level 29

fun getTransportProtocol(): Int

Get the transport protocol to be used to communicate over a network connection to the Wi-Fi Aware peer. The transport protocol is provided by the app running on the peer which requested the connection, using the WifiAwareNetworkSpecifier.Builder.setTransportProtocol(int).

The transport protocol number is assigned by the Internet Assigned Numbers Authority (IANA) https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml.

Return
`Int`	A transport protocol id. A value of -1 indicates that no transport protocol was specified by the peer.

hashCode

Added in API level 29

fun hashCode(): Int

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Return
`Int`	a hash code value for this object.

toString

Added in API level 29

fun toString(): String

Returns a string representation of the object.

Return
`String`	a string representation of the object.

writeToParcel

Added in API level 29

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

Flatten this object in to a Parcel.

Parameters
`dest`	Parcel: The Parcel in which the object should be written. This value cannot be `null`.
`flags`	Int: Additional flags about how the object should be written. May be 0 or `PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: `PARCELABLE_WRITE_RETURN_VALUE`

Properties

CREATOR

Added in API level 29

static val CREATOR: Parcelable.Creator<WifiAwareNetworkInfo!>