jdk.dio.generic

Interface GenericDevice

All Superinterfaces:

java.lang.AutoCloseable, java.nio.channels.Channel, java.io.Closeable, Device<GenericDevice>

All Known Subinterfaces:

GenericBufferIODevice

public interface GenericDevice
extends Device<GenericDevice>

The GenericDevice interface defines methods for setting and getting device-specific configuration and access (I/O) controls as well as registering event listeners.

A generic device may be identified by the numeric ID and by the name (if any defined) that correspond to its registered configuration. An GenericDevice instance can be opened by a call to one of the DeviceManager.open(id,...) methods using its ID or by a call to one of the DeviceManager.open(name,...) methods using its name.

An application can set and get configuration and access (I/O) controls. A control is identified by a GenericDeviceControl instance and can be set or gotten using the setControl and getControl methods. Controls can be used to configured a device a well as performing basic input/output operations. The list of controls supported by a device is device-specific.

An application can also register an GenericEventListener instance to monitor native events of the designated type fired by the device. To register a GenericEventListener instance, the application must call the setEventListener method. The registered listener can later on be removed by calling the same method with a null listener parameter. Asynchronous notification may not be supported by all devices. An attempt to set a listener on a device which does not supports it will result in an UnsupportedOperationException being thrown.

A platform implementer may allow through this interface access and control of devices which do not require read and write operations and for which there exist no other more specific API such as GPIOPin or GPIOPort.

Since:

1.0

See Also:

GenericEventListener, GenericDeviceControl, GenericPermission

Field Summary

Fields inherited from interface jdk.dio.Device

BIG_ENDIAN, LITTLE_ENDIAN, MIXED_ENDIAN

Method Summary

Methods

Modifier and Type	Method and Description
<T> T	getControl(GenericDeviceControl<T> control) Gets the value of the specified control.
<T> void	setControl(GenericDeviceControl<T> control, T value) Sets the value of the specified control.
void	setEventListener(int eventId, GenericEventListener listener) Registers a GenericEventListener instance to monitor native events of the designated type fired by the device associated to this GenericDevice object.

Methods inherited from interface jdk.dio.Device

close, getByteOrder, getDescriptor, isOpen, tryLock, unlock

Method Detail

getControl

<T> T getControl(GenericDeviceControl<T> control)
             throws java.io.IOException,
                    UnavailableDeviceException,
                    ClosedDeviceException

Gets the value of the specified control.

Type Parameters:

T - the type of the control's value.

Parameters:

control - the control to get.

Returns:

the value of the specified control.

Throws:

java.lang.IllegalArgumentException - if control is not recognized or invalid.

java.io.IOException - if some other I/O error occurs.

UnavailableDeviceException - if this device is not currently available - such as it is locked by another application.

ClosedDeviceException - if the device has been closed.

setControl

<T> void setControl(GenericDeviceControl<T> control,
                  T value)
                throws java.io.IOException,
                       UnavailableDeviceException,
                       ClosedDeviceException

Sets the value of the specified control.

Type Parameters:

T - the type of the control's value.

Parameters:

control - the control to set.

value - the value to set.

Throws:

java.lang.IllegalArgumentException - if control is not recognized or invalid.

java.io.IOException - if some other I/O error occurs.

UnavailableDeviceException - if this device is not currently available - such as it is locked by another application.

ClosedDeviceException - if the device has been closed.

setEventListener

void setEventListener(int eventId,
                    GenericEventListener listener)
                      throws java.io.IOException,
                             ClosedDeviceException

Registers a GenericEventListener instance to monitor native events of the designated type fired by the device associated to this GenericDevice object. While the listener can be triggered by hardware interrupts, there are no real-time guarantees of when the listener will be called.

A list of event type IDs is defined in GenericEvent. This list can be extended with device-specific IDs.

If this GenericDevice is open in DeviceManager.SHARED access mode the listeners registered by all the applications sharing the underlying device will get notified of the events they registered for.

If listener is null then the listener previously registered for the specified event type will be removed.

Only one listener can be registered at a particular time for a particular event type.

Parameters:

eventId - ID of the native event to listen to.

listener - the GenericEventListener instance to be notified upon occurrence of the designated event.

Throws:

java.io.IOException - if some other I/O error occurs.

java.lang.IllegalArgumentException - if eventId does not correspond to any supported event.

java.lang.UnsupportedOperationException - if this GenericDevice object does not support asynchronous event notification.

java.lang.IllegalStateException - if listener is not null and a listener is already registered for the specified event type.

ClosedDeviceException - if the device has been closed.