Grabba Driver for iOS
Unified driver for Grabba devices on the iOS operating system
All Classes Functions Enumerations Enumerator Properties Modules Pages
<GrabbaMRTD_Protocol> Protocol Reference

Description

Interface for receiving MRTD read events.

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

Note that this protocol need not be directly implemented; it may be simpler to subclass GrabbaMRTD_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
GrabbaMRTD_API for related API functions

Instance Methods

(void) - dataEvent:
 Callback which is invoked when an asynchronous MRTD read completes successfully. More...
 
(void) - errorEvent:
 Callback which is invoked when an asynchronous MRTD read fails. More...
 
(void) - progressEvent:
 Callback which is invoked when asynchronous MRTD read progress advances. More...
 

Method Documentation

◆ dataEvent:()

- (void) dataEvent: (GrabbaBER_TLV *_Nonnull)  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
dataContents of the data read from the MRTD, in BER-TLV format

◆ errorEvent:()

- (void) errorEvent: (GrabbaErrorCode *_Nonnull)  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
errorReason why the read operation failed

◆ progressEvent:()

- (void) progressEvent: (uint8_t)  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
percentageCurrent read progress percentage