io.dvlopt.linux.gpio

Class GpioEventHandle

java.lang.Object

io.dvlopt.linux.gpio.GpioEventHandle

All Implemented Interfaces:

AutoCloseable

public class GpioEventHandle
extends Object
implements AutoCloseable

Class for controlling a GPIO line that can be monitored for interrupts.

See Also:

GpioEventWatcher

Method Summary

Modifier and Type	Method and Description
void	close() Closes this GPIO handle and releases resources.
GpioLine	getLine() Retrieves the GPIO line associated with this handle.
void	read(GpioBuffer buffer) Reads the current state of the line this handle controls and write it back to the given buffer.
GpioEvent	waitForEvent() Waits for an event to happen.
GpioEvent	waitForEvent(GpioEvent data) Waits for an event to happen and writes what happened to the given `data` object.

Methods inherited from class java.lang.Object

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

Method Detail

getLine

public GpioLine getLine()

Retrieves the GPIO line associated with this handle.

Returns:

The GPIO line.

read

public void read(GpioBuffer buffer)
          throws LinuxException

Reads the current state of the line this handle controls and write it back to the given buffer.

Parameters:

buffer - Buffer meant to hold the data.

Throws:

LinuxException - When something fails on the native side.

waitForEvent

public GpioEvent waitForEvent()
                       throws LinuxException

Waits for an event to happen.

Returns:

Information about what happened.

Throws:

LinuxException - When something fails on the native side.

waitForEvent

public GpioEvent waitForEvent(GpioEvent data)
                       throws LinuxException

Waits for an event to happen and writes what happened to the given `data` object.

Parameters:

data - Object for holding data about what happened.

Returns:

Information about what happened.

Throws:

LinuxException - When something fails on the native side.

close

public void close()
           throws LinuxException

Closes this GPIO handle and releases resources.

Specified by:

close in interface AutoCloseable

Throws:

LinuxException - When something fails on the native side.