io.dvlopt.linux.gpio

Class GpioEventRequest

java.lang.Object

io.dvlopt.linux.gpio.GpioEventRequest

public class GpioEventRequest
extends Object

Class representing a request for obtaining a GPIO event handle for reading a line and especially setting edge-detection.

Edge-detection is monitoring changes of state, for instance when the line goes from low to high.

Constructor Summary

Constructors

Constructor and Description
GpioEventRequest(int line) Basic constructor requesting a regular input for both rising and falling edge.
GpioEventRequest(int line, GpioEdgeDetection edgeDetection) Constructor requesting a regular input leaving the choice of edge-detection.
GpioEventRequest(int line, GpioEdgeDetection edgeDetection, GpioFlags flags) Constructor leaving all configuration to the user.

Method Summary

Modifier and Type	Method and Description
String	getConsumer() Retrieves the consumer this line will be request under.
GpioEdgeDetection	getEdgeDetection() Retrieves what kind of edge-detection this request if for.
GpioFlags	getFlags()
int	getLine() Retrieves which line will be requested.
GpioEventRequest	setConsumer(String consumer) Sets the consumer this line will be request under.
GpioEventRequest	setEdgeDetection(GpioEdgeDetection edgeDetection) Selects edge-detection.
GpioEventRequest	setFlags(GpioFlags flags)
GpioEventRequest	setLine(int line) Selects which line will be requested.
GpioEventRequest	unsetFlags()

Methods inherited from class java.lang.Object

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

Constructor Detail

GpioEventRequest

public GpioEventRequest(int line)

Basic constructor requesting a regular input for both rising and falling edge.

Parameters:

line - The number of the line.

GpioEventRequest

public GpioEventRequest(int line,
                        GpioEdgeDetection edgeDetection)

Constructor requesting a regular input leaving the choice of edge-detection.

Parameters:

line - The number of the line.

edgeDetection - The kind of edge-detection.

GpioEventRequest

public GpioEventRequest(int line,
                        GpioEdgeDetection edgeDetection,
                        GpioFlags flags)

Constructor leaving all configuration to the user.

Parameters:

line - The number of the line.

edgeDetection - The kind of edge-detection.

flags - Flags describing how the line will be handled.

Method Detail

setFlags

public GpioEventRequest setFlags(GpioFlags flags)

unsetFlags

public GpioEventRequest unsetFlags()

getFlags

public GpioFlags getFlags()

getEdgeDetection

public GpioEdgeDetection getEdgeDetection()

Retrieves what kind of edge-detection this request if for.

Returns:

The kind of edge-detection.

setEdgeDetection

public GpioEventRequest setEdgeDetection(GpioEdgeDetection edgeDetection)

Selects edge-detection.

Parameters:

edgeDetection - The kind of edge-detection.

Returns:

This GpioEventRequest.

getLine

public int getLine()

Retrieves which line will be requested.

Returns:

The number of the line.

setLine

public GpioEventRequest setLine(int line)

Selects which line will be requested.

Parameters:

line - The number of the line.

Returns:

This GpioEventRequest.

getConsumer

public String getConsumer()

Retrieves the consumer this line will be request under.

Returns:

The name of the consumer.

setConsumer

public GpioEventRequest setConsumer(String consumer)

Sets the consumer this line will be request under.

Parameters:

consumer - The name of the consumer, length must be smaller than 32.

Returns:

This GpioEventRequest.