com.oracle.deviceaccess.spi

Class AbstractPeripheral<P extends Peripheral<? super P>>

java.lang.Object

com.oracle.deviceaccess.spi.AbstractPeripheral<P>

Type Parameters:

P - the peripheral type the descriptor is defined for.

All Implemented Interfaces:

Peripheral<P>, java.io.Closeable, java.lang.AutoCloseable, java.nio.channels.Channel

public abstract class AbstractPeripheral<P extends Peripheral<? super P>>
extends java.lang.Object
implements Peripheral<P>

The AbstractPeripheral class is the base implementation for Peripheral-implementing classes instantiated by PeripheralProvider.
This class encapsulates the low-level machinery required to implement platform-wide locking for exclusive access. It also provides methods that allow for retrieving the PeripheralDescriptor of Peripheral instances.

Field Summary

Fields inherited from interface com.oracle.deviceaccess.Peripheral

BIG_ENDIAN, LITTLE_ENDIAN, MIXED_ENDIAN

Constructor Summary

Constructors

Constructor and Description
AbstractPeripheral()

Method Summary

Methods

Modifier and Type	Method and Description
<U extends P> PeripheralDescriptor<U>	getDescriptor() Retrieves the identifying and descriptive information of this peripheral device.
void	tryLock(int timeout) Attempts to lock for (platform-wide) exclusive access the underlying peripheral device resource.
void	unlock() Releases from (platform-wide) exclusive access the underlying peripheral device resource.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.oracle.deviceaccess.Peripheral

close, isOpen

Constructor Detail

AbstractPeripheral

public AbstractPeripheral()

Method Detail

tryLock

public void tryLock(int timeout)
             throws UnavailablePeripheralException,
                    ClosedPeripheralException,
                    java.io.IOException

Attempts to lock for (platform-wide) exclusive access the underlying peripheral device resource. This method will block until the designated peripheral device resource becomes available for exclusive access or the specified amount of real time has elapsed. A timeout of 0 means to wait forever.

This method returns silently if the underlying peripheral device resource is currently acquired for exclusive access.

Specified by:

tryLock in interface Peripheral<P extends Peripheral<? super P>>

Parameters:

timeout - the timeout in milliseconds.

Throws:

java.lang.IllegalArgumentException - if timeout is negative.

UnavailablePeripheralException - if this peripheral is not currently available.

ClosedPeripheralException - if this peripheral has been closed.

java.io.IOException - if any other I/O error occurred.

unlock

public void unlock()
            throws java.io.IOException

Releases from (platform-wide) exclusive access the underlying peripheral device resource.

This method returns silently if the underlying peripheral device resource is not currently acquired for exclusive access or has already been closed.

Specified by:

unlock in interface Peripheral<P extends Peripheral<? super P>>

Throws:

java.io.IOException - if any other I/O error occurred.

getDescriptor

public final <U extends P> PeripheralDescriptor<U> getDescriptor()

Retrieves the identifying and descriptive information of this peripheral device.

Specified by:

getDescriptor in interface Peripheral<P extends Peripheral<? super P>>

Type Parameters:

U - this Peripheral type or a subtype of it (allows for subclassing Peripheral types - see UART and ModemUART).

Returns:

the PeripheralDescriptor which encapsulates the identifying and descriptive information of this peripheral device.