com.serialpundit.hid

Interface IHIDInputReportListener

public interface IHIDInputReportListener

The interface IHIDInputReportListener should be implemented by class who wish to receive input reports from HID device whenever an input report is received by host computer.

Author:

Rishi Gupta

Method Summary

Methods

Modifier and Type	Method and Description
void	onNewInputReportAvailable(int numOfBytesRead, byte[] reportBuffer) This method gets called whenever an input report is received by host computer.
void	onNewInputReportAvailableError(Exception e) If any exception occurs while worker thread was waiting for new input report or while reading it, worker thread calls this method passing the error information.

Method Detail

onNewInputReportAvailable

void onNewInputReportAvailable(int numOfBytesRead,
                             byte[] reportBuffer)

This method gets called whenever an input report is received by host computer.

The class implementing this interface is expected to override onNewInputReportAvailable() method. This method gets called from a Java worker thread.

The argument numOfBytesRead contains the size of input report and reportBuffer contains input report read from device. If the device uses numbered reports, first byte in reportBuffer array will be report number. If the device does not uses numbered reports, first byte in reportBuffer will be beginning of data itself. The reportBuffer reference is same as what was passed when registering this listener.

Parameters:

numOfBytesRead - number of bytes read from HID device as input report.

reportBuffer - byte array that will contain data read from HID device.

onNewInputReportAvailableError

void onNewInputReportAvailableError(Exception e)

If any exception occurs while worker thread was waiting for new input report or while reading it, worker thread calls this method passing the error information.

Parameters:

e - exception instance.