BtHciMdocTransportFactory

class BtHciMdocTransportFactory(gapDeviceName: String = "Multipaz", randomAddress: ByteArray? = null, scanInterval: Duration = 60.milliseconds, scanWindow: Duration = 30.milliseconds, connectTimeout: Duration = 3.seconds, centralConfig: BleCentralConfig = BleCentralConfig( scanRestartTimeout = 3.seconds, requireL2capPeripheralConnectedFirst = true, ), faultConfig: BleHciFaultConfig = BleHciFaultConfig(), fallbackFactory: MdocTransportFactory = MdocTransportFactory.Default, packetIoFactory: suspend () -> HciPacketIo = ::openDefaultHciPacketIo) : MdocTransportFactory

An MdocTransportFactory that creates BLE MdocTransport instances backed by Multipaz's user-space Bluetooth HCI/L2CAP/ATT stack (BleCentralHalHci and BlePeripheralHalHci).

Non-BLE connection methods (such as MdocConnectionMethod.Nfc) are delegated to fallbackFactory.

On Linux JVM, the default packetIoFactory opens a LinuxHciSocketPacketIo bound via HCI_CHANNEL_USER (or adopts a pre-opened file descriptor configured via -Dorg.multipaz.ble.hciFd=<fd> or MULTIPAZ_BLE_HCI_FD=<fd>). On other platforms, callers must supply an explicit packetIoFactory (for example, over USB or UART H4).

Parameters

gapDeviceName

the GAP Device Name (0x2A00) exposed on CID 0x0004 (defaults to "Multipaz").

randomAddress

optional 6-byte static random LE address in HCI little-endian byte order (where byte 5 is the MSB with top two bits set to 11), or null to generate a fresh random address per session.

scanInterval

the LE scan interval (2.5 ms to 10.24 s, defaults to 60.milliseconds).

scanWindow

the LE scan window (2.5 ms to 10.24 s, must be <= scanInterval, defaults to 30.milliseconds).

connectTimeout

per-attempt timeout for HCI_LE_Create_Connection before cancelling and retrying (defaults to 3.seconds).

centralConfig

BLE Central retry, scan-restart, and L2CAP connection timing parameters.

faultConfig

optional BleHciFaultConfig for injecting deterministic BLE handshake faults.

fallbackFactory

factory used for non-BLE MdocConnectionMethods (defaults to MdocTransportFactory.Default).

packetIoFactory

factory that opens an HciPacketIo transport for each BLE session.

Constructors

Link copied to clipboard
constructor(gapDeviceName: String = "Multipaz", randomAddress: ByteArray? = null, scanInterval: Duration = 60.milliseconds, scanWindow: Duration = 30.milliseconds, connectTimeout: Duration = 3.seconds, centralConfig: BleCentralConfig = BleCentralConfig( scanRestartTimeout = 3.seconds, requireL2capPeripheralConnectedFirst = true, ), faultConfig: BleHciFaultConfig = BleHciFaultConfig(), fallbackFactory: MdocTransportFactory = MdocTransportFactory.Default, packetIoFactory: suspend () -> HciPacketIo = ::openDefaultHciPacketIo)

Functions

Link copied to clipboard
open override fun createTransport(connectionMethod: MdocConnectionMethod, role: MdocRole, options: MdocTransportOptions): MdocTransport
Link copied to clipboard
open override fun createTransports(connectionMethods: List<MdocConnectionMethod>, role: MdocRole, options: MdocTransportOptions): List<MdocTransport>