com.oracle.deviceaccess.modem

Interface ModemSignalsControl

All Known Subinterfaces:

ATModem, ModemUART

public interface ModemSignalsControl

The ModemSignalsControl interface provides methods for controlling and monitoring modem signals.

Field Summary

Fields

Modifier and Type	Field and Description
static int	CTS_SIGNAL Clear To Send (CTS) signal.
static int	DCD_SIGNAL Data Carrier Detect (DCD) signal.
static int	DSR_SIGNAL Data Set Ready (DSR) signal.
static int	DTR_SIGNAL Data Terminal Ready (DTR) signal.
static int	RI_SIGNAL Ring Indicator (RI) signal.
static int	RTS_SIGNAL Ready To Send (RTS) signal.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	getSignalState(int signalID) Gets the state of the designated signal.
void	setSignalChangeListener(ModemSignalListener listener, int signals) Registers a ModemSignalListener instance which will get asynchronously notified when one of the designated signals changes.
void	setSignalState(int signalID, boolean state) Sets or clears the designated signal.

Field Detail

CTS_SIGNAL

static final int CTS_SIGNAL

Clear To Send (CTS) signal.

This bit flag can be bitwise-combined (OR) with other signal bit flags.

See Also:

Constant Field Values

DCD_SIGNAL

static final int DCD_SIGNAL

Data Carrier Detect (DCD) signal.

This bit flag can be bitwise-combined (OR) with other signal bit flags.

See Also:

Constant Field Values

DSR_SIGNAL

static final int DSR_SIGNAL

Data Set Ready (DSR) signal.

This bit flag can be bitwise-combined (OR) with other signal bit flags.

See Also:

Constant Field Values

DTR_SIGNAL

static final int DTR_SIGNAL

Data Terminal Ready (DTR) signal.

This bit flag can be bitwise-combined (OR) with other signal bit flags.

See Also:

Constant Field Values

RI_SIGNAL

static final int RI_SIGNAL

Ring Indicator (RI) signal.

This bit flag can be bitwise-combined (OR) with other signal bit flags.

See Also:

Constant Field Values

RTS_SIGNAL

static final int RTS_SIGNAL

Ready To Send (RTS) signal.

This bit flag can be bitwise-combined (OR) with other signal bit flags.

See Also:

Constant Field Values

Method Detail

getSignalState

boolean getSignalState(int signalID)
                       throws java.io.IOException,
                              PeripheralNotAvailableException

Gets the state of the designated signal.

Parameters:

signalID - the ID of the signal (DCD_SIGNAL, DSR_SIGNAL , RI_SIGNAL or CTS_SIGNAL).

Returns:

the state of the designated signal: true for set; false for cleared.

Throws:

java.lang.IllegalArgumentException - if signalID is not one of the defined values.

java.io.IOException - if an IO error occurred.

PeripheralNotAvailableException - if the peripheral is not currently available (has been closed).

com.oracle.deviceaccess.InvalidOperationException - if the specified signal is not supported by the underlying peripheral device hardware.

setSignalChangeListener

void setSignalChangeListener(ModemSignalListener listener,
                           int signals)
                             throws java.io.IOException,
                                    PeripheralNotAvailableException

Registers a ModemSignalListener instance which will get asynchronously notified when one of the designated signals changes. Notification will automatically begin after registration completes.

If listener is null then the previously registered listener will be removed.

Only one listener can be registered at a particular time.

Parameters:

listener - the ModemSignalListener instance to be notified when a signal state changes.

signals - the signals to monitor (bit-wise combination of the signal IDs: DCD_SIGNAL, DSR_SIGNAL, RI_SIGNAL or CTS_SIGNAL).

Throws:

java.io.IOException - if an IO error occurred.

PeripheralNotAvailableException - if the peripheral is not currently available (has been closed).

java.lang.IllegalArgumentException - if signals is not a bit-wise combination of valid signal IDs.

InvalidStateException - if listener is not null and a listener is already registered for any of the specified signals.

com.oracle.deviceaccess.InvalidOperationException - if the specified signal is not supported by the underlying peripheral device hardware.

setSignalState

void setSignalState(int signalID,
                  boolean state)
                    throws java.io.IOException,
                           PeripheralNotAvailableException

Sets or clears the designated signal.

Parameters:

signalID - the ID of the signal (DTR_SIGNAL or RTS_SIGNAL).

state - true to set; false to clear.

Throws:

java.lang.IllegalArgumentException - if signalID is not one of the defined values.

java.io.IOException - if an IO error occurred.

PeripheralNotAvailableException - if the peripheral is not currently available (has been closed).

com.oracle.deviceaccess.InvalidOperationException - if the specified signal is not supported by the underlying peripheral device hardware.