MultipazProject

multipaz-android-legacy/com.android.identity.android.mdoc.transport/DataTransport

DataTransport

abstract class DataTransport(context: Context, val role: DataTransport.Role, options: DataTransportOptions)

Abstraction for data transfer between prover and verifier devices.

The data transfer is packetized, that is, data is delivered at the same granularity as it is sent. For example, if .sendMessage is used to send N bytes then this blob is what the remote peer will receive in the Listener.onMessageReceived callback.

Instances constructed from subclasses deriving from this class must be inert when constructed, that is, they must not do anything. This constraint exists to easily facilitate factory-patterns.

If an unrecoverable error is detected, this is conveyed using the Listener.onError callback.

This class can be used to implement both provers and verifiers.

Inheritors

DataTransportBle

DataTransportHttp

DataTransportNfc

DataTransportTcp

DataTransportUdp

DataTransportWifiAware

Constructors

constructor(context: Context, role: DataTransport.Role, options: DataTransportOptions)

Types

object Companion

interface Listener

Interface for listener.

enum Role : Enum<DataTransport.Role>

Enumeration for the two different sides of a transport.

Properties

connectionMethodForTransport

abstract val connectionMethodForTransport: MdocConnectionMethod

A MdocConnectionMethod instance that can be used to connect to this transport.

inhibitCallbacks

var inhibitCallbacks: Boolean

var isConnected: Boolean

val role: DataTransport.Role

Functions

abstract fun close()

Closes the connection with the remote mdoc or mdoc reader.

abstract fun connect()

Starts connecting to the remote mdoc or mdoc reader.

fun getMessage(): ByteArray?

Returns the next message received, if any.

abstract fun sendMessage(data: ByteArray)

Sends data to the remote mdoc or mdoc reader.

sendTransportSpecificTerminationMessage

abstract fun sendTransportSpecificTerminationMessage()

Sends a transport-specific termination message.

setEDeviceKeyBytes

abstract fun setEDeviceKeyBytes(encodedEDeviceKeyBytes: ByteArray)

Sets the bytes of EDeviceKeyBytes.

fun setListener(listener: DataTransport.Listener?, executor: Executor?)

Set the listener to be used for notification.

supportsTransportSpecificTerminationMessage

abstract fun supportsTransportSpecificTerminationMessage(): Boolean

Whether the transport supports a transport-specific termination message.