Summary: Nested Classes | Constants | Inherited Constants | Fields | Methods | Inherited Methods

AwareDataPathRequest

---

Kotlin |Java

public final class AwareDataPathRequest
extends Object implements Parcelable

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

Constants
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.
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.
int	DATA_PATH_CONNECTION_FAILURE_REASON_PEER_NOT_FOUND The reason for the data path connection failure, when the peer is not found.
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.
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 interface android.os.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(Parcel, int): 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)".

Fields
public static final Creator<AwareDataPathRequest>	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.
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() Returns a hash code value for the object.
String	toString() Returns a string representation of the object.
void	writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

Inherited methods
From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
From interface android.os.Parcelable abstract int describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. abstract void writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

Constants

DATA_PATH_CONNECTION_FAILURE_REASON_INTERNAL_FAILURE

public static final 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. This can be caused by the framework or the firmware issues.

Constant Value: 5 (0x00000005)

DATA_PATH_CONNECTION_FAILURE_REASON_NO_RESOURCE

public static final 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.

Constant Value: 1 (0x00000001)

DATA_PATH_CONNECTION_FAILURE_REASON_PEER_NOT_FOUND

public static final int DATA_PATH_CONNECTION_FAILURE_REASON_PEER_NOT_FOUND

The reason for the data path connection failure, when the peer is not found.

Constant Value: 2 (0x00000002)

DATA_PATH_CONNECTION_FAILURE_REASON_REJECT_BY_PEER

public static final 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.

Constant Value: 3 (0x00000003)

DATA_PATH_CONNECTION_FAILURE_REASON_TIME_OUT

public static final int DATA_PATH_CONNECTION_FAILURE_REASON_TIME_OUT

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.

Constant Value: 4 (0x00000004)

Fields

CREATOR

public static final Creator<AwareDataPathRequest> CREATOR

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(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 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
o	Object: This value may be null.

Returns
boolean	true if this object is the same as the obj argument; false otherwise.

getDataPathSecurityConfig

public WifiAwareDataPathSecurityConfig getDataPathSecurityConfig ()

Get the security config specified in this Network Specifier to encrypt Wi-Fi Aware data-path

Returns
WifiAwareDataPathSecurityConfig	WifiAwareDataPathSecurityConfig used to encrypt the data-path. This value may be null.

getPort

public int getPort ()

Get the port number which will be used to create a connection over this link.

Returns
int	The port number. A value of 0 indicates that no port was specified. Value is between 0 and 65535 inclusive

See also:

• AwareDataPathRequest.Builder.setPort(int)

getTransportProtocol

public int getTransportProtocol ()

Get the transport protocol which will be used to create a connection over this link.

Returns
int	The transport protocol. A value of -1 indicates that no transport protocol was specified. Value is between -1 and 255 inclusive

See also:

• AwareDataPathRequest.Builder.setTransportProtocol(int)

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 in equals 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 the hashCode 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 the hashCode 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.

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 the following: Parcelable.PARCELABLE_WRITE_RETURN_VALUE