SubscribeDiscoverySession

Kotlin |Java

open class SubscribeDiscoverySession : DiscoverySession

kotlin.Any
↳	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
open Boolean	`initiateDataPathRequest(peerHandle: PeerHandle, request: AwareDataPathRequest)` Initiate a Wi-Fi Aware data path request to create a connection with the target peer.
open Unit	`updateSubscribe(subscribeConfig: SubscribeConfig)` Re-configure the currently active subscribe session.

Inherited functions

From class DiscoverySession

`Unit`	`acceptPairingRequest(requestId: Int, peerHandle: PeerHandle, peerDeviceAlias: String, cipherSuite: Int, password: String?)` Accept and respond to a Wi-Fi Aware Pairing setup request received from peer. This is the response to the `DiscoverySessionCallback.onPairingSetupRequestReceived(PeerHandle,int)` When the Aware Pairing setup is finished, both sides will receive `DiscoverySessionCallback.onPairingSetupSucceeded(PeerHandle,String)`
`Unit`	`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). The session may not be used for any additional operations after its destruction. This operation must be done on a session which is no longer needed. Otherwise system resources will continue to be utilized until the application exits. The only exception is a session for which we received a termination callback, `DiscoverySessionCallback.onSessionTerminated()`.
`NetworkSpecifier!`	`createNetworkSpecifierOpen(peerHandle: PeerHandle)` Create a `android.net.NetworkRequest.Builder.setNetworkSpecifier(NetworkSpecifier)` for an unencrypted WiFi Aware connection (link) to the specified peer. The `android.net.NetworkRequest.Builder#addTransportType(int)` should be set to `android.net.NetworkCapabilities#TRANSPORT_WIFI_AWARE`. This method should be used when setting up a connection with a peer discovered through Aware discovery or communication (in such scenarios the MAC address of the peer is shielded by an opaque peer ID handle). If an Aware connection is needed to a peer discovered using other OOB (out-of-band) mechanism then use the alternative `WifiAwareSession.createNetworkSpecifierOpen(int,byte[])` method - which uses the peer's MAC address. Note: per the Wi-Fi Aware specification the roles are fixed - a Subscriber is an INITIATOR and a Publisher is a RESPONDER. To set up an encrypted link use the `createNetworkSpecifierPassphrase(PeerHandle,String)` API.
`NetworkSpecifier!`	`createNetworkSpecifierPassphrase(peerHandle: PeerHandle, passphrase: String)` Create a `android.net.NetworkRequest.Builder.setNetworkSpecifier(NetworkSpecifier)` for an encrypted WiFi Aware connection (link) to the specified peer. The `android.net.NetworkRequest.Builder#addTransportType(int)` should be set to `android.net.NetworkCapabilities#TRANSPORT_WIFI_AWARE`. This method should be used when setting up a connection with a peer discovered through Aware discovery or communication (in such scenarios the MAC address of the peer is shielded by an opaque peer ID handle). If an Aware connection is needed to a peer discovered using other OOB (out-of-band) mechanism then use the alternative `WifiAwareSession.createNetworkSpecifierPassphrase(int,byte[],String)` method - which uses the peer's MAC address. Note: per the Wi-Fi Aware specification the roles are fixed - a Subscriber is an INITIATOR and a Publisher is a RESPONDER.
`Unit`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the `finalize` method to dispose of system resources or to perform other cleanup. The general contract of `finalize` is that it is invoked if and when the Java virtual machine has determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, except as a result of an action taken by the finalization of some other object or class which is ready to be finalized. The `finalize` method may take any action, including making this object available again to other threads; the usual purpose of `finalize`, however, is to perform cleanup actions before the object is irrevocably discarded. For example, the finalize method for an object that represents an input/output connection might perform explicit I/O transactions to break the connection before the object is permanently discarded. The `finalize` method of class `Object` performs no special action; it simply returns normally. Subclasses of `Object` may override this definition. The Java programming language does not guarantee which thread will invoke the `finalize` method for any given object. It is guaranteed, however, that the thread that invokes finalize will not be holding any user-visible synchronization locks when finalize is invoked. If an uncaught exception is thrown by the finalize method, the exception is ignored and finalization of that object terminates. After the `finalize` method has been invoked for an object, no further action is taken until the Java virtual machine has again determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, including possible actions by other objects or classes which are ready to be finalized, at which point the object may be discarded. The `finalize` method is never invoked more than once by a Java virtual machine for any given object. Any exception thrown by the `finalize` method causes the finalization of this object to be halted, but is otherwise ignored.
`Unit`	`initiateBootstrappingRequest(peerHandle: PeerHandle, method: Int)` Defined as per Wi-Fi Aware specifications version 4.0 Section 7.6.4.1. Initiate a Wi-Fi Aware bootstrapping setup request to create a pairing with the target peer. The Aware bootstrapping request should be done in the context of a discovery session - after a publish/subscribe. `DiscoverySessionCallback.onServiceDiscovered(ServiceDiscoveryInfo)` event is received. The peer will check if the method can be fulfilled by `AwarePairingConfig.Builder.setBootstrappingMethods(int)` When the Aware Bootstrapping setup finished, both side will receive `DiscoverySessionCallback.onBootstrappingSucceeded(PeerHandle,int)`
`Unit`	`initiateBootstrappingRequest(peerHandle: PeerHandle, method: Int, message: ByteArray)` Defined as per Wi-Fi Aware specifications version 4.0 Section 7.6.4.1. Initiate a Wi-Fi Aware bootstrapping setup request to create a pairing with the target peer. The Aware bootstrapping request should be done in the context of a discovery session - after a publish/subscribe `DiscoverySessionCallback.onServiceDiscovered(ServiceDiscoveryInfo)` event is received. The peer will check if the method can be fulfilled by `AwarePairingConfig.Builder.setBootstrappingMethods(int)` When the Aware Bootstrapping setup finished, both side will receive `DiscoverySessionCallback.onBootstrappingSucceeded(PeerHandle,int)`
`Unit`	`initiatePairingRequest(peerHandle: PeerHandle, peerDeviceAlias: String, cipherSuite: Int, password: String?)` Initiate a Wi-Fi Aware Pairing setup request to create a pairing with the target peer. The Aware pairing request should be done in the context of a discovery session - after a publish/subscribe `DiscoverySessionCallback.onServiceDiscovered(ServiceDiscoveryInfo)` event is received. The peer will get a callback indicating a message was received using `DiscoverySessionCallback.onPairingSetupRequestReceived(PeerHandle,int)`. When the Aware Pairing setup is finished, both sides will receive `DiscoverySessionCallback.onPairingSetupSucceeded(PeerHandle,String)`
`Unit`	`rejectPairingRequest(requestId: Int, peerHandle: PeerHandle)` Reject a Wi-Fi Aware Pairing setup request received from peer. This is the response to the `DiscoverySessionCallback.onPairingSetupRequestReceived(PeerHandle,int)`
`Boolean`	`releaseDataPath(peerHandle: PeerHandle)` Release the Aware data path to the specified peer. The datapath will be disconnected if no other applications are requesting it. `DiscoverySessionCallback.onDataPathDisconnected(PeerHandle)` will be called when the datapath is disconnected.
`Unit`	`sendMessage(peerHandle: PeerHandle, messageId: Int, message: ByteArray?)` Sends a message to the specified destination. Aware messages are transmitted in the context of a discovery session - executed subsequent to a publish/subscribe `DiscoverySessionCallback.onServiceDiscovered(PeerHandle,byte[],java.util.List)` event. Aware messages are not guaranteed delivery. Callbacks on `DiscoverySessionCallback` indicate message was transmitted successfully, `DiscoverySessionCallback.onMessageSendSucceeded(int)`, or transmission failed (possibly after several retries) - `DiscoverySessionCallback.onMessageSendFailed(int)`. The peer will get a callback indicating a message was received using `DiscoverySessionCallback.onMessageReceived(PeerHandle,byte[])`.

Public methods

initiateDataPathRequest

Added in API level 37

open fun initiateDataPathRequest(
    peerHandle: PeerHandle, 
    request: AwareDataPathRequest
): Boolean

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

Return
`Boolean`	true if framework starts the data path setup successfully, false otherwise.

updateSubscribe

Added in API level 26

open fun updateSubscribe(subscribeConfig: SubscribeConfig): Unit

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