rfid.api

Class Events

java.lang.Object

rfid.api.EventsAbstract

rfid.api.Events

public class Events
extends EventsAbstract

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Events.AccessStartEventData Represents Access start event data.
class	Events.AccessStopEventData Represents Access stop event data.
class	Events.AntennaEventData Contains the Antenna Event Data.
class	Events.BufferFullWarningEventData Represents Buffer Full warning event data.
class	Events.DisconnectionEventData Represents Reader Disconnect event data.
class	Events.GPIEventData Represents GPI Event Data (port and the current state)
class	Events.HandheldTriggerEventData Represents Hand held Trigger Event Data (current state)
class	Events.InventoryStartEventData Represents Inventory start event data.
class	Events.InventoryStopEventData Represents Inventory stop event data.
class	Events.NXPEASAlarmEventData Gives the ID of the antenna which found an NXP tag with EAS bit set during EAS Scanning Also gives the alarm code returned by the tag during EAS scanning
class	Events.ReaderExceptionEventData Represents Reader Disconnect event data.
class	Events.ReadEventData Represents RFID Tag Data on read.
class	Events.TemperatureAlarmData Contains Temperature Alarm Event Data

Nested classes/interfaces inherited from class rfid.api.EventsAbstract

EventsAbstract.StatusEventData

Constructor Summary

Constructors

Constructor and Description
Events()

Method Summary

Modifier and Type	Method and Description
void	addEventsListener(RfidEventsListener rfidEventListener) Adds the Event Listener for reporting Tag Read and status notification
void	dispose()
API3Abstract	getApi3Abstract()
int	getEventHandle(RFID_EVENT_TYPE eventType)
java.lang.String	getHostName()
int	getReaderHandle()
rfid.api.RfidConnectionState	getRfidConnectionState()
int[]	initNotificationWaitHandles()
boolean	isAccessStartEventSet() Checks if Access Start Event Notification is enabled/disabled.
boolean	isAccessStopEventSet() Checks if Access Stop Event Notification is enabled/disabled.
boolean	isAntennaEventSet() Checks if Antenna Event Notification is enabled/disabled.
boolean	isAttachTagDataWithReadEventSet() Checks whether Attach Tag Data with Read Event is enabled/disabled
boolean	isBufferFullEventSet() Checks if Buffer Full Event is enabled or not
boolean	isBufferFullWarningEventSet() Checks if Buffer full warning Event Notification is enabled/disabled.
boolean	isEASAlarmEventSet() Checks NXP EAS Alarm Event Notification is enabled/disabled
boolean	isEventRegistered(RFID_EVENT_TYPE eventType)
boolean	isGPIEventSet() Checks if GPI Event Notification is enabled/disabled.
boolean	isHandheldEventSet() Checks Hand held Gun/Button event is enabled/disabled
boolean	isInventoryStartEventSet() Checks if Inventory Start Event Notification is enabled/disabled.
boolean	isInventoryStopEventSet() Checks if Inventory Stop Event Notification is enabled/disabled.
boolean	isReaderDisconnectEventSet() Checks if Reader Disconnection Event Notification is enabled/disabled.
boolean	isReaderExceptionEventSet() Event notifying that an exception has occurred in the Reader.
boolean	isTagReadEventSet() Checks Tag Read Event is enabled/disabled
boolean	isTemperatureAlarmEventSet() Checks if Temperature Event Notification is enabled/disabled.
void	notifyReadEvent()
void	notifyStatusEvent(EventsAbstract.StatusEventData statusEventData)
void	processReceivedEvents()
boolean	registerForNotification(RFID_EVENT_TYPE eventType)
void	removeEventsListener(RfidEventsListener rfidEventListener) Removes the Event Listener.
void	setAccessStartEvent(boolean notifyAccessStartEvent) To enable/disable Access Start Event Notification.
void	setAccessStopEvent(boolean notifyAccessStopEvent) To enable/disable Access Stop Event Notification.
void	setAntennaEvent(boolean notifyAntennaEvent) To enable/disable Antenna Event Notification.
void	setApi3Abstract(API3Abstract api3Abstract)
void	setAttachTagDataWithReadEvent(boolean attachTagDataWithReadEvent) Specified whether TagData should be reported along with the eventReadNotify method of RfidEventsListener interface.
void	setBufferFullEvent(boolean notifyBufferFullEvent) To Enable Buffer full Event Notification.
void	setBufferFullWarningEvent(boolean notifyBufferFullWarningEvent) To enable/disable Buffer full warning Event Notification.
void	setEASAlarmEvent(boolean notifyEASAlarmEvent) To enable/disable NXP_EAS_ALARM_EVENT Notification
void	setGPIEvent(boolean notifyGPIEvent) To enable/disable GPI Event Notification.
void	setHandheldEvent(boolean notifyHandheldEvent) To enable/disable A Hand held Gun/Button event - Pull/Release Notification
void	setInventoryStartEvent(boolean notifyInventoryStartEvent) To enable/disable Inventory Start Event Notification.
void	setInventoryStopEvent(boolean notifyInventoryStopEvent) To enable/disable Inventory Stop Event Notification.
void	setReaderDisconnectEvent(boolean notifyReaderDisconnectEvent) To enable/disable Reader Disconnection Event Notification.
void	setReaderExceptionEvent(boolean notifyReaderExceptionEvent) Event notifying that an exception has occurred in the Reader.
void	setReaderHandle(int m_hReaderHandle)
void	setRfidConnectionState(rfid.api.RfidConnectionState rfidConnectionState)
void	setTagReadEvent(boolean notifyTagReadEvent) Enables/Disables the Tag Read Notification If enabled, the eventReadNotify method of RfidEventsListener interface will be called to signal tag the notification.
void	setTemperatureAlarmEvent(boolean notifyTemperatureAlarmEvent) To enable/disable Temperature Alarm Notification.
void	startEventThreads()
boolean	unRegisterForNotification(RFID_EVENT_TYPE eventType)
int	WaitForMultipleObjects(int eventCount, int[] eventHandles, boolean waitAll, int milliSecondsToWait)
int	WaitForSingleObject(int eventHandle, int milliSecondsToWait)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Events

public Events()

Method Detail

dispose

public void dispose()

Specified by:

dispose in class EventsAbstract

getApi3Abstract

public API3Abstract getApi3Abstract()

Overrides:

getApi3Abstract in class EventsAbstract

setApi3Abstract

public void setApi3Abstract(API3Abstract api3Abstract)

Overrides:

setApi3Abstract in class EventsAbstract

isBufferFullEventSet

public boolean isBufferFullEventSet()

Checks if Buffer Full Event is enabled or not

Specified by:

isBufferFullEventSet in class EventsAbstract

setBufferFullEvent

public void setBufferFullEvent(boolean notifyBufferFullEvent)

To Enable Buffer full Event Notification.

Specified by:

setBufferFullEvent in class EventsAbstract

Parameters:

notifyBufferFullEvent - When the internal buffers are 100% full, BUFFER_FULL_EVENT will be notified every time a new tag report is received. The oldest TagData reports will be replaced by the newest in a circular FIFO manner.

isTagReadEventSet

public boolean isTagReadEventSet()

Checks Tag Read Event is enabled/disabled

Specified by:

isTagReadEventSet in class EventsAbstract

setTagReadEvent

public void setTagReadEvent(boolean notifyTagReadEvent)

Enables/Disables the Tag Read Notification If enabled, the eventReadNotify method of RfidEventsListener interface will be called to signal tag the notification. If setAttachTagDataWithReadEvent is set to true, the tag data will be reported in the RfidReadEvents else user needs to call Actions.getReadTags method for getting the bulk tags by providing number of tags to fetch.

Specified by:

setTagReadEvent in class EventsAbstract

isEASAlarmEventSet

public boolean isEASAlarmEventSet()

Checks NXP EAS Alarm Event Notification is enabled/disabled

Specified by:

isEASAlarmEventSet in class EventsAbstract

setEASAlarmEvent

public void setEASAlarmEvent(boolean notifyEASAlarmEvent)

To enable/disable NXP_EAS_ALARM_EVENT Notification

Specified by:

setEASAlarmEvent in class EventsAbstract

isHandheldEventSet

public boolean isHandheldEventSet()

Checks Hand held Gun/Button event is enabled/disabled

Specified by:

isHandheldEventSet in class EventsAbstract

setHandheldEvent

public void setHandheldEvent(boolean notifyHandheldEvent)

To enable/disable A Hand held Gun/Button event - Pull/Release Notification

Specified by:

setHandheldEvent in class EventsAbstract

isReaderExceptionEventSet

public boolean isReaderExceptionEventSet()

Event notifying that an exception has occurred in the Reader.

Specified by:

isReaderExceptionEventSet in class EventsAbstract

Returns:

Checks the Reader Exception Event Set state

setReaderExceptionEvent

public void setReaderExceptionEvent(boolean notifyReaderExceptionEvent)

Event notifying that an exception has occurred in the Reader. The Application can continue to use the connection if the reader renders is usable.

Specified by:

setReaderExceptionEvent in class EventsAbstract

Parameters:

notifyReaderExceptionEvent - To enable/disabled Reader Exception Event in the reader.

getRfidConnectionState

public rfid.api.RfidConnectionState getRfidConnectionState()

Specified by:

getRfidConnectionState in class EventsAbstract

Returns:

setRfidConnectionState

public void setRfidConnectionState(rfid.api.RfidConnectionState rfidConnectionState)

Specified by:

setRfidConnectionState in class EventsAbstract

Parameters:

rfidConnectionState -

isAccessStartEventSet

public boolean isAccessStartEventSet()

Checks if Access Start Event Notification is enabled/disabled.

Specified by:

isAccessStartEventSet in class EventsAbstract

setAccessStartEvent

public void setAccessStartEvent(boolean notifyAccessStartEvent)

To enable/disable Access Start Event Notification.

Specified by:

setAccessStartEvent in class EventsAbstract

isAccessStopEventSet

public boolean isAccessStopEventSet()

Checks if Access Stop Event Notification is enabled/disabled.

Specified by:

isAccessStopEventSet in class EventsAbstract

setAccessStopEvent

public void setAccessStopEvent(boolean notifyAccessStopEvent)

To enable/disable Access Stop Event Notification.

Specified by:

setAccessStopEvent in class EventsAbstract

isAntennaEventSet

public boolean isAntennaEventSet()

Checks if Antenna Event Notification is enabled/disabled. This event is generated when the Reader detects that an antenna is connected or disconnected

Specified by:

isAntennaEventSet in class EventsAbstract

setAntennaEvent

public void setAntennaEvent(boolean notifyAntennaEvent)

To enable/disable Antenna Event Notification. This event is generated when the Reader detects that an antenna is connected or disconnected

Specified by:

setAntennaEvent in class EventsAbstract

isBufferFullWarningEventSet

public boolean isBufferFullWarningEventSet()

Checks if Buffer full warning Event Notification is enabled/disabled. When the internal buffers are 90% full, BUFFER_FULL_WARNING_EVENT will be notified. When the buffers are 100% full, no more Tags can be stored in Dll or in the Reader, and further tags are discarded.

Specified by:

isBufferFullWarningEventSet in class EventsAbstract

setBufferFullWarningEvent

public void setBufferFullWarningEvent(boolean notifyBufferFullWarningEvent)

To enable/disable Buffer full warning Event Notification. When the internal buffers are 90% full, BUFFER_FULL_WARNING_EVENT will be notified. When the buffers are 100% full, no more Tags can be stored in Dll or in the Reader, and further tags are discarded.

Specified by:

setBufferFullWarningEvent in class EventsAbstract

isGPIEventSet

public boolean isGPIEventSet()

Checks if GPI Event Notification is enabled/disabled. GPI_EVENT will be signaled every time an enabled GPI changes state.

Specified by:

isGPIEventSet in class EventsAbstract

setGPIEvent

public void setGPIEvent(boolean notifyGPIEvent)

To enable/disable GPI Event Notification. GPI_EVENT will be signaled every time an enabled GPI changes state.

Specified by:

setGPIEvent in class EventsAbstract

isInventoryStartEventSet

public boolean isInventoryStartEventSet()

Checks if Inventory Start Event Notification is enabled/disabled.

Specified by:

isInventoryStartEventSet in class EventsAbstract

setInventoryStartEvent

public void setInventoryStartEvent(boolean notifyInventoryStartEvent)

To enable/disable Inventory Start Event Notification.

Specified by:

setInventoryStartEvent in class EventsAbstract

isInventoryStopEventSet

public boolean isInventoryStopEventSet()

Checks if Inventory Stop Event Notification is enabled/disabled.

Specified by:

isInventoryStopEventSet in class EventsAbstract

setInventoryStopEvent

public void setInventoryStopEvent(boolean notifyInventoryStopEvent)

To enable/disable Inventory Stop Event Notification.

Specified by:

setInventoryStopEvent in class EventsAbstract

isTemperatureAlarmEventSet

public boolean isTemperatureAlarmEventSet()

Checks if Temperature Event Notification is enabled/disabled. This event is generated when the Reader reaches Temperature Threshold

Specified by:

isTemperatureAlarmEventSet in class EventsAbstract

setTemperatureAlarmEvent

public void setTemperatureAlarmEvent(boolean notifyTemperatureAlarmEvent)

To enable/disable Temperature Alarm Notification. This event is generated when the Reader reaches Temperature Threshold

Specified by:

setTemperatureAlarmEvent in class EventsAbstract

isReaderDisconnectEventSet

public boolean isReaderDisconnectEventSet()

Checks if Reader Disconnection Event Notification is enabled/disabled. The Application can call Reconnect() to manually reconnect to the Reader Or opt for auto-reconnection. To cleanup and exit the application can call Disconnect().

Specified by:

isReaderDisconnectEventSet in class EventsAbstract

setReaderDisconnectEvent

public void setReaderDisconnectEvent(boolean notifyReaderDisconnectEvent)

To enable/disable Reader Disconnection Event Notification. The Application can call Reconnect() to manually reconnect to the Reader Or opt for auto-reconnection. To cleanup and exit the application can call Disconnect().

Specified by:

setReaderDisconnectEvent in class EventsAbstract

isAttachTagDataWithReadEventSet

public boolean isAttachTagDataWithReadEventSet()

Checks whether Attach Tag Data with Read Event is enabled/disabled

Specified by:

isAttachTagDataWithReadEventSet in class EventsAbstract

setAttachTagDataWithReadEvent

public void setAttachTagDataWithReadEvent(boolean attachTagDataWithReadEvent)

Specified whether TagData should be reported along with the eventReadNotify method of RfidEventsListener interface. If the Tag population is less, the application can fetch the tags with the attachTagDataWithReadEvent set to true. But when there is a huge tag population or when the speed of processing tags is critical it is advisable to set attachTagDataWithReadEvent to false and fetch the tags using getReadTags() method from another thread (and not directly from the registered tag read handler)

Specified by:

setAttachTagDataWithReadEvent in class EventsAbstract

getReaderHandle

public int getReaderHandle()

Specified by:

getReaderHandle in class EventsAbstract

setReaderHandle

public void setReaderHandle(int m_hReaderHandle)

Specified by:

setReaderHandle in class EventsAbstract

getHostName

public java.lang.String getHostName()

Overrides:

getHostName in class EventsAbstract

registerForNotification

public boolean registerForNotification(RFID_EVENT_TYPE eventType)

Specified by:

registerForNotification in class EventsAbstract

unRegisterForNotification

public boolean unRegisterForNotification(RFID_EVENT_TYPE eventType)

Specified by:

unRegisterForNotification in class EventsAbstract

startEventThreads

public void startEventThreads()

Specified by:

startEventThreads in class EventsAbstract

initNotificationWaitHandles

public int[] initNotificationWaitHandles()

Specified by:

initNotificationWaitHandles in class EventsAbstract

isEventRegistered

public boolean isEventRegistered(RFID_EVENT_TYPE eventType)

Specified by:

isEventRegistered in class EventsAbstract

getEventHandle

public int getEventHandle(RFID_EVENT_TYPE eventType)

Specified by:

getEventHandle in class EventsAbstract

addEventsListener

public void addEventsListener(RfidEventsListener rfidEventListener)

Adds the Event Listener for reporting Tag Read and status notification

Specified by:

addEventsListener in class EventsAbstract

removeEventsListener

public void removeEventsListener(RfidEventsListener rfidEventListener)

Removes the Event Listener. Reporting of Tag Read and status notifications will be stopped

Specified by:

removeEventsListener in class EventsAbstract

Parameters:

rfidEventListener -

WaitForMultipleObjects

public int WaitForMultipleObjects(int eventCount,
                                  int[] eventHandles,
                                  boolean waitAll,
                                  int milliSecondsToWait)

Specified by:

WaitForMultipleObjects in class EventsAbstract

WaitForSingleObject

public int WaitForSingleObject(int eventHandle,
                               int milliSecondsToWait)

Specified by:

WaitForSingleObject in class EventsAbstract

processReceivedEvents

public void processReceivedEvents()

Specified by:

processReceivedEvents in class EventsAbstract

notifyReadEvent

public void notifyReadEvent()

Specified by:

notifyReadEvent in class EventsAbstract

notifyStatusEvent

public void notifyStatusEvent(EventsAbstract.StatusEventData statusEventData)

Specified by:

notifyStatusEvent in class EventsAbstract