Most visited

Recently visited

Results for

Summary: Methods | Inherited Methods

DiscoverySession

public class DiscoverySession
extends Object implements AutoCloseable

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

Known direct subclasses

PublishDiscoverySession, SubscribeDiscoverySession

PublishDiscoverySession	A class representing a Aware publish session.
SubscribeDiscoverySession	A class representing a Aware subscribe session.

A class representing a single publish or subscribe Aware session. This object will not be created directly - only its child classes are available: PublishDiscoverySession and SubscribeDiscoverySession. This class provides functionality common to both publish and subscribe discovery sessions:

Sending messages: sendMessage(android.net.wifi.aware.PeerHandle, int, byte[]) method.
Creating a network-specifier when requesting a Aware connection using WifiAwareNetworkSpecifier.Builder.

The close() method must be called to destroy discovery sessions once they are no longer needed.

Summary

Public methods
`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 is deprecated. Use the replacement `WifiAwareNetworkSpecifier.Builder`.
`NetworkSpecifier`	`createNetworkSpecifierPassphrase(PeerHandle peerHandle, String passphrase)` This method is deprecated. Use the replacement `WifiAwareNetworkSpecifier.Builder`.
`void`	`sendMessage(PeerHandle peerHandle, int messageId, byte[] message)` Sends a message to the specified destination.

Inherited methods

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 timeout, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long timeout)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

From interface


        
          java.lang.AutoCloseable


      close()

Closes this resource, relinquishing any underlying resources.

Public methods

close

public 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). 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().

createNetworkSpecifierOpen

public NetworkSpecifier createNetworkSpecifierOpen (PeerHandle peerHandle)

This method is deprecated.
Use the replacement WifiAwareNetworkSpecifier.Builder.

Create a NetworkRequest.Builder.setNetworkSpecifier(NetworkSpecifier) for an unencrypted WiFi Aware connection (link) to the specified peer. The NetworkRequest.Builder.addTransportType(int) should be set to 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(android.net.wifi.aware.PeerHandle, java.lang.String) API.

Parameters
`peerHandle`	`PeerHandle`: The peer's handle obtained through `DiscoverySessionCallback#onServiceDiscovered(PeerHandle, byte[], java.util.List)` or `DiscoverySessionCallback#onMessageReceived(PeerHandle, byte[])`. On a RESPONDER this value is used to gate the acceptance of a connection request from only that peer. This value cannot be `null`.

Returns
`NetworkSpecifier`	A `NetworkSpecifier` to be used to construct `NetworkRequest.Builder.setNetworkSpecifier(NetworkSpecifier)` to pass to `ConnectivityManager.requestNetwork(android.net.NetworkRequest, android.net.ConnectivityManager.NetworkCallback)` [or other varieties of that API].

createNetworkSpecifierPassphrase

public NetworkSpecifier createNetworkSpecifierPassphrase (PeerHandle peerHandle, 
                String passphrase)

This method is deprecated.
Use the replacement WifiAwareNetworkSpecifier.Builder.

Create a NetworkRequest.Builder.setNetworkSpecifier(NetworkSpecifier) for an encrypted WiFi Aware connection (link) to the specified peer. The NetworkRequest.Builder.addTransportType(int) should be set to 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.

Parameters
`peerHandle`	`PeerHandle`: The peer's handle obtained through `DiscoverySessionCallback#onServiceDiscovered(PeerHandle, byte[], java.util.List)` or `DiscoverySessionCallback#onMessageReceived(PeerHandle, byte[])`. On a RESPONDER this value is used to gate the acceptance of a connection request from only that peer. This value cannot be `null`.
`passphrase`	`String`: The passphrase to be used to encrypt the link. The PMK is generated from the passphrase. Use the `createNetworkSpecifierOpen(android.net.wifi.aware.PeerHandle)` API to specify an open (unencrypted) link. This value cannot be `null`.

Returns
`NetworkSpecifier`	A `NetworkSpecifier` to be used to construct `NetworkRequest.Builder.setNetworkSpecifier(NetworkSpecifier)` to pass to `ConnectivityManager.requestNetwork(android.net.NetworkRequest, android.net.ConnectivityManager.NetworkCallback)` [or other varieties of that API].

sendMessage

public void sendMessage (PeerHandle peerHandle, 
                int messageId, 
                byte[] message)

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[]).

Parameters
`peerHandle`	`PeerHandle`: The peer's handle for the message. Must be a result of an `DiscoverySessionCallback#onServiceDiscovered(PeerHandle, byte[], java.util.List)` or `DiscoverySessionCallback#onMessageReceived(PeerHandle, byte[])` events. This value cannot be `null`.
`messageId`	`int`: An arbitrary integer used by the caller to identify the message. The same integer ID will be returned in the callbacks indicating message send success or failure. The `messageId` is not used internally by the Aware service - it can be arbitrary and non-unique.
`message`	`byte`: The message to be transmitted. This value may be `null`.