RangingRequest
class RangingRequest : Parcelable
kotlin.Any | |
↳ | android.net.wifi.rtt.RangingRequest |
Defines the ranging request to other devices. The ranging request is built using RangingRequest.Builder
. A ranging request is executed using WifiRttManager#startRanging(RangingRequest, java.util.concurrent.Executor, RangingResultCallback)
.
The ranging request is a batch request - specifying a set of devices (specified using RangingRequest.Builder#addAccessPoint(ScanResult)
and RangingRequest.Builder#addAccessPoints(List)
).
Summary
Nested classes | |
---|---|
Builder class used to construct |
Inherited constants | |
---|---|
Public methods | |
---|---|
Int | |
Boolean |
Indicates whether some other object is "equal to" this one. |
static Int |
Returns the default RTT burst size used to determine the average range. |
static Int |
Returns the maximum number of peers to range which can be specified in a single |
static Int |
Returns the minimum RTT burst size that can be used to determine a average range. |
static Int |
Returns the minimum RTT burst size that can be used to determine a average range. |
Int |
Returns the RTT burst size used to determine the average range. |
Int |
hashCode() |
Unit |
writeToParcel(dest: Parcel, flags: Int) |
Properties | |
---|---|
static Parcelable.Creator<RangingRequest!> |
Public methods
describeContents
fun describeContents(): Int
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
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
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 | |
---|---|
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. |
getDefaultRttBurstSize
static fun getDefaultRttBurstSize(): Int
Returns the default RTT burst size used to determine the average range.
Return | |
---|---|
Int |
the RTT burst size used by default |
getMaxPeers
static fun getMaxPeers(): Int
Returns the maximum number of peers to range which can be specified in a single RangingRequest
. The limit applies no matter how the peers are added to the request, e.g. through RangingRequest.Builder#addAccessPoint(ScanResult)
or RangingRequest.Builder#addAccessPoints(List)
.
Return | |
---|---|
Int |
Maximum number of peers. |
getMaxRttBurstSize
static fun getMaxRttBurstSize(): Int
Returns the minimum RTT burst size that can be used to determine a average range.
Return | |
---|---|
Int |
the maximum RTT burst size that can be used |
getMinRttBurstSize
static fun getMinRttBurstSize(): Int
Returns the minimum RTT burst size that can be used to determine a average range.
Return | |
---|---|
Int |
the minimum RTT burst size that can be used |
getRttBurstSize
fun getRttBurstSize(): Int
Returns the RTT burst size used to determine the average range.
Return | |
---|---|
Int |
the RTT burst size used |
writeToParcel
fun writeToParcel(
dest: Parcel,
flags: Int
): Unit
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 android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE , and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES |