com.embeddedunveiled.serial.internal

Class SerialComSLabsUSBXpressJNIBridge

java.lang.Object

com.embeddedunveiled.serial.internal.SerialComSLabsUSBXpressJNIBridge

public final class SerialComSLabsUSBXpressJNIBridge
extends Object

This class is an interface between java and native shared library. The native library is found in 'lib-vendor' folder in 'scm-x.x.x.jar' file.

Author:

Rishi Gupta

Constructor Summary

Constructors

Constructor and Description
SerialComSLabsUSBXpressJNIBridge() Allocates a new SerialComSLabsUSBXpressJNIBridge object.

Method Summary

Methods

Modifier and Type	Method and Description
int	cancelIO(long handle)
long[]	checkRXQueue()
int	close(long handle)
int	deviceIOControl(long handle, int ctrlCode, byte[] inputBuf, int numBytesToRead, byte[] outputBuf, int numOfBytesToWrite)
int	flushBuffer(long handle, byte flushTransmit, byte flushReceive)
long	getDllVersion(long handle)
long	getDriverVersion(long handle)
int	getModemStatus(long handle)
int	getNumDevices()
String	getPartNumber(long handle)
String	getProductString(int index, int flag)
long[]	getTimeouts()
static boolean	loadNativeLibrary(File libDirectory, String vlibName, int cpuArch, int osType, SerialComSystemProperty serialComSystemProperty) Extract native library from jar in a working directory, load and link it.
long	open(int index)
int	read(long handle, byte[] buffer, int numOfBytesToRead)
long	readLatch(long handle)
int	setBaudRate(long handle, int baudrate)
int	setBreak(long handle, int breakValue)
int	setFlowControl(long handle, int ctsMaskCode, int rtsMaskCode, int dtrMaskCode, int dsrMaskCode, int dcdMaskCode, int flowXonXoff)
int	setLineControl(long handle, int lineControl)
int	setTimeouts(long handle, long readTimeOut, long writeTimeOut)
int	write(long handle, byte[] buffer, int numOfBytesToWrite)
int	writeLatch(long handle, long mask, long latchValue)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SerialComSLabsUSBXpressJNIBridge

public SerialComSLabsUSBXpressJNIBridge()

Allocates a new SerialComSLabsUSBXpressJNIBridge object.

Method Detail

loadNativeLibrary

public static boolean loadNativeLibrary(File libDirectory,
                        String vlibName,
                        int cpuArch,
                        int osType,
                        SerialComSystemProperty serialComSystemProperty)
                                 throws UnsatisfiedLinkError,
                                        SerialComLoadException,
                                        SerialComUnexpectedException,
                                        SecurityException,
                                        FileNotFoundException

Extract native library from jar in a working directory, load and link it. The 'lib-vendor' folder in 'scm-x.x.x.jar' file is searched for the required native library for vendor specific communication. It also load vendor's native shared library.

Parameters:

libDirectory - directory in which native library will be extracted and vendor library will be found

vlibName - name of vendor library to load and link

cpuArch - architecture of CPU this library is running on

osType - operating system this library is running on

serialComSystemProperty - instance of SerialComSystemProperty to get required java properties

Throws:

SerialComUnexpectedException - if a critical java system property is null in system

SecurityException - if any java system property can not be accessed

FileNotFoundException - if the vendor library file is not found

SerialComLoadException - if any file system related issue occurs

UnsatisfiedLinkError - if loading/linking shared library fails

getNumDevices

public int getNumDevices()

getProductString

public String getProductString(int index,
                      int flag)

open

public long open(int index)

close

public int close(long handle)

read

public int read(long handle,
       byte[] buffer,
       int numOfBytesToRead)

write

public int write(long handle,
        byte[] buffer,
        int numOfBytesToWrite)

cancelIO

public int cancelIO(long handle)

flushBuffer

public int flushBuffer(long handle,
              byte flushTransmit,
              byte flushReceive)

setTimeouts

public int setTimeouts(long handle,
              long readTimeOut,
              long writeTimeOut)

getTimeouts

public long[] getTimeouts()

checkRXQueue

public long[] checkRXQueue()

setBaudRate

public int setBaudRate(long handle,
              int baudrate)

setLineControl

public int setLineControl(long handle,
                 int lineControl)

setFlowControl

public int setFlowControl(long handle,
                 int ctsMaskCode,
                 int rtsMaskCode,
                 int dtrMaskCode,
                 int dsrMaskCode,
                 int dcdMaskCode,
                 int flowXonXoff)

getModemStatus

public int getModemStatus(long handle)

setBreak

public int setBreak(long handle,
           int breakValue)

readLatch

public long readLatch(long handle)

writeLatch

public int writeLatch(long handle,
             long mask,
             long latchValue)

getPartNumber

public String getPartNumber(long handle)

getDllVersion

public long getDllVersion(long handle)

getDriverVersion

public long getDriverVersion(long handle)

deviceIOControl

public int deviceIOControl(long handle,
                  int ctrlCode,
                  byte[] inputBuf,
                  int numBytesToRead,
                  byte[] outputBuf,
                  int numOfBytesToWrite)