ResponderConfig
class ResponderConfig : Parcelable
| kotlin.Any | |
| ↳ | android.net.wifi.rtt.ResponderConfig |
Defines the configuration of an IEEE 802.11mc Responder. The Responder may be an Access Point (AP), a Wi-Fi Aware device, or a manually configured Responder.
A Responder configuration may be constructed from a ScanResult or manually (with the data obtained out-of-band from a peer).
Summary
| Nested classes | |
|---|---|
|
Builder class used to construct |
|
| Constants | |
|---|---|
| static Int |
Responder is an access point(AP). |
| static Int |
Responder is a client device(STA). |
| Inherited constants | |
|---|---|
| Public methods | |
|---|---|
| Int |
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| Boolean |
Indicates whether some other object is "equal to" this one. |
| static ResponderConfig |
fromScanResult(scanResult: ScanResult)Creates a Responder configuration from a |
| Int |
If the Access Point (AP) bandwidth is 20 MHz, 0 MHz is returned. |
| Int |
If the Access Point (AP) bandwidth is 80 + 80 MHz, this param is not used and returns 0. |
| Int |
AP Channel bandwidth; one of |
| Int | |
| MacAddress? | |
| PeerHandle? |
Returns the Wi-Fi Aware peer identifier of the responder. |
| Int |
Get the preamble type of the channel. |
| Int |
Get responder type. |
| SecureRangingConfig? |
Get secure ranging configuration. |
| Int |
Returns the USD peer identifier of the responder. |
| Int |
hashCode()Returns a hash code value for the object. |
| Boolean | |
| Boolean | |
| 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<ResponderConfig!> | |
Constants
RESPONDER_AP
static val RESPONDER_AP: Int
Responder is an access point(AP).
Value: 0RESPONDER_STA
static val RESPONDER_STA: Int
Responder is a client device(STA).
Value: 1Public methods
describeContents
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(android.os.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
|
equals
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 returntrue. - It is symmetric: for any non-null reference values
xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any non-null reference values
x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue. - It is consistent: for any non-null reference values
xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified. - For any non-null reference value
x,x.equals(null)should returnfalse.
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. |
fromScanResult
static fun fromScanResult(scanResult: ScanResult): ResponderConfig
Creates a Responder configuration from a ScanResult corresponding to an Access Point (AP), which can be obtained from android.net.wifi.WifiManager#getScanResults().
| Parameters | |
|---|---|
scanResult |
ScanResult: This value cannot be null. |
| Return | |
|---|---|
ResponderConfig |
This value cannot be null. |
getCenterFreq0Mhz
fun getCenterFreq0Mhz(): Int
If the Access Point (AP) bandwidth is 20 MHz, 0 MHz is returned. If the AP use 40, 80 or 160 MHz, this is the center frequency (in MHz). if the AP uses 80 + 80 MHz, this is the center frequency of the first segment (in MHz).
| Return | |
|---|---|
Int |
the center frequency in MHz of the first channel segment. Value is 0 or greater |
getCenterFreq1Mhz
fun getCenterFreq1Mhz(): Int
If the Access Point (AP) bandwidth is 80 + 80 MHz, this param is not used and returns 0. If the AP uses 80 + 80 MHz, this is the center frequency of the second segment in MHz.
| Return | |
|---|---|
Int |
the center frequency in MHz of the second channel segment (if used). Value is 0 or greater |
getChannelWidth
fun getChannelWidth(): Int
AP Channel bandwidth; one of ScanResult.CHANNEL_WIDTH_20MHZ, ScanResult.CHANNEL_WIDTH_40MHZ, ScanResult.CHANNEL_WIDTH_80MHZ, ScanResult.CHANNEL_WIDTH_160MHZ, CHANNEL_WIDTH_80MHZ_PLUS_MHZ or ScanResult.CHANNEL_WIDTH_320MHZ.
| Return | |
|---|---|
Int |
the bandwidth repsentation of the Wi-Fi channel. Value is one of the following: |
getFrequencyMhz
fun getFrequencyMhz(): Int
| Return | |
|---|---|
Int |
the frequency in MHz of the Wi-Fi channel. Value is 0 or greater |
getMacAddress
fun getMacAddress(): MacAddress?
| Return | |
|---|---|
MacAddress? |
the MAC address of the responder. This value may be null. |
getPeerHandle
fun getPeerHandle(): PeerHandle?
Returns the Wi-Fi Aware peer identifier of the responder.
This value is non-null if the responder is a Wi-Fi Aware peer and was configured using a PeerHandle (via ResponderConfig.Builder.setPeerHandle(PeerHandle)). The PeerHandle is an opaque identifier for a specific Aware peer discovered during Wi-Fi Aware operations, such as service discovery.
If the responder is not an Aware peer, or if it was configured using its MAC address (via ResponderConfig.Builder.setMacAddress(MacAddress)), this method will return null.
Only one of getPeerHandle() or getMacAddress() will return a non-null value for a valid ResponderConfig.
| Return | |
|---|---|
PeerHandle? |
The PeerHandle of the Wi-Fi Aware responder, or null if the responder is not an Aware peer or is identified by its MAC address. |
getPreamble
fun getPreamble(): Int
Get the preamble type of the channel.
| Return | |
|---|---|
Int |
the preamble used for this channel. Value is one of the following: |
getResponderType
fun getResponderType(): Int
Get responder type.
| Return | |
|---|---|
Int |
The type of this responder. Value is one of the following: |
getSecureRangingConfig
fun getSecureRangingConfig(): SecureRangingConfig?
Get secure ranging configuration.
| Return | |
|---|---|
SecureRangingConfig? |
Secure ranging configuration. Returns null for non-secure ranging configuration. |
getUsdPeerId
fun getUsdPeerId(): Int
Returns the USD peer identifier of the responder.
This value is non-negative if the responder is a USD peer and was configured using a peer ID (via ResponderConfig.Builder.setUsdPeerId(int)). The peer ID is an opaque identifier for a specific USD peer discovered during USD discovery operations.
| Return | |
|---|---|
Int |
The peer ID of the USD responder, or -1 if not set. |
hashCode
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
hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons 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
equalsmethod, then calling thehashCodemethod 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
equalsmethod, then calling thehashCodemethod 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. |
is80211azNtbSupported
fun is80211azNtbSupported(): Boolean
| Return | |
|---|---|
Boolean |
true if the Responder supports the 802.11az non-trigger based ranging protocol, false otherwise. |
is80211mcSupported
fun is80211mcSupported(): Boolean
| Return | |
|---|---|
Boolean |
true if the Responder supports the 802.11mc protocol, false otherwise. |
toString
fun toString(): String
Returns a string representation of the object.
| Return | |
|---|---|
String |
a string representation of the object. |
writeToParcel
fun writeToParcel(
dest: Parcel,
flags: Int
): Unit
Flatten this object in to a Parcel.
| 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 the following:
|