WifiAwareNetworkInfo

public final class WifiAwareNetworkInfo
extends Object implements TransportInfo, Parcelable

java.lang.Object
   ↳ android.net.wifi.aware.WifiAwareNetworkInfo


Wi-Fi Aware-specific network information. The information can be extracted from the NetworkCapabilities of the network using NetworkCapabilities#getTransportInfo(). The NetworkCapabilities is provided by the connectivity service to apps, e.g. received through the 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 Socket connection to the peer.

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

Summary

Inherited constants

Fields

public static final Creator<WifiAwareNetworkInfo> CREATOR

Public methods

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

List<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.

String toString()

Returns a string representation of the object.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Fields

CREATOR

Added in API level 29
public static final Creator<WifiAwareNetworkInfo> CREATOR

Public methods

describeContents

Added in API level 29
public int describeContents ()

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(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

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

getChannelInfoList

Added in API level 33
public List<WifiAwareChannelInfo> getChannelInfoList ()

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

Returns
List<WifiAwareChannelInfo> A list of WifiAwareChannelInfo This value cannot be null.

getPeerIpv6Addr

Added in API level 29
public Inet6Address getPeerIpv6Addr ()

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

Returns
Inet6Address An IPv6 address. This value may be null.

getPort

Added in API level 29
public int getPort ()

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).

Returns
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
public int getTransportProtocol ()

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.

Returns
int A transport protocol id. A value of -1 indicates that no transport protocol was specified by the peer.

toString

Added in API level 29
public String toString ()

Returns a string representation of the object.

Returns
String a string representation of the object.

writeToParcel

Added in API level 29
public void writeToParcel (Parcel dest, 
                int flags)

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.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES