io.dvlopt.linux.gpio

Class GpioHandleRequest

java.lang.Object

io.dvlopt.linux.gpio.GpioHandleRequest

public class GpioHandleRequest
extends Object

Class representing a request for obtaining a GPIO handle for controlling the needed lines.

Several lines can be requested at once and the resulting handle allows the user to control them all at once. In practise, there is no garantee that any kind of IO will be atomic, actually happening at the exact same time for all the lines. This depends on the underlying driver and is opaque to this library and user space in general.

See Also:

GpioBuffer, GpioFlags, GpioHandle

Constructor Summary

Constructors

Constructor and Description
GpioHandleRequest() Basic constructor, by default lines will be requested as they are.

Method Summary

Modifier and Type	Method and Description
GpioLine	addLine(int lineNumber) Adds a GPIO line to the request.
GpioLine	addLine(int lineNumber, boolean value) Adds a GPIO line to the request with a default value.
String	getConsumer() Retrieves the consumer of this request.
GpioFlags	getFlags() Retrieves the flags specifying how the lines will be handled.
GpioHandleRequest	setConsumer(String consumer) Sets the consumer of the requested lines.
GpioHandleRequest	setFlags(GpioFlags flags) Sets flags specifying how the lines will be handled.
GpioHandleRequest	unsetFlags() The lines will be requested as they are.

Methods inherited from class java.lang.Object

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

Constructor Detail

GpioHandleRequest

public GpioHandleRequest()

Basic constructor, by default lines will be requested as they are.

Method Detail

setFlags

public GpioHandleRequest setFlags(GpioFlags flags)

Sets flags specifying how the lines will be handled.

Parameters:

flags - Prepared flags.

Returns:

This GpioHandleRequest.

unsetFlags

public GpioHandleRequest unsetFlags()

The lines will be requested as they are.

Returns:

ThisGpioHandleRequest.

getFlags

public GpioFlags getFlags()

Retrieves the flags specifying how the lines will be handled.

Returns:

The flags.

getConsumer

public String getConsumer()

Retrieves the consumer of this request.

Returns:

A string representing the consumer or null.

setConsumer

public GpioHandleRequest setConsumer(String consumer)

Sets the consumer of the requested lines.

Parameters:

consumer - String representing the consumer, length must be smaller than 32.

Returns:

This GpioHandleRequest.

addLine

public GpioLine addLine(int lineNumber)

Adds a GPIO line to the request.

A handle can drive at most 64 lines at once.

Parameters:

lineNumber - Which line.

Returns:

A GPIO line useful for handling a buffer.

See Also:

GpioBuffer

addLine

public GpioLine addLine(int lineNumber,
                        boolean value)

Adds a GPIO line to the request with a default value.

A handle can drive at most 64 lines.

Providing a default value works only for outputs and will be ignored for inputs.

Parameters:

lineNumber - Which line.

value - Default value.

Returns:

A GPIO line useful for handling a buffer.

See Also:

GpioBuffer