AwareDataPathRequest

---

Kotlin |Java

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
	Builder A builder class for a Wi-Fi Aware data path request to set up a data path with a peer device.

Constants
static Int	DATA_PATH_CONNECTION_FAILURE_REASON_INTERNAL_FAILURE The reason for the data path connection failure, when the data path connection fails due to internal failure.
static Int	DATA_PATH_CONNECTION_FAILURE_REASON_NO_RESOURCE The reason for the data path connection failure, when device doesn't have enough data path resources or data interfaces.
static Int	DATA_PATH_CONNECTION_FAILURE_REASON_PEER_NOT_FOUND The reason for the data path connection failure, when the peer is not found.
static Int	DATA_PATH_CONNECTION_FAILURE_REASON_REJECT_BY_PEER The reason for the data path connection failure, when the peer rejects the data path connection request.
static Int	DATA_PATH_CONNECTION_FAILURE_REASON_TIME_OUT The reason for the data path connection failure, when the data path connection times out.

Inherited constants

From class Parcelable Int CONTENTS_FILE_DESCRIPTOR Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. Int PARCELABLE_WRITE_RETURN_VALUE Flag for use with writeToParcel: the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point.

Public methods
Int	describeContents()
Boolean	equals(other: Any?) Indicates whether some other object is "equal to" this one.
WifiAwareDataPathSecurityConfig?	getDataPathSecurityConfig() 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	getTransportProtocol() Get the transport protocol which will be used to create a connection over this link.
Int	hashCode()
String	toString()
Unit	writeToParcel(dest: Parcel, flags: Int) Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<AwareDataPathRequest!>	CREATOR

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: 5

DATA_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: 1

DATA_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: 2

DATA_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: 3

DATA_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: 4

Public methods

describeContents

fun describeContents(): Int

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 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.

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

See Also

• android.net.wifi.aware.AwareDataPathRequest.Builder#setPort(int)

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

See Also

• android.net.wifi.aware.AwareDataPathRequest.Builder#setTransportProtocol(int)

hashCode

fun hashCode(): Int

toString

fun toString(): String

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: PARCELABLE_WRITE_RETURN_VALUE

Properties

CREATOR

static val CREATOR: Parcelable.Creator<AwareDataPathRequest!>