Added in [API level 37](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Nested Classes](https://developer.android.com/reference/android/net/wifi/aware/AwareDataPathRequest#nestedclasses) \| [Constants](https://developer.android.com/reference/android/net/wifi/aware/AwareDataPathRequest#constants) \| [Inherited Constants](https://developer.android.com/reference/android/net/wifi/aware/AwareDataPathRequest#inhconstants) \| [Fields](https://developer.android.com/reference/android/net/wifi/aware/AwareDataPathRequest#lfields) \| [Methods](https://developer.android.com/reference/android/net/wifi/aware/AwareDataPathRequest#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/net/wifi/aware/AwareDataPathRequest#inhmethods)

# AwareDataPathRequest

*** ** * ** ***


`
public

final

class
AwareDataPathRequest
`


`

extends https://developer.android.com/reference/java/lang/Object


`

`


implements

https://developer.android.com/reference/android/os/Parcelable


`

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.net.wifi.aware.AwareDataPathRequest |

<br />

*** ** * ** ***

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
`https://developer.android.com/reference/android/net/wifi/aware/PublishDiscoverySession#acceptDataPathRequest(android.net.wifi.aware.PeerHandle,%20android.net.wifi.aware.AwareDataPathRequest)`
and `https://developer.android.com/reference/android/net/wifi/aware/SubscribeDiscoverySession#initiateDataPathRequest(android.net.wifi.aware.PeerHandle,%20android.net.wifi.aware.AwareDataPathRequest)`

## Summary

| ### Nested classes ||
|---|---|
| ` class` | `https://developer.android.com/reference/android/net/wifi/aware/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` | `https://developer.android.com/reference/android/net/wifi/aware/AwareDataPathRequest#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` | `https://developer.android.com/reference/android/net/wifi/aware/AwareDataPathRequest#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` | `https://developer.android.com/reference/android/net/wifi/aware/AwareDataPathRequest#DATA_PATH_CONNECTION_FAILURE_REASON_PEER_NOT_FOUND` The reason for the data path connection failure, when the peer is not found. |
| `int` | `https://developer.android.com/reference/android/net/wifi/aware/AwareDataPathRequest#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` | `https://developer.android.com/reference/android/net/wifi/aware/AwareDataPathRequest#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 `https://developer.android.com/reference/android/os/Parcelable` |---|---| | `int` | `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `https://developer.android.com/reference/android/os/Parcelable#describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor. | | `int` | `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`: 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 https://developer.android.com/reference/android/os/Parcelable.Creator<https://developer.android.com/reference/android/net/wifi/aware/AwareDataPathRequest>` | `https://developer.android.com/reference/android/net/wifi/aware/AwareDataPathRequest#CREATOR` |

| ### Public methods ||
|---|---|
| ` int` | ` https://developer.android.com/reference/android/net/wifi/aware/AwareDataPathRequest#describeContents()() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| ` boolean` | ` https://developer.android.com/reference/android/net/wifi/aware/AwareDataPathRequest#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object o) ` Indicates whether some other object is "equal to" this one. |
| ` https://developer.android.com/reference/android/net/wifi/aware/WifiAwareDataPathSecurityConfig` | ` https://developer.android.com/reference/android/net/wifi/aware/AwareDataPathRequest#getDataPathSecurityConfig()() ` Get the security config specified in this Network Specifier to encrypt Wi-Fi Aware data-path |
| ` int` | ` https://developer.android.com/reference/android/net/wifi/aware/AwareDataPathRequest#getPort()() ` Get the port number which will be used to create a connection over this link. |
| ` int` | ` https://developer.android.com/reference/android/net/wifi/aware/AwareDataPathRequest#getTransportProtocol()() ` Get the transport protocol which will be used to create a connection over this link. |
| ` int` | ` https://developer.android.com/reference/android/net/wifi/aware/AwareDataPathRequest#hashCode()() ` Returns a hash code value for the object. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/net/wifi/aware/AwareDataPathRequest#toString()() ` Returns a string representation of the object. |
| ` void` | ` https://developer.android.com/reference/android/net/wifi/aware/AwareDataPathRequest#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) ` Flatten this object in to a Parcel. |

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

## Constants

### DATA_PATH_CONNECTION_FAILURE_REASON_INTERNAL_FAILURE

Added in [API level 37](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

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

<br />

Constant Value:

5
(0x00000005)


### DATA_PATH_CONNECTION_FAILURE_REASON_NO_RESOURCE

Added in [API level 37](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

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

<br />

Constant Value:

1
(0x00000001)


### DATA_PATH_CONNECTION_FAILURE_REASON_PEER_NOT_FOUND

Added in [API level 37](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

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

<br />

Constant Value:

2
(0x00000002)


### DATA_PATH_CONNECTION_FAILURE_REASON_REJECT_BY_PEER

Added in [API level 37](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

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

<br />

Constant Value:

3
(0x00000003)


### DATA_PATH_CONNECTION_FAILURE_REASON_TIME_OUT

Added in [API level 37](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

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

<br />

Constant Value:

4
(0x00000004)


## Fields

### CREATOR

Added in [API level 37](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Creator<AwareDataPathRequest> CREATOR
```

<br />

<br />

## Public methods

### describeContents

Added in [API level 37](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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 `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`,
the return value of this method must include the
`https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` bit.

<br />

| Returns ||
|---|---|
| `int` | a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or - `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` |

### equals

Added in [API level 37](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

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

<br />

| Parameters ||
|---|---|
| `o` | `Object`: This value may be `null`. <br /> |

| Returns ||
|---|---|
| `boolean` | `true` if this object is the same as the obj argument; `false` otherwise. <br /> |

### getDataPathSecurityConfig

Added in [API level 37](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public WifiAwareDataPathSecurityConfig getDataPathSecurityConfig ()
```

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

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/net/wifi/aware/WifiAwareDataPathSecurityConfig` | `https://developer.android.com/reference/android/net/wifi/aware/WifiAwareDataPathSecurityConfig` used to encrypt the data-path. This value may be `null`. <br /> |

### getPort

Added in [API level 37](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getPort ()
```

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

<br />

| Returns ||
|---|---|
| `int` | The port number. A value of 0 indicates that no port was specified. Value is between 0 and 65535 inclusive <br /> |

**See also:**

- `https://developer.android.com/reference/android/net/wifi/aware/AwareDataPathRequest.Builder#setPort(int)`

### getTransportProtocol

Added in [API level 37](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getTransportProtocol ()
```

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

<br />

| Returns ||
|---|---|
| `int` | The transport protocol. A value of -1 indicates that no transport protocol was specified. Value is between -1 and 255 inclusive <br /> |

**See also:**

- `https://developer.android.com/reference/android/net/wifi/aware/AwareDataPathRequest.Builder#setTransportProtocol(int)`

### hashCode

Added in [API level 37](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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
`https://developer.android.com/reference/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 `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 `https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)` 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 `https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)` 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.

<br />

<br />

| Returns ||
|---|---|
| `int` | a hash code value for this object. <br /> |

### toString

Added in [API level 37](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String toString ()
```

Returns a string representation of the object.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | a string representation of the object. <br /> |

### writeToParcel

Added in [API level 37](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void writeToParcel (Parcel dest, 
                int flags)
```

Flatten this object in to a Parcel.

<br />

| Parameters ||
|---|---|
| `dest` | `Parcel`: This value cannot be `null`. <br /> |
| `flags` | `int`: Additional flags about how the object should be written. May be 0 or `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: - `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE` |