MRTD_Interface Interface Reference

Description

Interface class for Grabba MRTD-related events.

Objects which implement this interface may receive callbacks when these events occur, via delegation from a MRTD_Listener object.

Note that this interface need not be directly implemented; it may be simpler to subclass MRTD_Listener and thereby receive the events directly.

Thread safety: This interface is intended to be thread-safe; any classes deriving from it should ensure that the relevant methods are callable from any thread.

See also

MRTD_API for related API functions, and MRTD_Listener for more detailed descriptions of each event.

Inheritance diagram for MRTD_Interface:

Public Member Functions
void	dataEvent (@NonNull BER_TLV data)
	Callback which is invoked when an asynchronous MRTD read completes successfully. More...
void	errorEvent (@NonNull ErrorCode error)
	Callback which is invoked when an asynchronous MRTD read fails. More...
void	progressEvent (byte percentage)
	Callback which is invoked when asynchronous MRTD read progress advances. More...

Member Function Documentation

dataEvent()

void dataEvent

(

@NonNull BER_TLV

data

)

Callback which is invoked when an asynchronous MRTD read completes successfully.

Note

Implementations of this method are required to be thread-safe; no guarantees are made about which thread(s) they will be called from.

Parameters

data	Contents of the data read from the MRTD, in BER-TLV format

Implemented in MRTD_Listener.

errorEvent()

void errorEvent

(

@NonNull ErrorCode

error

)

Callback which is invoked when an asynchronous MRTD read fails.

Note

Implementations of this method are required to be thread-safe; no guarantees are made about which thread(s) they will be called from.

Parameters

error

Reason why the read operation failed

Implemented in MRTD_Listener.

progressEvent()

void progressEvent

(

byte

percentage

)

Callback which is invoked when asynchronous MRTD read progress advances.

Note

Implementations of this method are required to be thread-safe; no guarantees are made about which thread(s) they will be called from.

Parameters

percentage

Current read progress percentage

Implemented in MRTD_Listener.