DiscoverySessionCallback

DiscoverySessionCallback

DiscoverySessionCallback()

onBootstrappingFailed

open fun onBootstrappingFailed(peerHandle: PeerHandle): Unit

Callback indicating that a Bootstrapping method negotiation failed.

onBootstrappingSucceeded

open fun onBootstrappingSucceeded(
    peerHandle: PeerHandle, 
    method: Int
): Unit

Callback indicating that a Bootstrapping method negotiation succeeded. The follow-up out-of-band bootstrapping can start

onMessageReceived

open fun onMessageReceived(
    peerHandle: PeerHandle!, 
    message: ByteArray!
): Unit

Called when a message is received from a discovery session peer - in response to the peer's DiscoverySession.sendMessage(PeerHandle, int, byte[]).

onMessageSendFailed

open fun onMessageSendFailed(messageId: Int): Unit

Called when message transmission initiated with DiscoverySession.sendMessage(PeerHandle, int, byte[]) fails. E.g. when no ACK is received from the peer.

Note that either this callback or DiscoverySessionCallback.onMessageSendSucceeded(int) will be received - never both.

onMessageSendSucceeded

open fun onMessageSendSucceeded(messageId: Int): Unit

Called in response to DiscoverySession.sendMessage(PeerHandle, int, byte[]) when a message is transmitted successfully - i.e. when it was received successfully by the peer (corresponds to an ACK being received).

Note that either this callback or DiscoverySessionCallback.onMessageSendFailed(int) will be received - never both.

onPairingSetupFailed

open fun onPairingSetupFailed(peerHandle: PeerHandle): Unit

Callback indicating that a pairing setup process failed.

onPairingSetupRequestReceived

open fun onPairingSetupRequestReceived(
    peerHandle: PeerHandle, 
    requestId: Int
): Unit

Callback indicating that a pairing request is received from peer.

onPairingSetupSucceeded

open fun onPairingSetupSucceeded(
    peerHandle: PeerHandle, 
    alias: String
): Unit

Callback indicating that a pairing setup process succeeded.

onPairingVerificationFailed

open fun onPairingVerificationFailed(peerHandle: PeerHandle): Unit

Callback indicating that a pairing verification process failed.

onPairingVerificationSucceed

open fun onPairingVerificationSucceed(
    peerHandle: PeerHandle, 
    alias: String
): Unit

Callback indicating that a pairing verification process succeeded.

onPublishStarted

open fun onPublishStarted(session: PublishDiscoverySession): Unit

Called when a publish operation is started successfully in response to a WifiAwareSession.publish(PublishConfig, DiscoverySessionCallback, operation.

onServiceDiscovered

open fun onServiceDiscovered(
    peerHandle: PeerHandle!, 
    serviceSpecificInfo: ByteArray!, 
    matchFilter: MutableList<ByteArray!>!
): Unit

Called when a subscribe operation results in a service discovery.

Note that this method and onServiceDiscoveredWithinRange(android.net.wifi.aware.PeerHandle,byte[],java.util.List,int) may be called multiple times per service discovery.

Note: This method is superseded by onServiceDiscovered(android.net.wifi.aware.ServiceDiscoveryInfo) which returns more information. Note that both legacy and new callback will be triggered on discovery.

onServiceDiscovered

open fun onServiceDiscovered(info: ServiceDiscoveryInfo): Unit

Called when a subscribe operation results in a service discovery.

Note: This method supersedes onServiceDiscovered(android.net.wifi.aware.PeerHandle,byte[],java.util.List) and provides additional information - including cipher suite type and security context of the peer. Both the legacy and the new callback will be triggered on discovery.

onServiceDiscoveredWithinRange

open fun onServiceDiscoveredWithinRange(
    peerHandle: PeerHandle!, 
    serviceSpecificInfo: ByteArray!, 
    matchFilter: MutableList<ByteArray!>!, 
    distanceMm: Int
): Unit

Called when a subscribe operation results in a service discovery. Called when a Subscribe service was configured with a range requirement SubscribeConfig.Builder.setMinDistanceMm(int) and/or SubscribeConfig.Builder.setMaxDistanceMm(int) and the Publish service was configured with PublishConfig.Builder.setRangingEnabled(boolean).

If either Publisher or Subscriber does not enable Ranging, or if Ranging is temporarily disabled by the underlying device, service discovery proceeds without ranging and the onServiceDiscovered(android.net.wifi.aware.PeerHandle,byte[],java.util.List) is called.

Note that this method and onServiceDiscovered(android.net.wifi.aware.PeerHandle,byte[],java.util.List) may be called multiple times per service discovery.

Note: This method is superseded by onServiceDiscoveredWithinRange(android.net.wifi.aware.ServiceDiscoveryInfo,int) which returns more information. Note that both legacy and new callback will be triggered on discovery.

onServiceDiscoveredWithinRange

open fun onServiceDiscoveredWithinRange(
    info: ServiceDiscoveryInfo, 
    distanceMm: Int
): Unit

Called when a subscribe operation results in a service discovery. Called when a Subscribe service was configured with a range requirement SubscribeConfig.Builder.setMinDistanceMm(int) and/or SubscribeConfig.Builder.setMaxDistanceMm(int) and the Publish service was configured with PublishConfig.Builder.setRangingEnabled(boolean).

If either Publisher or Subscriber does not enable Ranging, or if Ranging is temporarily disabled by the underlying device, service discovery proceeds without ranging and the onServiceDiscovered(android.net.wifi.aware.PeerHandle,byte[],java.util.List) is called.

Note: This method supersedes onServiceDiscoveredWithinRange(android.net.wifi.aware.PeerHandle,byte[],java.util.List,int) and provides additional information - including cipher suite type and security context of the peer. Both the legacy and the new callback will be triggered on discovery.

onServiceLost

open fun onServiceLost(
    peerHandle: PeerHandle, 
    reason: Int
): Unit

Called when the discovered service is not available. All further operations on this discovery session will fail. If the service is available again, onServiceDiscovered(android.net.wifi.aware.PeerHandle,byte[],java.util.List) or onServiceDiscoveredWithinRange(android.net.wifi.aware.PeerHandle,byte[],java.util.List,int) will be called.

onSessionConfigFailed

open fun onSessionConfigFailed(): Unit

Called when a publish or subscribe discovery session cannot be created: WifiAwareSession.publish(PublishConfig, DiscoverySessionCallback, or WifiAwareSession.subscribe(SubscribeConfig, DiscoverySessionCallback,, or when a configuration update fails: PublishDiscoverySession.updatePublish(PublishConfig) or SubscribeDiscoverySession.updateSubscribe(SubscribeConfig).

For discovery session updates failure leaves the session running with its previous configuration - the discovery session is not terminated.

onSessionConfigUpdated

open fun onSessionConfigUpdated(): Unit

Called when a publish or subscribe discovery session configuration update request succeeds. Called in response to PublishDiscoverySession.updatePublish(PublishConfig) or SubscribeDiscoverySession.updateSubscribe(SubscribeConfig).

onSessionTerminated

open fun onSessionTerminated(): Unit

Called when a discovery session (publish or subscribe) terminates. Termination may be due to user-request (either directly through DiscoverySession.close() or application-specified expiration, e.g. PublishConfig.Builder.setTtlSec(int) or SubscribeConfig.Builder.setTtlSec(int)).

onSubscribeStarted

open fun onSubscribeStarted(session: SubscribeDiscoverySession): Unit

Called when a subscribe operation is started successfully in response to a WifiAwareSession.subscribe(SubscribeConfig, DiscoverySessionCallback, operation.