Added in API level 26

PeerHandle

open class PeerHandle
kotlin.Any
   ↳ android.net.wifi.aware.PeerHandle

Opaque object used to represent a Wi-Fi Aware peer. Obtained from discovery sessions in DiscoverySessionCallback.onServiceDiscovered(PeerHandle, byte[], java.util.List) or received messages in DiscoverySessionCallback.onMessageReceived(PeerHandle, byte[]), and used when sending messages e,g, DiscoverySession.sendMessage(PeerHandle, int, byte[]), or when configuring a network link to a peer, e.g. DiscoverySession.createNetworkSpecifierOpen(PeerHandle) or DiscoverySession.createNetworkSpecifierPassphrase(PeerHandle, String).

Note that while a PeerHandle can be used to track a particular peer (i.e. you can compare the values received from subsequent messages) - it is good practice not to rely on it. Instead use an application level peer identifier encoded in the message, DiscoverySession.sendMessage(PeerHandle, int, byte[]), and/or in the Publish configuration's service-specific information field, PublishConfig.Builder.setServiceSpecificInfo(byte[]), or match filter, PublishConfig.Builder.setMatchFilter(java.util.List).

A parcelable handle object is available with ParcelablePeerHandle.

Summary

Public methods
open Boolean
equals(other: Any?)

Indicates whether some other object is "equal to" this one.
open Int

Returns a hash code value for the object.

Public methods

equals

Added in API level 26
open 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.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

hashCode

Added in API level 26
open 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 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.
Return
Int a hash code value for this object.