WifiAwareSession

close

open fun close(): Unit

Destroy the Wi-Fi Aware service session and, if no other applications are attached to Aware, also disable Aware. This method destroys all outstanding operations - i.e. all publish and subscribes are terminated, and any outstanding data-links are shut-down. However, it is good practice to destroy these discovery sessions and connections explicitly before a session-wide destroy.

An application may re-attach after a destroy using WifiAwareManager.attach(AttachCallback,Handler) .

createNetworkSpecifierOpen

open fun createNetworkSpecifierOpen(
    role: Int, 
    peer: ByteArray
): NetworkSpecifier!

Deprecated: Please use in-band data-path setup, refer to WifiAwareNetworkSpecifier.Builder, publish(PublishConfig,DiscoverySessionCallback,Handler) and subscribe(SubscribeConfig,DiscoverySessionCallback,Handler)

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 API is targeted for applications which can obtain the peer MAC address using OOB (out-of-band) discovery. Aware discovery does not provide the MAC address of the peer - when using Aware discovery use the alternative network specifier method - android.net.wifi.aware.WifiAwareNetworkSpecifier.Builder.

To set up an encrypted link use the createNetworkSpecifierPassphrase(int,byte[],String) API.

createNetworkSpecifierPassphrase

open fun createNetworkSpecifierPassphrase(
    role: Int, 
    peer: ByteArray, 
    passphrase: String
): NetworkSpecifier!

Deprecated: Please use in-band data-path setup, refer to WifiAwareNetworkSpecifier.Builder, publish(PublishConfig,DiscoverySessionCallback,Handler) and subscribe(SubscribeConfig,DiscoverySessionCallback,Handler)

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 API is targeted for applications which can obtain the peer MAC address using OOB (out-of-band) discovery. Aware discovery does not provide the MAC address of the peer - when using Aware discovery use the alternative network specifier method - android.net.wifi.aware.WifiAwareNetworkSpecifier.Builder.

publish

open fun publish(
    publishConfig: PublishConfig, 
    callback: DiscoverySessionCallback, 
    handler: Handler?
): Unit

Issue a request to the Aware service to create a new Aware publish discovery session, using the specified publishConfig configuration. The results of the publish operation are routed to the callbacks of DiscoverySessionCallback:

• DiscoverySessionCallback.onPublishStarted(PublishDiscoverySession) is called when the publish session is created and provides a handle to the session. Further operations on the publish session can be executed on that object.
• DiscoverySessionCallback.onSessionConfigFailed() is called if the publish operation failed.

Other results of the publish session operations will also be routed to callbacks on the callback object. The resulting publish session can be modified using PublishDiscoverySession.updatePublish(PublishConfig).

The total count of currently available Wi-Fi Aware publish sessions is limited and is available via the AwareResources.getAvailablePublishSessionsCount() method.

An application must use the DiscoverySession.close() to terminate the publish discovery session once it isn't needed. This will free resources as well terminate any on-air transmissions.

If targeting android.os.Build.VERSION_CODES#TIRAMISU or later, the application must have android.Manifest.permission#NEARBY_WIFI_DEVICES with android:usesPermissionFlags="neverForLocation". If the application does not declare android:usesPermissionFlags="neverForLocation", then it must also have android.Manifest.permission#ACCESS_FINE_LOCATION. If targeting an earlier release than android.os.Build.VERSION_CODES#TIRAMISU, the application must have android.Manifest.permission#ACCESS_FINE_LOCATION.

subscribe

open fun subscribe(
    subscribeConfig: SubscribeConfig, 
    callback: DiscoverySessionCallback, 
    handler: Handler?
): Unit

Issue a request to the Aware service to create a new Aware subscribe discovery session, using the specified subscribeConfig configuration. The results of the subscribe operation are routed to the callbacks of DiscoverySessionCallback:

• DiscoverySessionCallback.onSubscribeStarted(SubscribeDiscoverySession) is called when the subscribe session is created and provides a handle to the session. Further operations on the subscribe session can be executed on that object.
• DiscoverySessionCallback.onSessionConfigFailed() is called if the subscribe operation failed.

Other results of the subscribe session operations will also be routed to callbacks on the callback object. The resulting subscribe session can be modified using SubscribeDiscoverySession.updateSubscribe(SubscribeConfig).

The total count of currently available Wi-Fi Aware subscribe sessions is limited and is available via the AwareResources.getAvailableSubscribeSessionsCount() method.

An application must use the DiscoverySession.close() to terminate the subscribe discovery session once it isn't needed. This will free resources as well terminate any on-air transmissions.

If targeting android.os.Build.VERSION_CODES#TIRAMISU or later, the application must have android.Manifest.permission#NEARBY_WIFI_DEVICES with android:usesPermissionFlags="neverForLocation". If the application does not declare android:usesPermissionFlags="neverForLocation", then it must also have android.Manifest.permission#ACCESS_FINE_LOCATION. If targeting an earlier release than android.os.Build.VERSION_CODES#TIRAMISU, the application must have android.Manifest.permission#ACCESS_FINE_LOCATION.

finalize

protected open fun finalize(): Unit

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.