Added in API level 33

MloLink

class MloLink : Parcelable
kotlin.Any
   ↳ android.net.wifi.MloLink

Data structure class representing a Wi-Fi Multi-Link Operation (MLO) link This is only used by 802.11be capable devices

Summary

Constants
static Int

Invalid link id.

static Int

MLO link state: Link is associated to the access point and mapped to at least one traffic stream.

static Int

MLO link state: Link is associated to the access point but not mapped to any traffic stream.

static Int

MLO link state: Invalid link state.

static Int

MLO link state: Link is not associated with the access point.

Inherited constants
Public constructors

Constructor for a MloLInk.

Public methods
Int

Implement the Parcelable interface

Boolean
equals(other: Any?)

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

MacAddress?

Returns the AP MAC address of this link.

Int

Returns the Wi-Fi band of this link.

Int

Returns the channel number of this link.

Int

Returns the link id of this link.

Int

Returns the RSSI of the link.

Int

Returns the current receive link speed in Mbps.

MacAddress?

Returns the STA MAC address of this link.

Int

Returns the state of this link as one of: MLO_LINK_STATE_INVALID MLO_LINK_STATE_UNASSOCIATED MLO_LINK_STATE_IDLE MLO_LINK_STATE_ACTIVE

Int

Returns the current transmit link speed in Mbps.

Int

String

Unit
writeToParcel(dest: Parcel, flags: Int)

Implement the Parcelable interface

Properties
static Parcelable.Creator<MloLink!>

Implement the Parcelable interface

Constants

Added in API level 33
static val INVALID_MLO_LINK_ID: Int

Invalid link id. Used in {link #getLinkId()}

Value: -1
Added in API level 33
static val MLO_LINK_STATE_ACTIVE: Int

MLO link state: Link is associated to the access point and mapped to at least one traffic stream. {link #getState()} Note that an MLO link could be in that state but in power save mode.

Value: 3
Added in API level 33
static val MLO_LINK_STATE_IDLE: Int

MLO link state: Link is associated to the access point but not mapped to any traffic stream. Used in {link #getState()}

Value: 2
Added in API level 33
static val MLO_LINK_STATE_INVALID: Int

MLO link state: Invalid link state. Used in {link #getState()}

Value: 0
Added in API level 33
static val MLO_LINK_STATE_UNASSOCIATED: Int

MLO link state: Link is not associated with the access point. Used in {link #getState()}

Value: 1

Public constructors

Added in API level 33
MloLink()

Constructor for a MloLInk.

Public methods

describeContents

Added in API level 33
fun describeContents(): Int

Implement the Parcelable interface

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

equals

Added in API level 33
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.
o This value may be null.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

getApMacAddress

Added in API level 33
fun getApMacAddress(): MacAddress?

Returns the AP MAC address of this link.

Return
MacAddress? AP MAC address for this link or null when the caller has insufficient permissions to access the access point MAC Address.

getChannel

Added in API level 33
fun getChannel(): Int

Returns the channel number of this link. A valid value is based on the 802.11 specification in sections 19.3.15 and 27.3.23

Return
Int Value is 1 or greater

getLinkId

Added in API level 33
fun getLinkId(): Int

Returns the link id of this link. Valid values are 0-15, as described in IEEE 802.11be Specification, section 9.4.2.295b.2.

Return
Int INVALID_MLO_LINK_ID or a valid value (0-15). Value is between INVALID_MLO_LINK_ID and MAX_MLO_LINK_ID inclusive

getRssi

Added in API level 34
fun getRssi(): Int

Returns the RSSI of the link.

Use android.net.wifi.WifiManager#calculateSignalLevel to convert this number into an absolute signal level which can be displayed to a user.

Return
Int RSSI in dBM.

getRxLinkSpeedMbps

Added in API level 34
fun getRxLinkSpeedMbps(): Int

Returns the current receive link speed in Mbps.

Return
Int the Rx link speed or WifiInfo#LINK_SPEED_UNKNOWN if link speed is unknown. Value is -1 or greater

getStaMacAddress

Added in API level 33
fun getStaMacAddress(): MacAddress?

Returns the STA MAC address of this link.

Return
MacAddress? STA MAC address assigned for this link, or null in the following cases:
  • The caller has insufficient permissions to access the STA MAC Address
  • Link is not associated, hence no MAC address is assigned to it by STA

getTxLinkSpeedMbps

Added in API level 34
fun getTxLinkSpeedMbps(): Int

Returns the current transmit link speed in Mbps.

Return
Int the Tx link speed or WifiInfo#LINK_SPEED_UNKNOWN if link speed is unknown. Value is -1 or greater

hashCode

Added in API level 33
fun hashCode(): Int
Return
Int a hash code value for this object.

toString

Added in API level 33
fun toString(): String
Return
String a string representation of the object.

writeToParcel

Added in API level 33
fun writeToParcel(
    dest: Parcel,
    flags: Int
): Unit

Implement the Parcelable interface

Parameters
dest Parcel: 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 android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 33
static val CREATOR: Parcelable.Creator<MloLink!>

Implement the Parcelable interface