com.oracle.deviceaccess.generic

Interface GenericBufferIODevice

All Superinterfaces:

java.lang.AutoCloseable, BufferAccess<java.nio.ByteBuffer>, java.nio.channels.ByteChannel, java.nio.channels.Channel, java.io.Closeable, GenericDevice, Peripheral<GenericDevice>, java.nio.channels.ReadableByteChannel, java.nio.channels.WritableByteChannel

public interface GenericBufferIODevice
extends GenericDevice, java.nio.channels.ByteChannel, BufferAccess<java.nio.ByteBuffer>

The GenericBufferIODevice interface defines generic methods for accessing and controlling peripheral devices using read and write operations.

A platform implementer may allow through this interface access and control of peripheral devices for which there exist no other more specific API such as SPIDevice or I2CDevice.

Field Summary

Fields inherited from interface com.oracle.deviceaccess.Peripheral

BIG_ENDIAN, LITTLE_ENDIAN, MIXED_ENDIAN

Method Summary

Methods

Modifier and Type	Method and Description
int	read(java.nio.ByteBuffer dst) Reads a sequence of bytes from this device into the given buffer.
int	read(int skip, java.nio.ByteBuffer dst) Reads a sequence of bytes from this device into the given buffer, skipping the first skip bytes read.
int	write(java.nio.ByteBuffer src) Writes a sequence of bytes to this device from the given buffer.

Methods inherited from interface com.oracle.deviceaccess.generic.GenericDevice

getControl, setControl, setEventListener

Methods inherited from interface com.oracle.deviceaccess.Peripheral

close, getDescriptor, isOpen, tryLock, unlock

Methods inherited from interface com.oracle.deviceaccess.BufferAccess

getInputBuffer, getOutputBuffer

Method Detail

read

int read(java.nio.ByteBuffer dst)
         throws java.io.IOException,
                UnavailablePeripheralException,
                ClosedPeripheralException

Reads a sequence of bytes from this device into the given buffer.

Note that the availability of new input data may be notified through an GenericEvent with ID GenericEvent.INPUT_DATA_AVAILABLE.

Specified by:

read in interface java.nio.channels.ReadableByteChannel

Parameters:

dst - The buffer into which bytes are to be transferred.

Returns:

The number of bytes read, possibly zero, or -1 if the device has reached end-of-stream

Throws:

java.lang.NullPointerException - If dst is null.

UnavailablePeripheralException - if this peripheral is not currently available - such as it is locked by another application.

ClosedPeripheralException - if the peripheral has been closed.

java.io.IOException - if an I/O error occurred such as the device is not readable.

read

int read(int skip,
       java.nio.ByteBuffer dst)
         throws java.io.IOException,
                UnavailablePeripheralException,
                ClosedPeripheralException

Reads a sequence of bytes from this device into the given buffer, skipping the first skip bytes read.

Apart from skipping the first skip bytes, this method behaves identically to read(java.nio.ByteBuffer).

Parameters:

skip - the number of read bytes that must be ignored/skipped before filling in the dst buffer.

dst - The buffer into which bytes are to be transferred.

Returns:

The number of bytes read, possibly zero, or -1 if the device has reached end-of-stream

Throws:

java.lang.NullPointerException - If dst is null.

UnavailablePeripheralException - if this peripheral is not currently available - such as it is locked by another application.

ClosedPeripheralException - if the peripheral has been closed.

java.io.IOException - if an I/O error occurred such as the device is not readable.

write

int write(java.nio.ByteBuffer src)
          throws java.io.IOException,
                 UnavailablePeripheralException,
                 ClosedPeripheralException

Writes a sequence of bytes to this device from the given buffer.

Note that an empty output buffer condition may be notified through an GenericEvent with ID GenericEvent.OUTPUT_BUFFER_EMPTY.

Specified by:

write in interface java.nio.channels.WritableByteChannel

Parameters:

src - The buffer from which bytes are to be retrieved.

Returns:

The number of bytes written, possibly zero.

Throws:

java.lang.NullPointerException - If src is null.

UnavailablePeripheralException - if this peripheral is not currently available - such as it is locked by another application.

ClosedPeripheralException - if the peripheral has been closed.

java.io.IOException - if an I/O error occurred such as the device is not writable.