com.serialpundit.serial.internal

Class SerialComPortJNIBridge

java.lang.Object

com.serialpundit.serial.internal.SerialComPortJNIBridge

public final class SerialComPortJNIBridge
extends Object

This class is an interface between java and native shared library. The native library is found in the root of 'sp-tty.jar' file.

In Linux/Windows/Solaris it is possible to run 32 bit JVM on 64 bit OS, while perhaps in mac os x JVM must match with underlying OS architecture. Whether 32 or 64 bit sp-dll/so file is to be loaded, is decided by arch of JVM this process is running on. SerialPundit includes both 32 and 64 bit dll/so and therefore 32 bit application using this library with 32 JVM can be run on a 64 bit OS system.

Author:

Rishi Gupta

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
int	clearPortIOBuffers(long handle, boolean rxPortbuf, boolean txPortbuf)
int	closeComPort(long handle)
int	configureComPortControl(long handle, int flowctrl, byte xonCh, byte xoffCh, boolean ParFraError, boolean overFlowErr)
int	configureComPortData(long handle, int dataBits, int stopBits, int parity, int baudRateTranslated, int custBaudTranslated)
long	createBlockingIOContext()
String[]	createCustomLoopBackDevice(int deviceIndex, int rtsMap, int dtrMap, boolean setDTRatOpen)
String[]	createCustomNullModemPair(int idx1, int rtsMap1, int dtrMap1, boolean setDTRatOpen1, int idx2, int rtsMap2, int dtrMap2, boolean setDTRatOpen2)
String[]	createStandardLoopBackDevice(int deviceIndex)
String[]	createStandardNullModemPair(int deviceIndex1, int deviceIndex2)
int	destroyAllCreatedLoopbackDevices()
int	destroyAllCreatedNullModemPairs()
int	destroyAllCreatedVirtualDevices()
int	destroyBlockingIOContext(long context)
int	destroyDataLooperThread(long handle)
int	destroyEventLooperThread(long handle)
int	destroyGivenVirtualDevice(String device)
Object	emulateFaultyCable(String deviceNode, boolean state)
int	emulateLineRingingEvent(String devNode, boolean state)
int	emulateSerialEvent(String devNode, int error)
String	findDriverServingComPort(String comPortName)
String	findIRQnumberForComPort(long handle)
int	fineTuneRead(long handle, int vmin, int vtime, int rit, int rttm, int rttc)
int[]	getByteCount(long handle)
int[]	getCurrentConfigurationU(long handle)
String[]	getCurrentConfigurationW(long handle)
int[]	getInterruptCount(long handle)
String[]	getLastLoopBackDeviceNode()
String[]	getLastNullModemPairNodes()
int[]	getLinesStatus(long handle)
String	getNativeLibraryVersion()
String[]	getStatsForGivenDevice(String deviceNode)
int	initNativeLib()
String[]	listAllExistingPorts()
String[]	listAllExistingPortsWithInfo()
String[]	listAvailableComPorts()
String[]	listExistingCustomLoopbackPorts()
String[]	listExistingCustomNullModemPorts()
String[]	listExistingStandardLoopbackPorts()
String[]	listExistingStandardNullModemPorts()
String[]	listNextAvailablePorts()
static boolean	loadNativeLibrary(String directoryPath, String loadedLibName, com.serialpundit.core.SerialComSystemProperty serialComSystemProperty, int osType, int cpuArch, int abiType, boolean hotDeploy) Extract native library from jar in a working directory, load and link it.
long	openComPort(String portName, boolean enableRead, boolean enableWrite, boolean exclusiveOwner)
int	pauseListeningEvents(long handle)
byte[]	readBytes(long handle, int byteCount)
byte[]	readBytesBlocking(long handle, int byteCount, long context)
int	readBytesDirect(long handle, ByteBuffer buffer, int offset, int length)
int	readBytesP(long handle, byte[] buffer, int offset, int length, long context, SerialComLineErrors lineErr)
int	registerTTY2COMHotPlugEventListener(Itty2comHotPlugListener hotPlugListener, String deviceNode)
int	resumeListeningEvents(long handle)
int	sendBreak(long handle, int duration)
int	setDTR(long handle, boolean enabled)
int	setRTS(long handle, boolean enabled)
int	setUpDataLooperThread(long handle, SerialComLooper looper)
int	setUpEventLooperThread(long handle, SerialComLooper looper)
int	setuptty2com()
int	unblockBlockingIOOperation(long context)
int	unregisterTTY2COMHotPlugEventListener(int opaqueHandle)
int	unsetuptty2com()
int	writeBytes(long handle, byte[] buffer, int delay)
int	writeBytesBlocking(long handle, byte[] buffer, long context)
int	writeBytesDirect(long handle, ByteBuffer buffer, int offset, int length)
int	writeSingleByte(long handle, byte dataByte)

Methods inherited from class java.lang.Object

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

Constructor Detail

SerialComPortJNIBridge

public SerialComPortJNIBridge()

Allocates a new SerialComPortJNIBridge object.

Method Detail

loadNativeLibrary

public static boolean loadNativeLibrary(String directoryPath,
                        String loadedLibName,
                        com.serialpundit.core.SerialComSystemProperty serialComSystemProperty,
                        int osType,
                        int cpuArch,
                        int abiType,
                        boolean hotDeploy)
                                 throws com.serialpundit.core.SerialComException

Extract native library from jar in a working directory, load and link it. The native library is found in the root of 'sp-tty.jar' file.

Parameters:

directoryPath - null for default directory or user supplied directory path.

loadedLibName - null for default name or user supplied name of loaded library.

serialComSystemProperty - instance of SerialComSystemProperty to get required java properties.

cpuArch - architecture of CPU this library is running on.

osType - operating system this library is running on.

abiType - binary application interface type to correctly link.

hotDeploy - true if tomcat hot deployment is needed otherwise false.

Returns:

true on success.

Throws:

com.serialpundit.core.SerialComException - if java system properties can not be accessed or required files can not be accessed, if shared library is not found, it can not be loaded, linked and initialized etc.

initNativeLib

public int initNativeLib()

getNativeLibraryVersion

public String getNativeLibraryVersion()

listAvailableComPorts

public String[] listAvailableComPorts()

setUpDataLooperThread

public int setUpDataLooperThread(long handle,
                        SerialComLooper looper)

setUpEventLooperThread

public int setUpEventLooperThread(long handle,
                         SerialComLooper looper)

destroyDataLooperThread

public int destroyDataLooperThread(long handle)

destroyEventLooperThread

public int destroyEventLooperThread(long handle)

pauseListeningEvents

public int pauseListeningEvents(long handle)

resumeListeningEvents

public int resumeListeningEvents(long handle)

openComPort

public long openComPort(String portName,
               boolean enableRead,
               boolean enableWrite,
               boolean exclusiveOwner)

closeComPort

public int closeComPort(long handle)

readBytes

public byte[] readBytes(long handle,
               int byteCount)

readBytesP

public int readBytesP(long handle,
             byte[] buffer,
             int offset,
             int length,
             long context,
             SerialComLineErrors lineErr)

readBytesBlocking

public byte[] readBytesBlocking(long handle,
                       int byteCount,
                       long context)

readBytesDirect

public int readBytesDirect(long handle,
                  ByteBuffer buffer,
                  int offset,
                  int length)

writeBytes

public int writeBytes(long handle,
             byte[] buffer,
             int delay)

writeBytesDirect

public int writeBytesDirect(long handle,
                   ByteBuffer buffer,
                   int offset,
                   int length)

writeSingleByte

public int writeSingleByte(long handle,
                  byte dataByte)

writeBytesBlocking

public int writeBytesBlocking(long handle,
                     byte[] buffer,
                     long context)

createBlockingIOContext

public long createBlockingIOContext()

unblockBlockingIOOperation

public int unblockBlockingIOOperation(long context)

destroyBlockingIOContext

public int destroyBlockingIOContext(long context)

setRTS

public int setRTS(long handle,
         boolean enabled)

setDTR

public int setDTR(long handle,
         boolean enabled)

getLinesStatus

public int[] getLinesStatus(long handle)

getInterruptCount

public int[] getInterruptCount(long handle)

findDriverServingComPort

public String findDriverServingComPort(String comPortName)

findIRQnumberForComPort

public String findIRQnumberForComPort(long handle)

sendBreak

public int sendBreak(long handle,
            int duration)

getByteCount

public int[] getByteCount(long handle)

clearPortIOBuffers

public int clearPortIOBuffers(long handle,
                     boolean rxPortbuf,
                     boolean txPortbuf)

configureComPortData

public int configureComPortData(long handle,
                       int dataBits,
                       int stopBits,
                       int parity,
                       int baudRateTranslated,
                       int custBaudTranslated)

configureComPortControl

public int configureComPortControl(long handle,
                          int flowctrl,
                          byte xonCh,
                          byte xoffCh,
                          boolean ParFraError,
                          boolean overFlowErr)

getCurrentConfigurationU

public int[] getCurrentConfigurationU(long handle)

getCurrentConfigurationW

public String[] getCurrentConfigurationW(long handle)

fineTuneRead

public int fineTuneRead(long handle,
               int vmin,
               int vtime,
               int rit,
               int rttm,
               int rttc)

setuptty2com

public int setuptty2com()

unsetuptty2com

public int unsetuptty2com()

listNextAvailablePorts

public String[] listNextAvailablePorts()

listExistingStandardNullModemPorts

public String[] listExistingStandardNullModemPorts()

listExistingCustomNullModemPorts

public String[] listExistingCustomNullModemPorts()

listExistingStandardLoopbackPorts

public String[] listExistingStandardLoopbackPorts()

listExistingCustomLoopbackPorts

public String[] listExistingCustomLoopbackPorts()

listAllExistingPorts

public String[] listAllExistingPorts()

listAllExistingPortsWithInfo

public String[] listAllExistingPortsWithInfo()

createStandardNullModemPair

public String[] createStandardNullModemPair(int deviceIndex1,
                                   int deviceIndex2)

createCustomNullModemPair

public String[] createCustomNullModemPair(int idx1,
                                 int rtsMap1,
                                 int dtrMap1,
                                 boolean setDTRatOpen1,
                                 int idx2,
                                 int rtsMap2,
                                 int dtrMap2,
                                 boolean setDTRatOpen2)

createStandardLoopBackDevice

public String[] createStandardLoopBackDevice(int deviceIndex)

createCustomLoopBackDevice

public String[] createCustomLoopBackDevice(int deviceIndex,
                                  int rtsMap,
                                  int dtrMap,
                                  boolean setDTRatOpen)

destroyAllCreatedVirtualDevices

public int destroyAllCreatedVirtualDevices()

destroyAllCreatedNullModemPairs

public int destroyAllCreatedNullModemPairs()

destroyAllCreatedLoopbackDevices

public int destroyAllCreatedLoopbackDevices()

destroyGivenVirtualDevice

public int destroyGivenVirtualDevice(String device)

getLastLoopBackDeviceNode

public String[] getLastLoopBackDeviceNode()

getLastNullModemPairNodes

public String[] getLastNullModemPairNodes()

emulateSerialEvent

public int emulateSerialEvent(String devNode,
                     int error)

emulateLineRingingEvent

public int emulateLineRingingEvent(String devNode,
                          boolean state)

registerTTY2COMHotPlugEventListener

public int registerTTY2COMHotPlugEventListener(Itty2comHotPlugListener hotPlugListener,
                                      String deviceNode)

unregisterTTY2COMHotPlugEventListener

public int unregisterTTY2COMHotPlugEventListener(int opaqueHandle)

getStatsForGivenDevice

public String[] getStatsForGivenDevice(String deviceNode)

emulateFaultyCable

public Object emulateFaultyCable(String deviceNode,
                        boolean state)