org.jperipheral

Interface Peripheral

All Known Implementing Classes:

SerialPort

public interface Peripheral

A peripheral.

Author:

Gili Tzabari

Method Summary

Methods

Modifier and Type	Method and Description
String	getName() Returns the peripheral name.
AsynchronousByteChannel	newAsynchronousChannel(PeripheralChannelGroup group) Returns a new AsynchronousChannel for communicating with the peripheral.
AsynchronousByteChannel	newAsynchronousChannel(PeripheralChannelGroup group, long timeout, TimeUnit unit) Returns a new AsynchronousChannel for communicating with the peripheral.

Method Detail

getName

String getName()

Returns the peripheral name.

Returns:

the peripheral name

newAsynchronousChannel

AsynchronousByteChannel newAsynchronousChannel(PeripheralChannelGroup group)
                                               throws PeripheralNotFoundException,
                                                      PeripheralInUseException

Returns a new AsynchronousChannel for communicating with the peripheral.

Parameters:

group - the channel group

Returns:

a AsynchronousChannel for communicating with the peripheral

Throws:

PeripheralNotFoundException - if the comport does not exist

PeripheralInUseException - if the peripheral is locked by another process

NullPointerException - if group is null

newAsynchronousChannel

AsynchronousByteChannel newAsynchronousChannel(PeripheralChannelGroup group,
                                             long timeout,
                                             TimeUnit unit)
                                               throws PeripheralNotFoundException,
                                                      PeripheralInUseException

Returns a new AsynchronousChannel for communicating with the peripheral.

Parameters:

group - the channel group

timeout - the minimum amount of time to wait if the peripheral is locked by another process before giving up

unit - the unit of timeout

Returns:

a AsynchronousChannel for communicating with the peripheral

Throws:

PeripheralNotFoundException - if the comport does not exist

PeripheralInUseException - if the peripheral is locked by another process

NullPointerException - if group is null