ResponderConfig
public
final
class
ResponderConfig
extends Object
implements
Parcelable
java.lang.Object | |
↳ | 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 | |
---|---|
class |
ResponderConfig.Builder
Builder class used to construct |
Constants | |
---|---|
int |
RESPONDER_AP
Responder is an access point(AP). |
int |
RESPONDER_STA
Responder is a client device(STA). |
Inherited constants |
---|
Fields | |
---|---|
public
static
final
Creator<ResponderConfig> |
CREATOR
|
Public methods | |
---|---|
int
|
describeContents()
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
boolean
|
equals(Object o)
Indicates whether some other object is "equal to" this one. |
static
ResponderConfig
|
fromScanResult(ScanResult scanResult)
Creates a Responder configuration from a |
int
|
getCenterFreq0Mhz()
If the Access Point (AP) bandwidth is 20 MHz, 0 MHz is returned. |
int
|
getCenterFreq1Mhz()
If the Access Point (AP) bandwidth is 80 + 80 MHz, this param is not used and returns 0. |
int
|
getChannelWidth()
AP Channel bandwidth; one of |
int
|
getFrequencyMhz()
|
MacAddress
|
getMacAddress()
|
int
|
getPreamble()
Get the preamble type of the channel. |
int
|
getResponderType()
Get responder type. |
SecureRangingConfig
|
getSecureRangingConfig()
Get secure ranging configuration. |
int
|
hashCode()
Returns a hash code value for the object. |
boolean
|
is80211azNtbSupported()
|
boolean
|
is80211mcSupported()
|
String
|
toString()
Returns a string representation of the object. |
void
|
writeToParcel(Parcel dest, int flags)
Flatten this object in to a Parcel. |
Inherited methods | |
---|---|
Constants
RESPONDER_AP
public static final int RESPONDER_AP
Responder is an access point(AP).
Constant Value: 0 (0x00000000)
RESPONDER_STA
public static final int RESPONDER_STA
Responder is a client device(STA).
Constant Value: 1 (0x00000001)
Fields
Public methods
describeContents
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 |
equals
public boolean equals (Object o)
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
x
andy
,x.equals(y)
should returntrue
if and only ify.equals(x)
returnstrue
. - It is transitive: for any non-null reference values
x
,y
, andz
, ifx.equals(y)
returnstrue
andy.equals(z)
returnstrue
, thenx.equals(z)
should returntrue
. - It is consistent: for any non-null reference values
x
andy
, multiple invocations ofx.equals(y)
consistently returntrue
or consistently returnfalse
, provided no information used inequals
comparisons 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 | |
---|---|
o |
Object : This value may be null . |
Returns | |
---|---|
boolean |
true if this object is the same as the obj
argument; false otherwise. |
fromScanResult
public static ResponderConfig fromScanResult (ScanResult scanResult)
Creates a Responder configuration from a ScanResult
corresponding to an Access
Point (AP), which can be obtained from WifiManager.getScanResults()
.
Parameters | |
---|---|
scanResult |
ScanResult : This value cannot be null . |
Returns | |
---|---|
ResponderConfig |
This value cannot be null . |
getCenterFreq0Mhz
public int getCenterFreq0Mhz ()
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).
Returns | |
---|---|
int |
the center frequency in MHz of the first channel segment Value is 0 or greater |
getCenterFreq1Mhz
public int getCenterFreq1Mhz ()
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.
Returns | |
---|---|
int |
the center frequency in MHz of the second channel segment (if used) Value is 0 or greater |
getChannelWidth
public int getChannelWidth ()
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
.
Returns | |
---|---|
int |
the bandwidth repsentation of the Wi-Fi channel
Value is ScanResult.CHANNEL_WIDTH_20MHZ , ScanResult.CHANNEL_WIDTH_40MHZ , ScanResult.CHANNEL_WIDTH_80MHZ , ScanResult.CHANNEL_WIDTH_160MHZ , ScanResult.CHANNEL_WIDTH_80MHZ_PLUS_MHZ , or ScanResult.CHANNEL_WIDTH_320MHZ |
getFrequencyMhz
public int getFrequencyMhz ()
Returns | |
---|---|
int |
the frequency in MHz of the Wi-Fi channel Value is 0 or greater |
getMacAddress
public MacAddress getMacAddress ()
Returns | |
---|---|
MacAddress |
the MAC address of the responder
This value may be null . |
getPreamble
public int getPreamble ()
Get the preamble type of the channel.
Returns | |
---|---|
int |
the preamble used for this channel
Value is ScanResult.PREAMBLE_LEGACY , ScanResult.PREAMBLE_HT , ScanResult.PREAMBLE_VHT , ScanResult.PREAMBLE_HE , or ScanResult.PREAMBLE_EHT |
getResponderType
public int getResponderType ()
Get responder type.
Returns | |
---|---|
int |
The type of this responder
Value is RESPONDER_AP , RESPONDER_STA , android.net.wifi.rtt.ResponderConfig.RESPONDER_P2P_GO, android.net.wifi.rtt.ResponderConfig.RESPONDER_P2P_CLIENT, or android.net.wifi.rtt.ResponderConfig.RESPONDER_AWARE |
getSecureRangingConfig
public SecureRangingConfig getSecureRangingConfig ()
Get secure ranging configuration.
Returns | |
---|---|
SecureRangingConfig |
Secure ranging configuration. Returns null for non-secure ranging configuration. |
hashCode
public int hashCode ()
Returns a hash code value for the object. This method is
supported for the benefit of hash tables such as those provided by
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 inequals
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 thehashCode
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 thehashCode
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.
Returns | |
---|---|
int |
a hash code value for this object. |
is80211azNtbSupported
public boolean is80211azNtbSupported ()
Returns | |
---|---|
boolean |
true if the Responder supports the 802.11az non-trigger based ranging protocol, false otherwise. |
is80211mcSupported
public boolean is80211mcSupported ()
Returns | |
---|---|
boolean |
true if the Responder supports the 802.11mc protocol, false otherwise. |
toString
public String toString ()
Returns a string representation of the object.
Returns | |
---|---|
String |
a string representation of the object. |
writeToParcel
public void writeToParcel (Parcel dest, int flags)
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.PARCELABLE_WRITE_RETURN_VALUE .
Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE , and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2024-12-18 UTC.