Module de.ibapl.spsw.jniprovider

Package de.ibapl.spsw.jniprovider

Class SerialPortSocketFactoryImpl

java.lang.Object

de.ibapl.spsw.jniprovider.SerialPortSocketFactoryImpl

All Implemented Interfaces:

SerialPortSocketFactory

public class SerialPortSocketFactoryImpl
extends Object
implements SerialPortSocketFactory

Impements the SerialPortSocketFactory.

Author:

Arne Plöse

Field Summary

Fields

Modifier and Type	Field	Description
protected static Logger	LOG

Fields inherited from interface de.ibapl.spsw.api.SerialPortSocketFactory

DEFAULT_DARWIN_DEVICE_PATH, DEFAULT_DARWIN_PORTNAME_PATTERN, DEFAULT_FREE_BSD_DEVICE_PATH, DEFAULT_FREE_BSD_PORTNAME_PATTERN, DEFAULT_LINUX_DEVICE_PATH, DEFAULT_LINUX_PORTNAME_PATTERN, DEFAULT_OPEN_BSD_DEVICE_PATH, DEFAULT_OPEN_BSD_PORTNAME_PATTERN, DEFAULT_SUNOS_DEVICE_PATH, DEFAULT_SUNOS_PORTNAME_PATTERN, DEFAULT_WINDOWS_DEVICE_PATH, DEFAULT_WINDOWS_PORTNAME_PATTERN

Constructor Summary

Constructors

Constructor	Description
SerialPortSocketFactoryImpl()	Do not load the native library here on failure it may throw up the running framework (OSGi, JEE, Spring...)

Method Summary

Modifier and Type	Method	Description
void	activate()	Load the native library in the right lifecycle for the running framework (OSGi, JEE, Spring).
void	deActivate()
protected static void	doSystemLoad(String absoluteLibName)
static String	getLibName()
List<String>	getPortNames(boolean hideBusyPorts)	Get sorted List of serial ports in the system using default settings:
List<String>	getPortNames(String portToInclude, boolean hideBusyPorts)
void	getPortNames(BiConsumer<String,Boolean> portNameConsumer)
protected String	getPortnamesPath()
protected Pattern	getPortnamesRegExp()
protected List<String>	getUnixBasedPortNames(String portToInclude, boolean hideBusyPorts)	Universal method for getting port names of _nix based systems
protected LinkedList<String>	getWindowsBasedPortNames()
protected List<String>	getWindowsPortNames(String portToInclude, boolean hideBusyPorts)	Get serial port names in Windows
SerialPortSocket	open(String portName)
SerialPortSocket	open(String portName, Speed speed, DataBits dataBits, StopBits stopBits, Parity parity, Set<FlowControl> flowControls)
AsyncSerialPortSocket	openAsync(String portName, Speed speed, DataBits dataBits, StopBits stopBits, Parity parity, Set<FlowControl> flowControls, ExecutorService executor)
AsyncSerialPortSocket	openAsync(String portName, ExecutorService executor)
static boolean	touchNativeLib()

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final Logger LOG

Constructor Detail

SerialPortSocketFactoryImpl

public SerialPortSocketFactoryImpl()

Do not load the native library here on failure it may throw up the running framework (OSGi, JEE, Spring...)

Method Detail

doSystemLoad

protected static void doSystemLoad(String absoluteLibName)

touchNativeLib

public static boolean touchNativeLib()

getLibName

public static String getLibName()

getWindowsBasedPortNames

protected LinkedList<String> getWindowsBasedPortNames()

open

public SerialPortSocket open(String portName)
                      throws IOException

Specified by:

open in interface SerialPortSocketFactory

Throws:

IOException

getPortnamesPath

protected String getPortnamesPath()

getPortnamesRegExp

protected Pattern getPortnamesRegExp()

getPortNames

public List<String> getPortNames(boolean hideBusyPorts)

Get sorted List of serial ports in the system using default settings:

Specified by:

getPortNames in interface SerialPortSocketFactory

getPortNames

public List<String> getPortNames(String portToInclude,
                                 boolean hideBusyPorts)

Specified by:

getPortNames in interface SerialPortSocketFactory

getWindowsPortNames

protected List<String> getWindowsPortNames(String portToInclude,
                                           boolean hideBusyPorts)

Get serial port names in Windows

Since:

2.3.0

getUnixBasedPortNames

protected List<String> getUnixBasedPortNames(String portToInclude,
                                             boolean hideBusyPorts)

Universal method for getting port names of _nix based systems

activate

public void activate()

Load the native library in the right lifecycle for the running framework (OSGi, JEE, Spring).

deActivate

public void deActivate()

open

public SerialPortSocket open(String portName,
                             Speed speed,
                             DataBits dataBits,
                             StopBits stopBits,
                             Parity parity,
                             Set<FlowControl> flowControls)
                      throws IOException,
                             IllegalStateException

Specified by:

open in interface SerialPortSocketFactory

Throws:

IOException

IllegalStateException

getPortNames

public void getPortNames(BiConsumer<String,Boolean> portNameConsumer)

Specified by:

getPortNames in interface SerialPortSocketFactory

openAsync

public AsyncSerialPortSocket openAsync(String portName,
                                       ExecutorService executor)
                                throws IOException,
                                       IllegalStateException

Specified by:

openAsync in interface SerialPortSocketFactory

Throws:

IOException

IllegalStateException

openAsync

public AsyncSerialPortSocket openAsync(String portName,
                                       Speed speed,
                                       DataBits dataBits,
                                       StopBits stopBits,
                                       Parity parity,
                                       Set<FlowControl> flowControls,
                                       ExecutorService executor)
                                throws IOException

Specified by:

openAsync in interface SerialPortSocketFactory

Throws:

IOException