com.embeddedunveiled.serial.comdb

Class SerialComDBRelease

java.lang.Object

com.embeddedunveiled.serial.comdb.SerialComDBRelease

public final class SerialComDBRelease
extends Object

Provides methods to release COM port numbers assigned by Windows operating system to serial ports in system.

In Windows, the system-supplied COM port database arbitrates the use of COM port numbers by COM ports that are installed on the system. Microsoft Windows provides this component to facilitate installing COM ports and, in particular, to ensure that each port number is assigned, at most, to one port. The component consists of the database and a library containing functions that the installation software calls to access the database. All system-supplied installers for COM ports use the COM port database to obtain a COM port number. Although not a Plug and Play requirement, all vendor-supplied installers should also use the COM port database to obtain a COM port number.

Author:

Rishi Gupta

Constructor Summary

Constructors

Constructor and Description
SerialComDBRelease(SerialComDBReleaseJNIBridge mSerialComDBReleaseJNIBridge) Construct and allocates a new SerialComDBRelease object with given details.

Method Summary

Methods

Modifier and Type	Method and Description
String[]	getComPortNumbersInUse() Provides an array containing all COM ports which are marked as "(in use)" by Windows operating system.
int	getCurrentComDBDatabaseSize() Provides the current size of COM port database.
boolean	releaseAllComPorts(String[] excludeList) Free all the COM port number in database of Windows of operating system so that other serial devices can use that port number.
boolean	releaseComPort(String comPortName) Free the COM port number in database of Windows of operating system so that other serial devices can use that port number.
boolean	resizeComDBDatabase(int newSize) It resizes database to arbitrate give number of serial ports.
boolean	startSerialComDBReleaseSerive() Starts the service on demand.
boolean	stopSerialComDBReleaseSerive() Stops the service on demand.

Methods inherited from class java.lang.Object

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

Constructor Detail

SerialComDBRelease

public SerialComDBRelease(SerialComDBReleaseJNIBridge mSerialComDBReleaseJNIBridge)

Construct and allocates a new SerialComDBRelease object with given details.

Parameters:

mSerialComDBReleaseJNIBridge - interface class to native library for calling platform specific routines.

Throws:

SerialComException - if the object can not be constructed.

Method Detail

startSerialComDBReleaseSerive

public boolean startSerialComDBReleaseSerive()
                                      throws SerialComException

Starts the service on demand. This method gives more control to application to manage the service as and when needed.

Returns:

true if the service was started successfully and communication was established.

Throws:

SerialComException - if an error occurs.

stopSerialComDBReleaseSerive

public boolean stopSerialComDBReleaseSerive()
                                     throws SerialComException

Stops the service on demand. This method gives more control to application to manage the service as and when needed.

Returns:

true if the service was stopped successfully.

Throws:

SerialComException - if an error occurs.

releaseComPort

public boolean releaseComPort(String comPortName)
                       throws SerialComException

Free the COM port number in database of Windows of operating system so that other serial devices can use that port number.

Parameters:

comPortName - COM port to be released for example COM32 etc.

Returns:

true on success.

Throws:

SerialComException - if given COM port can not be released or an error occurs.

releaseAllComPorts

public boolean releaseAllComPorts(String[] excludeList)
                           throws SerialComException

Free all the COM port number in database of Windows of operating system so that other serial devices can use that port number. Typically, if there are serial devices that will be always present in system for example Bluetooth modem on serial interface on computer's motherboard, than you may not want to release COM port number assigned to this device. Add this COM port in excludeList and this library will not remove it from database.

Parameters:

excludeList - list of COM ports that should not be released.

Returns:

true on success.

Throws:

SerialComException - if COM ports can not be released or an error occurs.

getComPortNumbersInUse

public String[] getComPortNumbersInUse()
                                throws SerialComException

Provides an array containing all COM ports which are marked as "(in use)" by Windows operating system.

Returns:

array of strings containing COM ports marked as in use.

Throws:

SerialComException - if an error occurs.

getCurrentComDBDatabaseSize

public int getCurrentComDBDatabaseSize()
                                throws SerialComException

Provides the current size of COM port database.

Returns:

current size of COM port database.

Throws:

SerialComException - if an error occurs.

resizeComDBDatabase

public boolean resizeComDBDatabase(int newSize)
                            throws SerialComException

It resizes database to arbitrate give number of serial ports.

Parameters:

newSize - number of port numbers to be arbitrated in the database.

Returns:

true on success.

Throws:

SerialComException - if COM ports can not be released or an error occurs.