<GrabbaProxcardProtocol> Protocol Reference

Description

Interface for receiving proxcard/RFID reader events.

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

Note that this protocol need not be directly implemented; it may be simpler to subclass GrabbaProxcardListener 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

GrabbaProxcardAPI for related API functions

Instance Methods
(void)	- dataEvent:
	Callback which is invoked when an RFID tag or proxcard is successfully scanned. More...
(void)	- errorEvent:
	Callback which is invoked when an RFID/proxcard scan operation encounters an error condition (e.g. disconnection) More...
(void)	- startEvent
	Callback which is invoked when RFID/proxcard scanning begins. More...
(void)	- stopEvent
	Callback which is invoked when RFID/proxcard scanning ceases. More...
(void)	- timeoutEvent
	Callback which is invoked when no RFID tag or proxcard is scanned within the specified timeout. More...

Method Documentation

dataEvent:()

- (void) dataEvent:

(GrabbaProxcardData *_Nonnull)

data

Callback which is invoked when an RFID tag or proxcard is successfully scanned.

Scanning is invoked by calling startScan. This event will then be triggered if an RFID tag or proxcard is scanned before the set timeout elapses.

The proxcard scan engine will be turned off prior to this event being triggered. Consequently, it is still possible for this event to be triggered for a brief interval after stopScan .

Parameters

data	Data structure containing the RFID tag/proxcard's serial number (unique identifier) and an integer representing its type

Note

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

errorEvent:()

- (void) errorEvent:

(GrabbaErrorCode *_Nonnull)

error

Callback which is invoked when an RFID/proxcard scan operation encounters an error condition (e.g. disconnection)

Scanning is invoked by calling startScan. This event will then be triggered if an error is detected before the scan completes or times out.

The proxcard scan engine will be turned off prior to this event being triggered. Consequently, it is still possible for this event to be triggered for a brief interval after stopScan .

Parameters

error

Details of the error condition which was detected

Note

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

startEvent()

- (void) startEvent

Callback which is invoked when RFID/proxcard scanning begins.

Scanning is invoked by calling startScan. This event will then be triggered if the scan is able to commence as requested.

Note

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

stopEvent()

- (void) stopEvent

Callback which is invoked when RFID/proxcard scanning ceases.

Scanning is invoked by calling startScan. This event will then be triggered when scanning ceases, which can occur for any of the following reasons:

• Successful scan occurs (dataEvent is also triggered)
• An error condition is detected (errorEvent is also triggered)
• Timeout occurs, with no successful scans prior to that point (timeoutEvent is also triggered)
• stopScan is called

If more than one event is triggered when scanning stops, no guarantees are provided as to the order in which those events are triggered.

Note

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

timeoutEvent()

- (void) timeoutEvent

Callback which is invoked when no RFID tag or proxcard is scanned within the specified timeout.

Scanning is invoked by calling startScan. This event will then be triggered if the scan timeout elapses with no successful scans having occurred.

The proxcard scan engine will be turned off prior to this event being triggered. Consequently, it is still possible for this event to be triggered for a brief interval after stopScan .

Note

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