A B C D E F G H I J L M N O P R S T V W

A

ABORT - Static variable in class Serialio.modem.Modem

abort() - Method in class Serialio.modem.Modem

Abort the current request

abort() - Method in class Serialio.modem.Timer

abort() - Method in class Serialio.SerInputStream

Abort the current read

abort() - Method in class Serialio.SerLooker

Aborts a waitFor operation in progress.

abort() - Method in class Serialio.SnoopLoop

Abort this task

abortRequest - Variable in class Serialio.modem.Modem

addPortInfo(String, String, String) - Static method in class Serialio.SerialPortLocal

Add port driver manufacture name & description to the list.

addPortName(String) - Static method in class Serialio.SerialPortLocal

Add port name to the list.

addSnoop(SnoopListener, String, boolean) - Method in class Serialio.SnoopInputStream

Add a 'Snoop' on input stream

addSnoop(SnoopListener, byte[], boolean) - Method in class Serialio.SnoopInputStream

Add a 'Snoop' on input stream

addTokenSnoop(SnoopTokenListener, byte[], byte[], byte, int, int, int) - Method in class Serialio.SnoopInputStream

Add a 'Token Snoop' on input stream.

addTokenSnoop(SnoopTokenListener, byte[], byte[], byte, int, int) - Method in class Serialio.SnoopInputStream

Add a 'Token Snoop' on input stream.

addTokenSnoop(SnoopTokenListener, String, String, String, int, int) - Method in class Serialio.SnoopInputStream

Add a 'Token Snoop' on input stream.

addTokenSnoop(SnoopTokenListener, String, String, String, int, int, int) - Method in class Serialio.SnoopInputStream

Add a 'Token Snoop' on input stream.

available() - Method in class Serialio.SerByteQueue

Get number of bytes in the queue

available() - Method in class Serialio.SerInputStream

Indicates the number of bytes ready for reading

available() - Method in class Serialio.SnoopInputStream

Indicates the number of bytes in the read queue

B

BR_110 - Static variable in class Serialio.SerialConfig

BR_115200 - Static variable in class Serialio.SerialConfig

BR_1200 - Static variable in class Serialio.SerialConfig

BR_150 - Static variable in class Serialio.SerialConfig

BR_19200 - Static variable in class Serialio.SerialConfig

BR_230400 - Static variable in class Serialio.SerialConfig

BR_2400 - Static variable in class Serialio.SerialConfig

BR_300 - Static variable in class Serialio.SerialConfig

BR_38400 - Static variable in class Serialio.SerialConfig

BR_460800 - Static variable in class Serialio.SerialConfig

BR_4800 - Static variable in class Serialio.SerialConfig

BR_57600 - Static variable in class Serialio.SerialConfig

BR_600 - Static variable in class Serialio.SerialConfig

BR_921600 - Static variable in class Serialio.SerialConfig

BR_9600 - Static variable in class Serialio.SerialConfig

buildNum - Static variable in class Serialio.SerialPortLocal

ByteTokenizer - Class in Serialio

Parse tokens from byte stream.

ByteTokenizer(byte[], byte) - Constructor for class Serialio.ByteTokenizer

C

checkDataForMatch(byte) - Method in class Serialio.SnoopInputStream

Check byte for match with existing snoops

checkForTokenMatch(int) - Method in class Serialio.SnoopInputStream

checkInitialized() - Method in class Serialio.modem.Modem

Check to see if the modem is initialized.

checkOpen() - Method in class Serialio.modem.Modem

Check to see if the modem is 'open'.

clear() - Method in class Serialio.SerByteQueue

Clear the byte queue.

clearReadSinceRxBufCheck() - Method in class Serialio.SerialPortLocal

Clears state of 'read since rx buffer check' flag.

clearSendSinceTxBufEmpty() - Method in class Serialio.SerialPortLocal

Clears state of 'send since empty msg' flag.

close() - Method in interface Serialio.SerialPort

Close a port object.

close() - Method in class Serialio.SerialPortLocal

Close a port object.

close() - Method in class Serialio.SerInputStream

Closes this input stream

close() - Method in class Serialio.SerOutputStream

Close the port.

close() - Method in class Serialio.SnoopInputStream

Closes this input stream

cmdReply(String, String, int) - Method in class Serialio.modem.Modem

send the dat, wait for data.

cmdReply(byte[], byte[], int) - Method in class Serialio.modem.Modem

send the dat, wait for data.

cmdReply(byte[], byte[], int) - Method in class Serialio.modem.SerModem

send the dat, wait for data.

commandMode() - Method in class Serialio.modem.Modem

Sent the modem 'Attention' command.

comPortNums - Static variable in class Serialio.SerialPortLocal

configure(SerialConfig) - Method in interface Serialio.SerialPort

Configures port with the parameters in the SerialConfig object See documentation for details on the SerialConfig parameters.

configure() - Method in class Serialio.SerialPortLocal

Configures port with the parameters in the SerialConfig object

configure(SerialConfig) - Method in class Serialio.SerialPortLocal

Configures port with the parameters in the SerialConfig object.

CONNECT - Static variable in class Serialio.modem.Modem

CONNECT - Static variable in class Serialio.modem.ModemEvent

contains(String) - Method in class Serialio.modem.Modem

Checks to see if the given String is contained in the reply buffer

controlName - Variable in class Serialio.modem.Modem

copy() - Method in class Serialio.SerialConfig

Return a copy (clone) of this object.

curLocale - Variable in class Serialio.modem.Modem

D

dataMatch(byte[], byte[]) - Method in class Serialio.SnoopInputStream

Check for match of two byte arrays.

description - Variable in class Serialio.PortDriverInfo

DIAL_BLIND - Static variable in class Serialio.modem.Modem

DISCONNECT - Static variable in class Serialio.modem.Modem

DONE - Static variable in class Serialio.modem.ModemEvent

E

eMsg - Variable in class Serialio.modem.Modem

ErrorStatusHandler - Interface in Serialio

Interface for watching receive stream Copyright (c) 2004 Serialio.com, All Rights Reserved.

esh - Variable in class Serialio.SerialPortLocal

eventLookForData(byte[], boolean, long, byte[]) - Method in interface Serialio.LookForListener

Receives notification when searched for data is sighted or timeout

evMsg - Variable in class Serialio.modem.Modem

EXCEPTION - Static variable in class Serialio.modem.ModemEvent

ExTimeout - Exception in Serialio

Exception for token that exceeds allocated space.

ExTimeout() - Constructor for exception Serialio.ExTimeout

ExTimeout(String) - Constructor for exception Serialio.ExTimeout

ExTokenOverflow - Exception in Serialio

Exception for token that exceeds allocated space.

ExTokenOverflow() - Constructor for exception Serialio.ExTokenOverflow

ExTokenOverflow(String) - Constructor for exception Serialio.ExTokenOverflow

F

finalize() - Method in class Serialio.SerialPortLocal

Be sure that port is cleaned up before exit (in case close was not called)

flush() - Method in class Serialio.SerOutputStream

Causes any buffered data on the output stream to be written.

flushAbort() - Method in class Serialio.SerOutputStream

Aborts flush.

G

get(byte[], int, int) - Method in class Serialio.SerByteQueue

Get bytes from queue and store into buffer Note: will block if insufficient bytes in queue.

get() - Method in class Serialio.SerByteQueue

Get byte from queue Note: will block if queue is empty

GET_CONNECT - Static variable in class Serialio.modem.Modem

getAbortCheck() - Method in class Serialio.SerLooker

Deprecated. The method is no longer required

getBaseName() - Method in class Serialio.SerialConfig

Get the device base name

getBitRate() - Method in class Serialio.SerialConfig

Get the bit rate index

getBitRate() - Method in class Serialio.SerialPortLocal

getBitRateIndex(int) - Method in class Serialio.SerialConfig

Get the bit rate as index value.

getBitRateNumber(int) - Method in class Serialio.SerialConfig

Get the bit rate as a number

getBuildNum() - Method in class Serialio.SerialPortLocal

Returns the build number of this class.

getByte() - Method in interface Serialio.SerialPort

Get the next available byte from the receive buffer.

getByte() - Method in class Serialio.SerialPortLocal

Get the next available byte from the receive buffer.

getConfig() - Method in interface Serialio.SerialPort

Gets the configuration object for the port.

getConfig() - Method in class Serialio.SerialPortLocal

Gets the the SerialConfig object

getConnectMsg() - Method in class Serialio.modem.Modem

Get the connect message returned by the modem

getConnectWaitTime() - Method in class Serialio.modem.Modem

getContents() - Method in class Serialio.modem.LangModem_de

getContents() - Method in class Serialio.modem.LangModem_en

getContents() - Method in class Serialio.modem.LangModem_es_ES

getData(byte[]) - Method in interface Serialio.SerialPort

Transfers bytes into the data buffer from the serial port receive buffer.

getData(byte[], int, int) - Method in interface Serialio.SerialPort

Transfers bytes into the data buffer from the serial port receive buffer.

getData(byte[]) - Method in class Serialio.SerialPortLocal

Gets next available bytes from the receive buffer.

getData(byte[], int, int) - Method in class Serialio.SerialPortLocal

Gets next available bytes from the receive buffer.

getData() - Method in class Serialio.SerLooker

Returns the data received while the port was waiting for specific data.

getDataBits() - Method in class Serialio.SerialConfig

Get the number of data bits for each character

getDataBits() - Method in class Serialio.SerialPortLocal

getDataDiscard(boolean) - Method in class Serialio.SnoopLoop

Get the 'data discard' mode.

getDataItemSighted() - Method in class Serialio.SerLooker

Returns the data item that was sighted.

getDevName() - Method in interface Serialio.modem.ModemInterfaceProvider

getDevName() - Method in class Serialio.SerialPortLocal

Returns the device name (OS name for port)

getDisableActiveLink() - Method in class Serialio.SerialConfig

Get the state of the 'active link' control for EPOC This is EPOC specific

getDriverDesc() - Method in class Serialio.PortDriverInfo

getDriverInfoList() - Static method in class Serialio.SerialPortLocal

Returns device driver information for device name

getDriverMfgr() - Method in class Serialio.PortDriverInfo

getEventMessage() - Method in class Serialio.modem.ModemEvent

Get the event message.

getEventRequest() - Method in class Serialio.modem.ModemEvent

Get the event request code.

getEventType() - Method in class Serialio.modem.ModemEvent

Get the event type code.

getHandshake() - Method in class Serialio.SerialConfig

Get the handshake protocol

getHandshake() - Method in class Serialio.SerialPortLocal

getHardFlow() - Method in class Serialio.SerialConfig

Get the state of the 'manual' flow control setting This is Windows specific (to Fix Microsoft driver bugs)

getID() - Method in class Serialio.SerByteQueue

Get the Queue ID

getInputStream() - Method in class Serialio.SnoopInputStream

Get input stream this object is snooping on

getInstanceLock() - Static method in class Serialio.SerialPortLocal

Get the instance lock state.

getInterval() - Method in class Serialio.modem.Timer

getLibVer() - Method in interface Serialio.SerialPort

Returns the version number of the current serial port DLL

getLibVer() - Method in class Serialio.SerialPortLocal

Returns the version number of the current serial port native lib (so/DLL) The most significant 16 bits contain the major version The least significant 16 bits contain the minor version

getMaxBitRate() - Method in class Serialio.SerialPortLocal

Return maximum bitrate supported on the platform

getModemStatusAcceptor() - Method in class Serialio.modem.Modem

Get the object that will receive modem status msgs

getName() - Method in interface Serialio.SerialPort

Returns the name of this serial port object

getName() - Method in class Serialio.SerialPortLocal

Returns the name of this serial port object

getName(int) - Method in class Serialio.SerialPortLocal

Returns the name of this serial port object

getNapTime() - Method in class Serialio.SerInputStream

getNapTime() - Method in class Serialio.SerLooker

Get the sleep interval used when waiting for data

getNapTime() - Method in class Serialio.SnoopLoop

Get the nap time used when the method sleeps.

getNativeBlock() - Method in class Serialio.SerInputStream

getNotifyBeforeModemEvent() - Method in class Serialio.modem.Modem

getParity() - Method in class Serialio.SerialConfig

Get the parity

getParity() - Method in class Serialio.SerialPortLocal

getPhoneNumber() - Method in class Serialio.modem.Modem

getPort() - Method in class Serialio.SerialConfig

Get the port number This number may be meaningless if the port was opened using a name.

getPortList() - Static method in class Serialio.SerialPortLocal

Get list of ports from OS 'registry' First we check to see if a system property SERIAL_PORT_LIST is defined.

getPortListMode() - Static method in class Serialio.SerialPortLocal

getPortName() - Method in class Serialio.PortDriverInfo

getPortName() - Method in class Serialio.SerialConfig

Get the port name

getPortName() - Method in class Serialio.SerialPortLocal

getPortNameString() - Method in class Serialio.SerialConfig

Get the port name

getPortNum() - Method in interface Serialio.SerialPort

Returns the port number for this serial port object

getPortNum() - Method in class Serialio.SerialPortLocal

Returns the port number for this serial port object

getPowerMode(int) - Static method in class Serialio.SerialPortLocal

Gets the port state for devices that support standby mode to save power.

getRcvCount() - Method in class Serialio.SerLooker

Returns the number of bytes received while the port was waiting for specific data.

getRcvFrameChar() - Method in class Serialio.SerInputStream

getRcvThreshold() - Method in class Serialio.SerInputStream

getRcvTimeout() - Method in class Serialio.SerInputStream

getReadBuffer() - Method in class Serialio.SnoopLoop

Get the current read buffer.

getResumeState(boolean) - Static method in class Serialio.SerialPortLocal

Gets the state of the resume flag.

getRxLen() - Method in class Serialio.SerialConfig

Get the receive buffer length

getSaveReset() - Method in class Serialio.SerLooker

Get the saveReset flag.

getSerialPort(SerialPort) - Method in class Serialio.SerLooker

Gets the serial port object

getSettingsString() - Method in class Serialio.SerialConfig

Get a string representing the current port settings

getShowModemData() - Method in class Serialio.modem.Modem

getShowModemStatus() - Method in class Serialio.modem.Modem

getShowModemStatusExpert() - Method in class Serialio.modem.Modem

getSnoopEnable() - Method in class Serialio.SnoopInputStream

Get state of snooping on input stream

getStatusAPM() - Static method in class Serialio.SerialPortLocal

Gets the status of APM (advanced power management)

getStopBits() - Method in class Serialio.SerialConfig

Get the number of stop bits for each character

getStopBits() - Method in class Serialio.SerialPortLocal

getSubTokenCount() - Method in class Serialio.SnoopInputStream

Get number of sub-tokens in current token when snooping for Tokens.

getTicks() - Method in class Serialio.modem.Timer

getTimeoutRx() - Method in interface Serialio.SerialPort

Returns the receive (rx) timeout interval of serial port object.

getTimeoutRx() - Method in class Serialio.SerialPortLocal

Returns the receive timeout interval of serial port object.

getTimeoutTx() - Method in interface Serialio.SerialPort

Returns the transmit (tx) timeout interval of serial port object.

getTimeoutTx() - Method in class Serialio.SerialPortLocal

Returns the receive timeout interval of serial port object.

getTxBlockSize() - Method in class Serialio.SerOutputStream

getTxLen() - Method in class Serialio.SerialConfig

Get the transmit buffer length

getWriteDrain() - Method in class Serialio.SerOutputStream

getWriteTimeout() - Method in class Serialio.SerOutputStream

H

hexString() - Method in class Serialio.modem.Modem

Creates a String from the data in the SerialData object

HS_CTSDTR - Static variable in class Serialio.SerialConfig

HS_CTSRTS - Static variable in class Serialio.SerialConfig

HS_DSRDTR - Static variable in class Serialio.SerialConfig

HS_HARD_IN - Static variable in class Serialio.SerialConfig

HS_HARD_OUT - Static variable in class Serialio.SerialConfig

HS_NONE - Static variable in class Serialio.SerialConfig

HS_SOFT_IN - Static variable in class Serialio.SerialConfig

HS_SOFT_OUT - Static variable in class Serialio.SerialConfig

HS_SPLIT_MASK - Static variable in class Serialio.SerialConfig

HS_XONXOFF - Static variable in class Serialio.SerialConfig

I

in - Variable in class Serialio.SnoopInputStream

in - Variable in class Serialio.SnoopLoop

INITIALIZE - Static variable in class Serialio.modem.Modem

The modem thread

isEmpty() - Method in class Serialio.SerByteQueue

Get empty state of queue

isFull() - Method in class Serialio.SerByteQueue

Get full state of queue

isInitialized() - Method in class Serialio.modem.Modem

Returns true if the modem was initialized.

isOpen() - Method in class Serialio.SerialPortLocal

Indicates if port is currently open

isSupported(String) - Method in interface Serialio.SerialPort

Indicates support for the requested feature.

isSupported(String) - Method in class Serialio.SerialPortLocal

Check for supported feature

J

jspLib - Static variable in class Serialio.SerialPortLocal

jspLibLoaded - Static variable in class Serialio.SerialPortLocal

L

LangModem_de - Class in Serialio.modem

Modem specific messages.

LangModem_de() - Constructor for class Serialio.modem.LangModem_de

LangModem_en - Class in Serialio.modem

Modem specific messages.

LangModem_en() - Constructor for class Serialio.modem.LangModem_en

LangModem_es_ES - Class in Serialio.modem

Modem specific messages.

LangModem_es_ES() - Constructor for class Serialio.modem.LangModem_es_ES

lastByte - Variable in class Serialio.SnoopInputStream

LN_5BITS - Static variable in class Serialio.SerialConfig

LN_6BITS - Static variable in class Serialio.SerialConfig

LN_7BITS - Static variable in class Serialio.SerialConfig

LN_8BITS - Static variable in class Serialio.SerialConfig

LookForListener - Interface in Serialio

Interface for watching receive stream Copyright (c) 1998-2004 Serialio.com, All Rights Reserved.

M

manufacture - Variable in class Serialio.PortDriverInfo

mark(int) - Method in class Serialio.SnoopInputStream

markSupported() - Method in class Serialio.SnoopInputStream

match - Variable in class Serialio.modem.Modem

maxBitRate - Static variable in class Serialio.SerialPortLocal

me - Variable in class Serialio.modem.Modem

mip - Variable in class Serialio.modem.Modem

mis - Variable in class Serialio.modem.Modem

Modem - Class in Serialio.modem

Creates a modem object.

Modem() - Constructor for class Serialio.modem.Modem

Creates a modem object

Modem(ModemInterfaceProvider, OutputStream, InputStream) - Constructor for class Serialio.modem.Modem

Creates a modem object

ModemEvent - Class in Serialio.modem

Modem event.

ModemEvent(Modem, int, int, String) - Constructor for class Serialio.modem.ModemEvent

Create a new modem event

modemEvent(ModemEvent) - Method in interface Serialio.modem.ModemEventListener

modemEvent(ModemEvent) - Method in interface Serialio.modem.ModemInterfaceProvider

ModemEventListener - Interface in Serialio.modem

Interface for modem events.

ModemException - Exception in Serialio.modem

Modem specific exceptions.

ModemException() - Constructor for exception Serialio.modem.ModemException

Constructs an ModemException without a specific message.

ModemException(String) - Constructor for exception Serialio.modem.ModemException

Constructs an ModemException with the specified message.

ModemInterfaceProvider - Interface in Serialio.modem

Provides Modem interface hooks.

ModemStatusAcceptor - Interface in Serialio.modem

Interface for modem status msgs.

mos - Variable in class Serialio.modem.Modem

mos - Variable in class Serialio.modem.SerModem

mTask - Variable in class Serialio.modem.Modem

N

name - Variable in class Serialio.PortDriverInfo

nextToken() - Method in class Serialio.ByteTokenizer

Parse next token from byte array.

notifySighting(SnoopInputStream.Snoop) - Method in class Serialio.SnoopInputStream

Notify listeners

numberOfTokens(byte[], byte) - Static method in class Serialio.ByteTokenizer

Count number of tokens in byte array.

numberOfTokens() - Method in class Serialio.ByteTokenizer

Count number of tokens in byte array.

O

OK - Static variable in class Serialio.modem.ModemEvent

open() - Method in class Serialio.SerialPortLocal

Open the SerialPortLocal object.

P

phoneNumber - Variable in class Serialio.modem.Modem

PortDriverInfo - Class in Serialio

Stores OS device driver information about port when supported

PortDriverInfo(String, String, String) - Constructor for class Serialio.PortDriverInfo

portInfo - Static variable in class Serialio.SerialPortLocal

portList - Static variable in class Serialio.SerialPortLocal

portListInfo - Static variable in class Serialio.SerialPortLocal

portNumList - Static variable in class Serialio.SerialPortLocal

put(byte) - Method in class Serialio.SerByteQueue

Put byte into queue Note: will block if queue is full

putByte(byte) - Method in interface Serialio.SerialPort

Send byte to the serial port.

putByte(byte) - Method in class Serialio.SerialPortLocal

Send byte out the serial port.

putData(byte[]) - Method in interface Serialio.SerialPort

Send byte array contents to the to the serial port.

putData(byte[], int, int) - Method in interface Serialio.SerialPort

Send specified length of byte array contents to the serial port.

putData(byte[]) - Method in class Serialio.SerialPortLocal

Send byte array contents to the serial port.

putData(byte[], int) - Method in class Serialio.SerialPortLocal

Deprecated. The preferred method is putData(dataBuf, off, len)

putData(byte[], int, int) - Method in class Serialio.SerialPortLocal

Send specificed length of the byte array to the serial port.

putString(String) - Method in interface Serialio.SerialPort

Send String contents to the serial port.

putString(String) - Method in class Serialio.SerialPortLocal

Send the string out the serial port.

PWR_ACTIVE - Static variable in class Serialio.SerialConfig

PWR_STANDBY - Static variable in class Serialio.SerialConfig

PY_EVEN - Static variable in class Serialio.SerialConfig

PY_MARK - Static variable in class Serialio.SerialConfig

PY_NONE - Static variable in class Serialio.SerialConfig

PY_ODD - Static variable in class Serialio.SerialConfig

PY_SPACE - Static variable in class Serialio.SerialConfig

R

rdBuf - Variable in class Serialio.modem.Modem

rdCnt - Variable in class Serialio.modem.Modem

read() - Method in class Serialio.SerInputStream

Reads data from the input stream.

read(byte[]) - Method in class Serialio.SerInputStream

Reads data from the input stream NOTE: framing is ignored by this method, use read() for framing NOTE: if threshold & timeout are enabled, and timeout occurs before threshold is reached, method will return available data.

read(byte[], int, int) - Method in class Serialio.SerInputStream

Reads data from the input stream NOTE: framing is ignored by this method, use read() for framing NOTE: if threshold & timeout are enabled, and timeout occurs before threshold is reached, method will return available data.

read() - Method in class Serialio.SnoopInputStream

Reads data from the input stream.

read(byte[]) - Method in class Serialio.SnoopInputStream

Reads data from the input stream

read(byte[], int, int) - Method in class Serialio.SnoopInputStream

Reads data from the input stream

readSinceRxBufCheck() - Method in class Serialio.SerialPortLocal

Returns flag indicating if data was read since last receive buffer check.

removeSnoop(SnoopListener, String) - Method in class Serialio.SnoopInputStream

Remove 'Snoop' on input stream

removeSnoop(SnoopListener, byte[]) - Method in class Serialio.SnoopInputStream

Remove snoop on input stream

removeSnoop(SnoopListener) - Method in class Serialio.SnoopInputStream

Remove 'Snoop' on input stream

removeTokenSnoop(int) - Method in class Serialio.SnoopInputStream

Remove the Token snoop on input stream

request(int) - Method in class Serialio.modem.Modem

Request modem to perform an action.

reset() - Method in class Serialio.SerialPortLocal

Reset a port object.

reset() - Method in class Serialio.SnoopInputStream

resetPortDriver(SerialConfig) - Method in class Serialio.SerialPortLocal

Reset the OS driver Sometimes devices don't initialize correctly (mainly due to device firmware issues) This method resets the device driver on the port.

RING - Static variable in class Serialio.modem.ModemEvent

run() - Method in class Serialio.modem.Timer

rxFlush() - Method in interface Serialio.SerialPort

Flushes the objects receive buffer (contents are discarded)

rxFlush() - Method in class Serialio.SerialPortLocal

Flushes the objects receive buffer (contents are discarded)

rxOverflow() - Method in interface Serialio.SerialPort

Returns true if the objects receive buffer overflowed since the last call to this method.

rxOverflow() - Method in class Serialio.SerialPortLocal

Returns true if the objects receive buffer overflowed since the last call to this method.

RXREADYCOUNT - Static variable in interface Serialio.SerialPort

rxReadyCount() - Method in interface Serialio.SerialPort

Returns number of bytes in the objects receive buffer

rxReadyCount() - Method in class Serialio.SerialPortLocal

Returns number of bytes in the objects receive buffer

S

sendBreak(int) - Method in interface Serialio.SerialPort

Send a break signal on the line

sendBreak(int) - Method in class Serialio.SerialPortLocal

Send a break signal on the line

sendSinceTxBufEmpty() - Method in class Serialio.SerialPortLocal

Returns flag indicating if data sent since last transmit buffer check.

SerByteQueue - Class in Serialio

Implements a High-performance Byte FIFO using a ringbuffer.

SerByteQueue(int) - Constructor for class Serialio.SerByteQueue

SerialConfig - Class in Serialio

Serial port configuration class.

SerialConfig(int) - Constructor for class Serialio.SerialConfig

Deprecated. The preferred way to construct a SerialConfig object is 'by-name'
SerialConfig cfg = new SerialConfig("COM1");
SerialConfig cfg = new SerialConfig("/dev/ttyS0");
SerialConfig cfg = new SerialConfig("Modem Port");

SerialConfig(int, int, int) - Constructor for class Serialio.SerialConfig

Deprecated. The preferred way to construct a SerialConfig object is 'by-name'
SerialConfig cfg = new SerialConfig("COM1");
SerialConfig cfg = new SerialConfig("/dev/ttyS0");
SerialConfig cfg = new SerialConfig("Modem Port");
Then set the buffer length(s) if setting them is supported

Note: Buffer size control not supported on all platforms.

SerialConfig(String) - Constructor for class Serialio.SerialConfig

Create a SerialConfig object 'by-name' with default port parameters

SerialConfig() - Constructor for class Serialio.SerialConfig

Create a default SerialConfig object.

Serialio - package Serialio

Serialio.modem - package Serialio.modem

SerialPort - Interface in Serialio

Interface for serial port classes.

SerialPortLocal - Class in Serialio

Class for interface to serial port(s).

SerialPortLocal() - Constructor for class Serialio.SerialPortLocal

Create a default SerialPort object.

SerialPortLocal(SerialConfig) - Constructor for class Serialio.SerialPortLocal

Create a SerialPort object based on a SerialConfig object.

SerInputStream - Class in Serialio

Create an input stream on the serial port object.

SerInputStream(SerialPort) - Constructor for class Serialio.SerInputStream

Create a serial port input stream.

SerLooker - Class in Serialio

Looks for things to happen on the serial port object.

SerLooker() - Constructor for class Serialio.SerLooker

Create a serial port 'looker'.

SerLooker(SerialPort) - Constructor for class Serialio.SerLooker

Create a serial port 'looker'.

SerLooker(SerialPort, int) - Constructor for class Serialio.SerLooker

Create a serial port 'looker' with a specific save data buffer.

SerModem - Class in Serialio.modem

Creates a modem object.

SerModem(ModemInterfaceProvider, SerOutputStream, SerInputStream) - Constructor for class Serialio.modem.SerModem

Creates a modem object

SerOutputStream - Class in Serialio

Create an output stream on the serial port object.

SerOutputStream(SerialPort) - Constructor for class Serialio.SerOutputStream

Create a serial port output stream.

setAbortCheck(int) - Method in class Serialio.SerLooker

Deprecated. The method is no longer required since the port timout (setTimeoutRx) value is always 0.

setBaseName(String) - Method in class Serialio.SerialConfig

Set the base device name.

setBitRate(int) - Method in class Serialio.SerialConfig

Set the bit rate

setBitRate(int) - Method in class Serialio.SerialPortLocal

setConfig(SerialConfig) - Method in interface Serialio.SerialPort

Sets the configuration object for the port.

setConfig(SerialConfig) - Method in class Serialio.SerialPortLocal

Sets the the SerialConfig object

setConnectWaitTime(int) - Method in class Serialio.modem.Modem

Set the time the modem will wait for connection after sending the dial command.

setDataBits(int) - Method in class Serialio.SerialConfig

Set the number of data bits

setDataBits(int) - Method in class Serialio.SerialPortLocal

setDataDiscard(boolean) - Method in class Serialio.SnoopLoop

Set the 'data discard' mode.

setDialCommand(String) - Method in class Serialio.modem.Modem

Set the modem dial mode command string.

setDisableActiveLink(boolean) - Method in class Serialio.SerialConfig

Set the state of the 'active link' control for EPOC.

setDTR(boolean) - Method in class Serialio.modem.Modem

Set the modem DTR line

setDTR(boolean) - Method in interface Serialio.modem.ModemInterfaceProvider

setDTR(boolean) - Method in interface Serialio.SerialPort

Set the DTR signal of objects serial port

setDTR(boolean) - Method in class Serialio.SerialPortLocal

Set the DTR signal of objects serial port

setEndTokenSnoop(SnoopTokenListener, byte[], int) - Method in class Serialio.SnoopInputStream

Set a 'Token Snoop' on the input stream.

setErrorStatusHandler(ErrorStatusHandler) - Method in class Serialio.SerialPortLocal

Sets the UnexpectedStatusHandler.

setHandshake(int) - Method in class Serialio.SerialConfig

Set the handshake protocol

setHandshake(int) - Method in class Serialio.SerialPortLocal

setHardFlow(boolean) - Method in class Serialio.SerialConfig

Set the flag that controls if we do hardware flow control for the receive buffer.

setID(int) - Method in class Serialio.SerByteQueue

Set the Queue ID

setInitCommand(String) - Method in class Serialio.modem.Modem

Set the modem initialization command string.

setInitTime(int) - Method in class Serialio.modem.Modem

Set the modem initialization timeout value.

setInputStream(InputStream) - Method in class Serialio.SnoopInputStream

Set input stream this object will snooping on

setInstanceLock(int) - Static method in class Serialio.SerialPortLocal

Set the instance lock to SET or CLEAR state.

setInterfaceProvider(ModemInterfaceProvider) - Method in class Serialio.modem.Modem

Set the ModemInterfaceProvider.

setInterval(int) - Method in class Serialio.modem.Timer

setLocale(Locale) - Method in class Serialio.modem.Modem

Set the locale.

setModemStatusAcceptor(ModemStatusAcceptor) - Method in class Serialio.modem.Modem

Set the object to receive modem status msgs

setName(String) - Method in interface Serialio.SerialPort

Sets the name of this serial port object

setName(String) - Method in class Serialio.SerialPortLocal

Sets the name of this serial port object

setNapTime(int) - Method in class Serialio.SerInputStream

Set the nap time used when the method sleeps

setNapTime(int) - Method in class Serialio.SerLooker

Set the sleep interval used when waiting for data Note: SerialPort.setTimeoutRx is not used to allow quick aborts on some platforms (esp WinNT) where some threading behaviour is not well behaved.

setNapTime(int) - Method in class Serialio.SnoopLoop

Set the nap time used when the method sleeps.

setNativeBlock(boolean) - Method in class Serialio.SerInputStream

Control if block is done in Java or native code when more bytes are requested than are available.

setNotifyBeforeModemEvent(boolean) - Method in class Serialio.modem.Modem

Set notifyBeforeModemEvent.

setOffset(int) - Method in class Serialio.ByteTokenizer

Set the starting point of parsing within the buffer.

setParity(int) - Method in class Serialio.SerialConfig

Set the parity Note: MARK & SPACE parity may not be supported on all platforms

setParity(int) - Method in class Serialio.SerialPortLocal

setParseEnd(int) - Method in class Serialio.ByteTokenizer

Set the ending point of parsing within the buffer.

setPhoneNumber(String) - Method in class Serialio.modem.Modem

Set the phone number the modem will dial when a connect command is requted

setPortListMode(int) - Static method in class Serialio.SerialPortLocal

getPortList method will discover all COM ports or only active COM ports depending on setting of portListMode portListMode = 0; get only active ports portListMode = 1; get all ports

setPortName(String) - Method in class Serialio.SerialConfig

Set the port name

setPortName(String) - Method in class Serialio.SerialPortLocal

setPortNum(int) - Method in class Serialio.SerialConfig

Set the port number

setPowerMode(int, int) - Static method in class Serialio.SerialPortLocal

Sets the port state for devices that support standby mode to save power.

setRcvFrameChar(int) - Method in class Serialio.SerInputStream

Set to -1 to disable

setRcvThreshold(int) - Method in class Serialio.SerInputStream

Set thresh to 1 to 'disable'

setRcvTimeout(int) - Method in class Serialio.SerInputStream

Set receive timeout in milliseconds.

setReadBuffer(byte[]) - Method in class Serialio.SnoopLoop

Set the read buffer used when snooping for data

setRepeats(boolean) - Method in class Serialio.modem.Timer

setRTS(boolean) - Method in interface Serialio.SerialPort

Set the RTS signal of objects serial port

setRTS(boolean) - Method in class Serialio.SerialPortLocal

Set the RTS signal of objects serial port.

setRxLen(int) - Method in class Serialio.SerialConfig

Set the value that *maybe* used by the driver to set the queue sizes when the port is opened.

setSaveData(int) - Method in class Serialio.SerLooker

Controls if the object saves data when waiting for a specific response.

setSaveDataBeforeMatch(boolean) - Method in class Serialio.SerLooker

Sets the object to save data before the match.

setSaveReset(boolean) - Method in class Serialio.SerLooker

Set the saveReset flag.

setSerialPort(SerialPort) - Method in class Serialio.SerLooker

Sets the serial port object

setShowBytesAsReceived(boolean) - Method in class Serialio.SerLooker

Sets the object to show each byte to the console as received Setting this true can be handy for debugging & sanity checks.

setShowModemData(boolean) - Method in class Serialio.modem.Modem

When enabled this mode sends the received modem data to the registered viewer.

setShowModemStatus(boolean) - Method in class Serialio.modem.Modem

Set the modem status messages.

setShowModemStatusExpert(boolean) - Method in class Serialio.modem.Modem

Set the 'expert' modem status messages.

setSnoopEnable(boolean) - Method in class Serialio.SnoopInputStream

Enable/disable snooping on input stream

setStopBits(int) - Method in class Serialio.SerialConfig

Set the number of stop bits

setStopBits(int) - Method in class Serialio.SerialPortLocal

setStreamID(int) - Method in class Serialio.SnoopInputStream

Set the stream ID

setStreams(OutputStream, InputStream) - Method in class Serialio.modem.Modem

Set the streams used by the modem.

setTimeoutRx(int) - Method in interface Serialio.SerialPort

Sets the receive timeout of the serial port object.

setTimeoutRx(int) - Method in class Serialio.SerialPortLocal

Sets the receive timeout of the serial port object.

setTimeoutTx(int) - Method in interface Serialio.SerialPort

Sets the transmit timeout of the serial port object.

setTimeoutTx(int) - Method in class Serialio.SerialPortLocal

Sets the transmit timeout of the serial port object.

setTxBlockSize(int) - Method in class Serialio.SerOutputStream

Sets the block size used to send data.

setTxLen(int) - Method in class Serialio.SerialConfig

Set the value that *maybe* used by the driver to set the queue sizes when the port is opened.

setWriteDrain(boolean) - Method in class Serialio.SerOutputStream

Set txDrain mode for write().

setWriteTimeout(int) - Method in class Serialio.SerOutputStream

Aborts flush based on timeout.

sigBreak() - Method in interface Serialio.SerialPort

Returns true if the serial port for this object detected a break on the line since the last call to this method.

sigBreak() - Method in class Serialio.SerialPortLocal

Returns true if the serial port for this object detected a break on the line since the last call to this method.

sigCD() - Method in interface Serialio.SerialPort

Returns state of serial port CD (Carrier Detect) signal

sigCD() - Method in class Serialio.SerialPortLocal

Returns state of serial port CD (Carrier Detect) signal Note: This may not be supported on all platforms

sigCTS() - Method in interface Serialio.SerialPort

Returns state of serial port CTS (Clear To Send) signal

sigCTS() - Method in class Serialio.SerialPortLocal

Returns state of serial port CTS (Clear To Send) signal

sigDSR() - Method in interface Serialio.modem.ModemInterfaceProvider

sigDSR() - Method in interface Serialio.SerialPort

Returns state of serial port DSR (Data Set Ready) signal

sigDSR() - Method in class Serialio.SerialPortLocal

Returns state of serial port DSR (Data Set Ready) signal

sigFrameErr() - Method in interface Serialio.SerialPort

Returns true if the serial port for this object had a Framing Error since last call to this method.

sigFrameErr() - Method in class Serialio.SerialPortLocal

Returns true if the serial port for this object had a Framing Error since last call to this method.

sigOverrun() - Method in interface Serialio.SerialPort

Returns true if the serial port UART for this object had a was Overrun since last call to this method.

sigOverrun() - Method in class Serialio.SerialPortLocal

Returns true if the serial port UART for this object had a was Overrun since last call to this method.

sigParityErr() - Method in interface Serialio.SerialPort

Returns true if the serial port for this object had a Parity Error since last call to this method.

sigParityErr() - Method in class Serialio.SerialPortLocal

Returns true if the serial port for this object had a Parity Error Note: This may not be supported on all platforms since last call to this method.

sigRing() - Method in interface Serialio.SerialPort

Returns true if the serial port for this object detected a Ring on the line since the last call to this method.

sigRing() - Method in class Serialio.SerialPortLocal

Returns true if the serial port object detects a ring signal on the line.

sioErrorEvent(int) - Method in interface Serialio.ErrorStatusHandler

Receives notification when native code returns an error status code and a handler has been registered.

size() - Method in class Serialio.SerByteQueue

Get size of queue.

sMsgs - Variable in class Serialio.modem.Modem

snoop(byte) - Method in class Serialio.SnoopInputStream

Forces the data through the snoop logic without having to read data from the input stream.

snoopEvent(byte[]) - Method in class Serialio.modem.Modem

Callback for SnoopListener (contains data pattern 'snooped' for)

snoopEvent(byte[]) - Method in class Serialio.SnoopInputStream

snoopEvent(byte[]) - Method in interface Serialio.SnoopListener

Receives notification when searched for data is sighted or timeout

snoopEvent(byte[]) - Method in class Serialio.SnoopLoop

This method is called by the SnoopInputStream when the data pattern is sighted.

SnoopInputStream - Class in Serialio

Create an 'snoop' input stream on the serial port that searches for data patterns.

SnoopInputStream() - Constructor for class Serialio.SnoopInputStream

This empty constructor is for Bean friendlyness

SnoopInputStream(InputStream) - Constructor for class Serialio.SnoopInputStream

Create an input stream that allows 'snooping' for data patterns on incoming data

SnoopListener - Interface in Serialio

Interface for watching receive stream Copyright (c) 1998-2004 Serialio.com, All Rights Reserved.

SnoopLoop - Class in Serialio

Used to look for data patterns in a SnoopInputStream.

SnoopLoop() - Constructor for class Serialio.SnoopLoop

This empty constructor is for Bean friendlyness

SnoopLoop(SnoopLoopListener, SnoopInputStream, int) - Constructor for class Serialio.SnoopLoop

Create an input stream that allows 'snooping' for data patterns on incoming data

snoopLoopEvent(byte[], int) - Method in class Serialio.modem.Modem

Callback for SnoopLoopListener

snoopLoopEvent(byte[], int) - Method in interface Serialio.SnoopLoopListener

Receives notification when searched for data is sighted or timeout

SnoopLoopListener - Interface in Serialio

Interface for watching receive stream Copyright (c) 1999-2004 Serialio.com, All Rights Reserved.

snoopTokenEvent(byte[], int) - Method in interface Serialio.SnoopTokenListener

Receives notification when searched for Token is sighted or timeout

SnoopTokenListener - Interface in Serialio

Interface for watching receive stream Copyright (c) 1998-2004 Serialio.com, All Rights Reserved.

sp - Variable in class Serialio.SerInputStream

sp - Variable in class Serialio.SerLooker

sp - Variable in class Serialio.SerOutputStream

spy - Variable in class Serialio.modem.Modem

ST_1BITS - Static variable in class Serialio.SerialConfig

ST_2BITS - Static variable in class Serialio.SerialConfig

start() - Method in class Serialio.modem.Modem

Start the modem task.

statusMsg(String) - Method in class Serialio.modem.Modem

Put a msg to the assigned status area

statusMsgEvent(String) - Method in interface Serialio.modem.ModemStatusAcceptor

statusMsgExpert(String) - Method in class Serialio.modem.Modem

Status msg for 'Experts' to the console

statusMsgLn(String) - Method in class Serialio.modem.Modem

Put a msg line to the assigned status area

statusMsgNotify - Variable in class Serialio.modem.Modem

STOP - Static variable in class Serialio.modem.Modem

stop() - Method in class Serialio.modem.Modem

Request the modem thread to stop

STOP_WAIT_RING - Static variable in class Serialio.modem.Modem

stopRequest - Variable in class Serialio.modem.Modem

stopWaitRing - Variable in class Serialio.modem.Modem

stringCompare - Static variable in class Serialio.SerialPortLocal

stripCOM(String[]) - Static method in class Serialio.SerialPortLocal

Strip "COM" from port names for efficient sorting in numeric order.

svPortList - Static variable in class Serialio.SerialPortLocal

T

tick(Timer) - Method in interface Serialio.modem.TimerTick

Called at timer interval

Timer - Class in Serialio.modem

Timer class.

Timer(long, TimerTick) - Constructor for class Serialio.modem.Timer

TimerTick - Interface in Serialio.modem

Interface for creating timers.

toString() - Method in class Serialio.modem.ModemEvent

Create a string with the parameters of the event.

txBufCount() - Method in interface Serialio.SerialPort

Returns number of bytes in the objects transmit buffer

txBufCount() - Method in class Serialio.SerialPortLocal

Returns number of bytes in the objects transmit buffer

txDrain() - Method in interface Serialio.SerialPort

Drains the objects transmit buffer (contents are sent)

txDrain() - Method in class Serialio.SerialPortLocal

Drains the objects transmit buffer (contents are sent).

txFlush() - Method in interface Serialio.SerialPort

Flushes the objects transmit buffer (contents are discarded)

txFlush() - Method in class Serialio.SerialPortLocal

Flushes the objects transmit buffer (contents are discarded)

V

validBitRateIndex() - Method in class Serialio.SerialConfig

Checks for valid bit rate index.

W

WAIT_DONE - Static variable in class Serialio.modem.Modem

WAIT_RING - Static variable in class Serialio.modem.Modem

waitFor(byte[], int, int) - Method in class Serialio.SerLooker

Send data (optional) and wait for count bytes in the input queue.

waitFor(String, String, int) - Method in class Serialio.SerLooker

Send data (optional) and wait for a specific response.

waitFor(byte[], byte[], int) - Method in class Serialio.SerLooker

Send data (optional) and wait for a specific response.

waitFor(String, Vector, int) - Method in class Serialio.SerLooker

Send data (optional) and wait for any of a list of responses.

waitFor(byte[], Vector, int) - Method in class Serialio.SerLooker

Send data (optional) and wait for any of a list of responses.

waitFor(String, int) - Method in class Serialio.SnoopLoop

Wait for data pattern to occur on SnoopInputStream.

waitFor(byte[], int) - Method in class Serialio.SnoopLoop

Wait for data pattern to occur on SnoopInputStream.

waitFor(int, int) - Method in class Serialio.SnoopLoop

Wait for specified number of bytes to arrive on the stream.

write(String) - Method in class Serialio.modem.Modem

Write data to the output stream

write(byte[]) - Method in class Serialio.modem.Modem

Write data to the output stream

write(String) - Method in class Serialio.modem.SerModem

Write data to the output stream

write(byte[]) - Method in class Serialio.modem.SerModem

Write data to the output stream

write(int) - Method in class Serialio.SerOutputStream

Writes the byte on the output stream

write(byte[]) - Method in class Serialio.SerOutputStream

Writes the data on the output stream.

write(byte[], int, int) - Method in class Serialio.SerOutputStream

Writes the data on the output stream.

A B C D E F G H I J L M N O P R S T V W