multipaz/org.multipaz.mdoc.transport

Package-level declarations

Types

MdocTransport

abstract class MdocTransport

An abstraction of a ISO/IEC 18013-5:2021 device retrieval method.

MdocTransportClosedException

class MdocTransportClosedException : Exception

Thrown by MdocTransport.waitForMessage if the transport was closed by another coroutine while waiting.

MdocTransportException

class MdocTransportException : Exception

Thrown if an unrecoverable error occurs.

MdocTransportFactory

interface MdocTransportFactory

An interface used to create MdocTransport instances.

MdocTransportOptions

data class MdocTransportOptions(val bleUseL2CAP: Boolean = false, val bleUseL2CAPInEngagement: Boolean = false)

Options for using a MdocTransport.

MdocTransportTerminationException

class MdocTransportTerminationException : Exception

Thrown if transport-specific termination was requested but not supported by the underlying tranposrt.

NfcHybridTransportMdoc

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

Hybrid transport for using NFCv2.

NfcHybridTransportMdocReader

class NfcHybridTransportMdocReader(nfcTag: NfcIsoTag, negotiatedTransport: MdocTransport?) : MdocTransport

Hybrid transport for ISO 18013-5 Second Edition NFCv2 engagement on the reader side.

NfcHybridTransportStats

data class NfcHybridTransportStats(val numSent: Int, val numSentViaNfc: Int, val numSentViaTransport: Int, val numReceived: Int, val numReceivedFirstOnNfc: Int, val numReceivedFirstOnTransport: Int, val nfcDisconnectedDuringTransaction: Boolean)

Count of messages sent and received on NfcHybridTransportMdoc and NfcHybridTransportMdocReader transports.

NfcTransportMdoc

class NfcTransportMdoc(val role: MdocRole, options: MdocTransportOptions, val connectionMethod: MdocConnectionMethod) : MdocTransport

NfcTransportMdocReader

class NfcTransportMdocReader(val role: MdocRole, options: MdocTransportOptions, val connectionMethod: MdocConnectionMethodNfc) : MdocTransport

Properties

cborSchemaId

val NfcHybridTransportStats.Companion.cborSchemaId: ByteString

NfcHybridTransportStats_cborSchemaId

val NfcHybridTransportStats_cborSchemaId: ByteString

Functions

advertise

suspend fun List<MdocConnectionMethod>.advertise(role: MdocRole, transportFactory: MdocTransportFactory, options: MdocTransportOptions): List<MdocTransport>

A helper for advertising a number of connections to a remote peer.

fromCbor

fun NfcHybridTransportStats.Companion.fromCbor(data: ByteArray): NfcHybridTransportStats

fromDataItem

fun NfcHybridTransportStats.Companion.fromDataItem(dataItem: DataItem): NfcHybridTransportStats

toCbor

fun NfcHybridTransportStats.toCbor(): ByteArray

toDataItem

fun NfcHybridTransportStats.toDataItem(): DataItem

waitForConnection

suspend fun List<MdocTransport>.waitForConnection(eSenderKey: EcPublicKey): MdocTransport

A helper for waiting until someone connects to a transport.