multipaz/org.multipaz.mdoc.transport/NfcHybridTransportMdoc

NfcHybridTransportMdoc

class NfcHybridTransportMdoc(sendMessageViaNfc: suspend (message: ByteString) -> Boolean) : MdocTransport

Hybrid transport for using NFCv2.

Parameters

sendMessageViaNfc

a function to send a message via NFC, returns false if the NFC connection is no longer up. be on NFC

Constructors

NfcHybridTransportMdoc

constructor(sendMessageViaNfc: suspend (message: ByteString) -> Boolean)

Types

Companion

object Companion

Properties

connectionMethod

open override val connectionMethod: MdocConnectionMethod

A MdocConnectionMethod which can be sent to the other peer to connect to.

isNfcConnected

val isNfcConnected: StateFlow<Boolean>

Whether the NFC connection is currently active.

isNfcOnly

val isNfcOnly: Boolean

Whether this hybrid transport is operating in NFC-only mode without alternative transports.

role

open override val role: MdocRole

The role which the transport is for.

scanningTime

open override val scanningTime: Duration?

The time spent scanning for the other peer.

state

open override val state: StateFlow<MdocTransport.State>

The current state of the transport.

stats

val stats: NfcHybridTransportStats

Statistics about the NfcHybridTransportMdoc.

Functions

advertise

open suspend override fun advertise()

Starts advertising the connection.

open suspend override fun close()

Closes the connection.

markResponsePending

fun markResponsePending()

Marks that a response is pending transmission for the current request.

onMessageReceivedViaNfc

suspend fun onMessageReceivedViaNfc(message: ByteString)

Called when a message has been received via NFC.

onNfcDeactivated

suspend fun onNfcDeactivated(reason: Int)

Called when a deactivation event on NFC has occurred.

open

open suspend override fun open(eSenderKey: EcPublicKey)

Opens the connection to the other peer.

sendMessage

open suspend override fun sendMessage(message: ByteArray)

Sends a message to the other peer.

setExpectTransport

fun setExpectTransport(expectTransport: Boolean)

Sets whether a setTransport is expected to be called.

setTransport

suspend fun setTransport(transport: MdocTransport)

Called when the negotiated transport is connected.

waitForMessage

open suspend override fun waitForMessage(): ByteArray

Waits for the other peer to send a message.