MultipazProject

multipaz/org.multipaz.mdoc.transport

Package-level declarations

Types

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)

Options for using a MdocTransport.

MdocTransportTerminationException

class MdocTransportTerminationException : Exception

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

NfcTransportMdoc

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

NfcTransportMdocReader

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

Functions

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.

defaultMdocTransportFactoryCreateTransport

actual fun defaultMdocTransportFactoryCreateTransport(connectionMethod: MdocConnectionMethod, role: MdocRole, options: MdocTransportOptions): MdocTransport

waitForConnection

suspend fun List<MdocTransport>.waitForConnection(eSenderKey: EcPublicKey, coroutineScope: CoroutineScope = CoroutineScope(Dispatchers.IO)): MdocTransport

A helper for waiting until someone connects to a transport.