io.dvlopt.linux.gpio

Class GpioEventWatcher

java.lang.Object

io.dvlopt.linux.gpio.GpioEventWatcher

All Implemented Interfaces:

AutoCloseable

public class GpioEventWatcher
extends Object
implements AutoCloseable

Class for efficiently monitoring several GPIO events at once.

Constructor Summary

Constructors

Constructor and Description
GpioEventWatcher() Basic constructor allocating the needed resources.

Method Summary

Modifier and Type	Method and Description
GpioEventWatcher	addHandle(GpioEventHandle handle, int id) Adds a GPIO event to monitor.
void	close() Closes this instance and release associated resources.
GpioEventWatcher	removeHandle(GpioEventHandle handle) Removes a GPIO event from being monitored.
boolean	waitForEvent(GpioEvent data) Waits forever until a GPIO event occurs.
boolean	waitForEvent(GpioEvent data, int timeout) Waits `timeout` milliseconds at most until a GPIO event occurs.

Methods inherited from class java.lang.Object

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

Constructor Detail

GpioEventWatcher

public GpioEventWatcher()
                 throws LinuxException

Basic constructor allocating the needed resources.

Throws:

LinuxException - When something fails on the native side.

Method Detail

addHandle

public GpioEventWatcher addHandle(GpioEventHandle handle,
                                  int id)
                           throws LinuxException

Adds a GPIO event to monitor.

Parameters:

handle - The GPIO event handle to monitor.

id - An arbitrary identifier so that when this event happens, it can be recognized by the user.

Returns:

This GpioEventWatcher.

Throws:

LinuxException - When something fails on the native side.

removeHandle

public GpioEventWatcher removeHandle(GpioEventHandle handle)
                              throws LinuxException

Removes a GPIO event from being monitored.

Parameters:

handle - The GPIO event handle to remove.

Returns:

This GpioEventWatcher.

Throws:

LinuxException - When something fails on the native side.

waitForEvent

public boolean waitForEvent(GpioEvent data)
                     throws LinuxException

Waits forever until a GPIO event occurs.

Parameters:

data - Where information about the event will be written.

Returns:

A boolean whether something happened or not.

Throws:

LinuxException - When something fails on the native side.

waitForEvent

public boolean waitForEvent(GpioEvent data,
                            int timeout)
                     throws LinuxException

Waits `timeout` milliseconds at most until a GPIO event occurs.

Parameters:

data - Where information about the event will be written.

timeout - A timeout in milliseconds where -1 means forever.

Returns:

A boolean whether something happend or not within the given timeout.

Throws:

LinuxException - When something fails on the native side.

close

public void close()
           throws LinuxException

Closes this instance and release associated resources.

The previously registered GPIO event handles WILL NOT be closed.

Specified by:

close in interface AutoCloseable

Throws:

LinuxException - When something fails on the native side.