jdk.dio

Interface BufferAccess<B extends java.nio.Buffer>

Type Parameters:

B - the I/O buffer type.

All Known Subinterfaces:

ADCChannel, DACChannel, GenericBufferIODevice, I2CDevice, ModemUART, PWMChannel, SPIDevice, UART

public interface BufferAccess<B extends java.nio.Buffer>

The BufferAccess interface provides methods for getting access to the device (or the driver thereof) I/O buffers, if any.

Method Summary

Methods

Modifier and Type	Method and Description
B	getInputBuffer() Gets the direct input buffer of this device (optional operation).
B	getOutputBuffer() Gets the direct output buffer of this device (optional operation).

Method Detail

getInputBuffer

B getInputBuffer()
                                         throws ClosedDeviceException,
                                                java.io.IOException

Gets the direct input buffer of this device (optional operation).

Note that the input buffer will get allocated on a per-application basis to avoid conflicts; but that only one such buffer will be allocated per application. The capacity of the buffer will be determined based on the property of the underlying device.

When the returned Buffer instance is invalidated because the device is either closed or in exclusive use by some other application then an attempt to access the Buffer instance will not change the buffer's content and will cause a ClosedDeviceException or some other unspecified exception to be thrown either at the time of the access or at some later time.

Returns:

the direct input buffer of this device.

Throws:

java.lang.UnsupportedOperationException - if this device (or driver thereof) does not have or does not allow direct access to its input buffer.

ClosedDeviceException - if the device has been closed.

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

getOutputBuffer

B getOutputBuffer()
                                          throws ClosedDeviceException,
                                                 java.io.IOException

Gets the direct output buffer of this device (optional operation).

Note that the output buffer will get allocated on a per-application basis to avoid conflicts; but that only one such buffer will be allocated per application. The capacity of the buffer will be determined based on the property of the underlying device.

When the returned Buffer instance is invalidated because the device is either closed or in exclusive use by some other application then an attempt to access the Buffer instance will not change the buffer's content and will cause a ClosedDeviceException or some other unspecified exception to be thrown either at the time of the access or at some later time.

Returns:

the direct output buffer of this device.

Throws:

java.lang.UnsupportedOperationException - if this device (or driver thereof) does not have or does not allow direct access to its output buffer.

ClosedDeviceException - if the device has been closed.

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