cdp/dev.kdriver.cdp.domain/SmartCardEmulation

SmartCardEmulation

class SmartCardEmulation(cdp: CDP) : Domain

Constructors

SmartCardEmulation

constructor(cdp: CDP)

Types

BeginTransactionRequestedParameter

@Serializable

data class BeginTransactionRequestedParameter(val requestId: String, val handle: Int)

Fired when |SCardBeginTransaction| is called.

CancelRequestedParameter

@Serializable

data class CancelRequestedParameter(val requestId: String, val contextId: Int)

Fired when |SCardCancel| is called.

ConnectionState

@Serializable

enum ConnectionState : Enum<SmartCardEmulation.ConnectionState>

Maps to |SCARD_*| connection state values.

ConnectRequestedParameter

@Serializable

data class ConnectRequestedParameter(val requestId: String, val contextId: Int, val reader: String, val shareMode: SmartCardEmulation.ShareMode, val preferredProtocols: SmartCardEmulation.ProtocolSet)

Fired when |SCardConnect| is called.

ControlRequestedParameter

@Serializable

data class ControlRequestedParameter(val requestId: String, val handle: Int, val controlCode: Int, val data: String)

Fired when |SCardControl| is called.

DisconnectRequestedParameter

@Serializable

data class DisconnectRequestedParameter(val requestId: String, val handle: Int, val disposition: SmartCardEmulation.Disposition)

Fired when |SCardDisconnect| is called.

Disposition

@Serializable

enum Disposition : Enum<SmartCardEmulation.Disposition>

Indicates what the reader should do with the card.

EndTransactionRequestedParameter

@Serializable

data class EndTransactionRequestedParameter(val requestId: String, val handle: Int, val disposition: SmartCardEmulation.Disposition)

Fired when |SCardEndTransaction| is called.

EstablishContextRequestedParameter

@Serializable

data class EstablishContextRequestedParameter(val requestId: String)

Fired when |SCardEstablishContext| is called.

GetAttribRequestedParameter

@Serializable

data class GetAttribRequestedParameter(val requestId: String, val handle: Int, val attribId: Int)

Fired when |SCardGetAttrib| is called.

GetStatusChangeRequestedParameter

@Serializable

data class GetStatusChangeRequestedParameter(val requestId: String, val contextId: Int, val readerStates: List<SmartCardEmulation.ReaderStateIn>, val timeout: Int? = null)

Fired when |SCardGetStatusChange| is called. Timeout is specified in milliseconds.

ListReadersRequestedParameter

@Serializable

data class ListReadersRequestedParameter(val requestId: String, val contextId: Int)

Fired when |SCardListReaders| is called.

Protocol

@Serializable

enum Protocol : Enum<SmartCardEmulation.Protocol>

Maps to the |SCARD_PROTOCOL_*| values.

ProtocolSet

@Serializable

data class ProtocolSet(val t0: Boolean? = null, val t1: Boolean? = null, val raw: Boolean? = null)

Maps to the |SCARD_PROTOCOL_*| flags.

ReaderStateFlags

@Serializable

data class ReaderStateFlags(val unaware: Boolean? = null, val ignore: Boolean? = null, val changed: Boolean? = null, val unknown: Boolean? = null, val unavailable: Boolean? = null, val empty: Boolean? = null, val present: Boolean? = null, val exclusive: Boolean? = null, val inuse: Boolean? = null, val mute: Boolean? = null, val unpowered: Boolean? = null)

Maps to the |SCARD_STATE_*| flags.

ReaderStateIn

@Serializable

data class ReaderStateIn(val reader: String, val currentState: SmartCardEmulation.ReaderStateFlags, val currentInsertionCount: Int)

ReaderStateOut

@Serializable

data class ReaderStateOut(val reader: String, val eventState: SmartCardEmulation.ReaderStateFlags, val eventCount: Int, val atr: String)

ReleaseContextRequestedParameter

@Serializable

data class ReleaseContextRequestedParameter(val requestId: String, val contextId: Int)

Fired when |SCardReleaseContext| is called.

ReportBeginTransactionResultParameter

@Serializable

data class ReportBeginTransactionResultParameter(val requestId: String, val handle: Int)

ReportConnectResultParameter

@Serializable

data class ReportConnectResultParameter(val requestId: String, val handle: Int, val activeProtocol: SmartCardEmulation.Protocol? = null)

ReportDataResultParameter

@Serializable

data class ReportDataResultParameter(val requestId: String, val data: String)

ReportErrorParameter

@Serializable

data class ReportErrorParameter(val requestId: String, val resultCode: SmartCardEmulation.ResultCode)

ReportEstablishContextResultParameter

@Serializable

data class ReportEstablishContextResultParameter(val requestId: String, val contextId: Int)

ReportGetStatusChangeResultParameter

@Serializable

data class ReportGetStatusChangeResultParameter(val requestId: String, val readerStates: List<SmartCardEmulation.ReaderStateOut>)

ReportListReadersResultParameter

@Serializable

data class ReportListReadersResultParameter(val requestId: String, val readers: List<String>)

ReportPlainResultParameter

@Serializable

data class ReportPlainResultParameter(val requestId: String)

ReportReleaseContextResultParameter

@Serializable

data class ReportReleaseContextResultParameter(val requestId: String)

ReportStatusResultParameter

@Serializable

data class ReportStatusResultParameter(val requestId: String, val readerName: String, val state: SmartCardEmulation.ConnectionState, val atr: String, val protocol: SmartCardEmulation.Protocol? = null)

ResultCode

@Serializable

enum ResultCode : Enum<SmartCardEmulation.ResultCode>

Indicates the PC/SC error code.

SetAttribRequestedParameter

@Serializable

data class SetAttribRequestedParameter(val requestId: String, val handle: Int, val attribId: Int, val data: String)

Fired when |SCardSetAttrib| is called.

ShareMode

@Serializable

enum ShareMode : Enum<SmartCardEmulation.ShareMode>

Maps to the |SCARD_SHARE_*| values.

StatusRequestedParameter

@Serializable

data class StatusRequestedParameter(val requestId: String, val handle: Int)

Fired when |SCardStatus| is called.

TransmitRequestedParameter

@Serializable

data class TransmitRequestedParameter(val requestId: String, val handle: Int, val data: String, val protocol: SmartCardEmulation.Protocol? = null)

Fired when |SCardTransmit| is called.

Properties

beginTransactionRequested

val beginTransactionRequested: Flow<SmartCardEmulation.BeginTransactionRequestedParameter>

Fired when |SCardBeginTransaction| is called.

cancelRequested

val cancelRequested: Flow<SmartCardEmulation.CancelRequestedParameter>

Fired when |SCardCancel| is called.

connectRequested

val connectRequested: Flow<SmartCardEmulation.ConnectRequestedParameter>

Fired when |SCardConnect| is called.

controlRequested

val controlRequested: Flow<SmartCardEmulation.ControlRequestedParameter>

Fired when |SCardControl| is called.

disconnectRequested

val disconnectRequested: Flow<SmartCardEmulation.DisconnectRequestedParameter>

Fired when |SCardDisconnect| is called.

endTransactionRequested

val endTransactionRequested: Flow<SmartCardEmulation.EndTransactionRequestedParameter>

Fired when |SCardEndTransaction| is called.

establishContextRequested

val establishContextRequested: Flow<SmartCardEmulation.EstablishContextRequestedParameter>

Fired when |SCardEstablishContext| is called.

getAttribRequested

val getAttribRequested: Flow<SmartCardEmulation.GetAttribRequestedParameter>

Fired when |SCardGetAttrib| is called.

getStatusChangeRequested

val getStatusChangeRequested: Flow<SmartCardEmulation.GetStatusChangeRequestedParameter>

Fired when |SCardGetStatusChange| is called. Timeout is specified in milliseconds.

listReadersRequested

val listReadersRequested: Flow<SmartCardEmulation.ListReadersRequestedParameter>

Fired when |SCardListReaders| is called.

releaseContextRequested

val releaseContextRequested: Flow<SmartCardEmulation.ReleaseContextRequestedParameter>

Fired when |SCardReleaseContext| is called.

setAttribRequested

val setAttribRequested: Flow<SmartCardEmulation.SetAttribRequestedParameter>

Fired when |SCardSetAttrib| is called.

statusRequested

val statusRequested: Flow<SmartCardEmulation.StatusRequestedParameter>

Fired when |SCardStatus| is called.

transmitRequested

val transmitRequested: Flow<SmartCardEmulation.TransmitRequestedParameter>

Fired when |SCardTransmit| is called.

Functions

disable

suspend fun disable(mode: CommandMode = CommandMode.DEFAULT)

Disables the |SmartCardEmulation| domain.

enable

suspend fun enable(mode: CommandMode = CommandMode.DEFAULT)

Enables the |SmartCardEmulation| domain.

reportBeginTransactionResult

suspend fun reportBeginTransactionResult(args: SmartCardEmulation.ReportBeginTransactionResultParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun reportBeginTransactionResult(requestId: String, handle: Int)

Reports the result of a |SCardBeginTransaction| call. On success, this creates a new transaction object.

reportConnectResult

suspend fun reportConnectResult(args: SmartCardEmulation.ReportConnectResultParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun reportConnectResult(requestId: String, handle: Int, activeProtocol: SmartCardEmulation.Protocol? = null)

Reports the successful result of a |SCardConnect| call.

reportDataResult

suspend fun reportDataResult(args: SmartCardEmulation.ReportDataResultParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun reportDataResult(requestId: String, data: String)

Reports the successful result of a call that sends back data on success. Used for |SCardTransmit|, |SCardControl|, and |SCardGetAttrib|.

reportError

suspend fun reportError(args: SmartCardEmulation.ReportErrorParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun reportError(requestId: String, resultCode: SmartCardEmulation.ResultCode)

Reports an error result for the given request.

reportEstablishContextResult

suspend fun reportEstablishContextResult(args: SmartCardEmulation.ReportEstablishContextResultParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun reportEstablishContextResult(requestId: String, contextId: Int)

Reports the successful result of a |SCardEstablishContext| call.

reportGetStatusChangeResult

suspend fun reportGetStatusChangeResult(args: SmartCardEmulation.ReportGetStatusChangeResultParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun reportGetStatusChangeResult(requestId: String, readerStates: List<SmartCardEmulation.ReaderStateOut>)

Reports the successful result of a |SCardGetStatusChange| call.

reportListReadersResult

suspend fun reportListReadersResult(args: SmartCardEmulation.ReportListReadersResultParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun reportListReadersResult(requestId: String, readers: List<String>)

Reports the successful result of a |SCardListReaders| call.

reportPlainResult

suspend fun reportPlainResult(requestId: String)

suspend fun reportPlainResult(args: SmartCardEmulation.ReportPlainResultParameter, mode: CommandMode = CommandMode.DEFAULT)

Reports the successful result of a call that returns only a result code. Used for: |SCardCancel|, |SCardDisconnect|, |SCardSetAttrib|, |SCardEndTransaction|.

reportReleaseContextResult

suspend fun reportReleaseContextResult(requestId: String)

suspend fun reportReleaseContextResult(args: SmartCardEmulation.ReportReleaseContextResultParameter, mode: CommandMode = CommandMode.DEFAULT)

Reports the successful result of a |SCardReleaseContext| call.

reportStatusResult

suspend fun reportStatusResult(args: SmartCardEmulation.ReportStatusResultParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun reportStatusResult(requestId: String, readerName: String, state: SmartCardEmulation.ConnectionState, atr: String, protocol: SmartCardEmulation.Protocol? = null)

Reports the successful result of a |SCardStatus| call.