SubscribeDiscoverySession

Kotlin |Java

public class SubscribeDiscoverySession
extends DiscoverySession

java.lang.Object
↳	android.net.wifi.aware.DiscoverySession
	↳	android.net.wifi.aware.SubscribeDiscoverySession

A class representing a Aware subscribe session. Created when WifiAwareSession.subscribe(SubscribeConfig,DiscoverySessionCallback,android.os.Handler) is called and a discovery session is created and returned in DiscoverySessionCallback.onSubscribeStarted(SubscribeDiscoverySession). See baseline functionality of all discovery sessions in DiscoverySession. This object allows updating an existing/running subscribe discovery session using updateSubscribe(SubscribeConfig).

Summary

Public methods
`boolean`	`initiateDataPathRequest(PeerHandle peerHandle, AwareDataPathRequest request)` Initiate a Wi-Fi Aware data path request to create a connection with the target peer.
`void`	`updateSubscribe(SubscribeConfig subscribeConfig)` Re-configure the currently active subscribe session.

Inherited methods

From class


        
          android.net.wifi.aware.DiscoverySession

`void`	`acceptPairingRequest(int requestId, PeerHandle peerHandle, String peerDeviceAlias, int cipherSuite, String password)` Accept and respond to a Wi-Fi Aware Pairing setup request received from peer.
`void`	`close()` Destroy the publish or subscribe session - free any resources, and stop transmitting packets on-air (for an active session) or listening for matches (for a passive session).
`NetworkSpecifier`	`createNetworkSpecifierOpen(PeerHandle peerHandle)` This method was deprecated in API level 29. Use the replacement `WifiAwareNetworkSpecifier.Builder`.
`NetworkSpecifier`	`createNetworkSpecifierPassphrase(PeerHandle peerHandle, String passphrase)` This method was deprecated in API level 29. Use the replacement `WifiAwareNetworkSpecifier.Builder`.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`void`	`initiateBootstrappingRequest(PeerHandle peerHandle, int method, byte[] message)` Defined as per Wi-Fi Aware specifications version 4.0 Section 7.6.4.1.
`void`	`initiateBootstrappingRequest(PeerHandle peerHandle, int method)` Defined as per Wi-Fi Aware specifications version 4.0 Section 7.6.4.1.
`void`	`initiatePairingRequest(PeerHandle peerHandle, String peerDeviceAlias, int cipherSuite, String password)` Initiate a Wi-Fi Aware Pairing setup request to create a pairing with the target peer.
`void`	`rejectPairingRequest(int requestId, PeerHandle peerHandle)` Reject a Wi-Fi Aware Pairing setup request received from peer.
`boolean`	`releaseDataPath(PeerHandle peerHandle)` Release the Aware data path to the specified peer.
`void`	`sendMessage(PeerHandle peerHandle, int messageId, byte[] message)` Sends a message to the specified destination.

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


        
          java.lang.AutoCloseable


      close()

Closes this resource, relinquishing any underlying resources.

Public methods

initiateDataPathRequest

Added in API level 26

public boolean initiateDataPathRequest (PeerHandle peerHandle, 
                AwareDataPathRequest request)

Initiate a Wi-Fi Aware data path request to create a connection with the target peer. The Aware data path request should be done in the context of a discovery session - after a DiscoverySessionCallback.onServiceDiscovered(ServiceDiscoveryInfo) event is received. When the Aware data path setup succeeds, both side will receive DiscoverySessionCallback.onDataPathConnected(PeerHandle,WifiAwareNetworkInfo). Otherwise DiscoverySessionCallback.onDataPathRequestFailed(PeerHandle,int) will be called.

Parameters
`peerHandle`	`PeerHandle`: The peer's handle for the data path request. This value cannot be `null`.
`request`	`AwareDataPathRequest`: The data path request. This value cannot be `null`.

Returns
`boolean`	true if framework starts the data path setup successfully, false otherwise.

updateSubscribe

Added in API level 26

public void updateSubscribe (SubscribeConfig subscribeConfig)

Re-configure the currently active subscribe session. The DiscoverySessionCallback is not replaced - the same listener used at creation is still used. The results of the configuration are returned using DiscoverySessionCallback:

DiscoverySessionCallback.onSessionConfigUpdated(): configuration update succeeded.
DiscoverySessionCallback.onSessionConfigFailed(): configuration update failed. The subscribe discovery session is still running using its previous configuration (i.e. update failure does not terminate the session).

Parameters
`subscribeConfig`	`SubscribeConfig`: The new discovery subscribe session configuration (`SubscribeConfig`). This value cannot be `null`.