AwareDataPathRequest
class AwareDataPathRequest : Parcelable
| kotlin.Any | |
| ↳ | android.net.wifi.aware.AwareDataPathRequest |
A request to set up a data path for a Wi-Fi Aware network. This is used to set up a data path with a peer device. This is used for PublishDiscoverySession.acceptDataPathRequest(PeerHandle,AwareDataPathRequest) and SubscribeDiscoverySession.initiateDataPathRequest(PeerHandle,AwareDataPathRequest)
Summary
| Nested classes | |
|---|---|
|
A builder class for a Wi-Fi Aware data path request to set up a data path with a peer device. |
|
| Constants | |
|---|---|
| static Int |
The reason for the data path connection failure, when the data path connection fails due to internal failure. |
| static Int |
The reason for the data path connection failure, when device doesn't have enough data path resources or data interfaces. |
| static Int |
The reason for the data path connection failure, when the peer is not found. |
| static Int |
The reason for the data path connection failure, when the peer rejects the data path connection request. |
| static Int |
The reason for the data path connection failure, when the data path connection times out. |
| 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. |
| WifiAwareDataPathSecurityConfig? |
Get the security config specified in this Network Specifier to encrypt Wi-Fi Aware data-path |
| Int |
getPort()Get the port number which will be used to create a connection over this link. |
| Int |
Get the transport protocol which will be used to create a connection over this link. |
| Int |
hashCode()Returns a hash code value for the object. |
| 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<AwareDataPathRequest!> | |
Constants
DATA_PATH_CONNECTION_FAILURE_REASON_INTERNAL_FAILURE
static val DATA_PATH_CONNECTION_FAILURE_REASON_INTERNAL_FAILURE: Int
The reason for the data path connection failure, when the data path connection fails due to internal failure. This can be caused by the framework or the firmware issues.
Value: 5DATA_PATH_CONNECTION_FAILURE_REASON_NO_RESOURCE
static val DATA_PATH_CONNECTION_FAILURE_REASON_NO_RESOURCE: Int
The reason for the data path connection failure, when device doesn't have enough data path resources or data interfaces.
Value: 1DATA_PATH_CONNECTION_FAILURE_REASON_PEER_NOT_FOUND
static val DATA_PATH_CONNECTION_FAILURE_REASON_PEER_NOT_FOUND: Int
The reason for the data path connection failure, when the peer is not found.
Value: 2DATA_PATH_CONNECTION_FAILURE_REASON_REJECT_BY_PEER
static val DATA_PATH_CONNECTION_FAILURE_REASON_REJECT_BY_PEER: Int
The reason for the data path connection failure, when the peer rejects the data path connection request.
Value: 3DATA_PATH_CONNECTION_FAILURE_REASON_TIME_OUT
static val DATA_PATH_CONNECTION_FAILURE_REASON_TIME_OUT: Int
The reason for the data path connection failure, when the data path connection times out. Peer doesn't respond to the data path connection request within the timeout period.
Value: 4Public 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(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. |
getDataPathSecurityConfig
fun getDataPathSecurityConfig(): WifiAwareDataPathSecurityConfig?
Get the security config specified in this Network Specifier to encrypt Wi-Fi Aware data-path
| Return | |
|---|---|
WifiAwareDataPathSecurityConfig? |
WifiAwareDataPathSecurityConfig used to encrypt the data-path. This value may be null. |
getPort
fun getPort(): Int
Get the port number which will be used to create a connection over this link.
| Return | |
|---|---|
Int |
The port number. A value of 0 indicates that no port was specified. Value is between 0 and 65535 inclusive |
getTransportProtocol
fun getTransportProtocol(): Int
Get the transport protocol which will be used to create a connection over this link.
| Return | |
|---|---|
Int |
The transport protocol. A value of -1 indicates that no transport protocol was specified. Value is between -1 and 255 inclusive |
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. |
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:
|