com.serialpundit.serial.internal

Class SerialComLooper

java.lang.Object

com.serialpundit.serial.internal.SerialComLooper

public final class SerialComLooper
extends Object

Encapsulates environment for data and event looper implementation. This runs in as a different thread context and keep looping over data/event queue, delivering data/events to the intended registered listener (data/event handler) one by one.

The rate of delivery of data/events are directly proportional to how fast listener finishes his job and let us return.

Author:

Rishi Gupta

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
int	getEventsMask() Gives the event mask currently active.
void	insertInDataErrorQueue(int errorNum) This method insert error info in error queue which will be later delivered to application.
void	insertInDataQueue(byte[] newData) This method is called from native code to pass data bytes.
void	insertInEventQueue(int newEvent) Native side detects the change in status of lines, get the new line status and call this method.
void	pause() Data looper thread refrains from sending new data to the data listener.
void	resume() Looper starts sending new data again to the data listener.
void	setEventsMask(int newMask) In future we may shift modifying mask in the native code itself, so as to prevent JNI transitions.
void	startDataLooper(long handle, ISerialComDataListener dataListener, String portName) Start the thread to loop over data queue.
void	startEventLooper(long handle, ISerialComEventListener eventListener, String portName) Get initial status of control lines and start Java worker thread.
void	stopDataLooper() Set the flag to indicate that the thread is supposed to run to completion and exit.
void	stopEventLooper() Set the flag to indicate that the thread is supposed to run to completion and exit.

Methods inherited from class java.lang.Object

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

Constructor Detail

SerialComLooper

public SerialComLooper(SerialComPortJNIBridge mComPortJNIBridge)

Allocates a new SerialComLooper object.

Parameters:

mComPortJNIBridge - interface used to invoke appropriate native function.

Method Detail

insertInDataQueue

public void insertInDataQueue(byte[] newData)

This method is called from native code to pass data bytes.

Parameters:

newData - byte array containing data read from serial port

insertInDataErrorQueue

public void insertInDataErrorQueue(int errorNum)

This method insert error info in error queue which will be later delivered to application.

Parameters:

errorNum - operating system specific error number to be sent to application.

insertInEventQueue

public void insertInEventQueue(int newEvent)

Native side detects the change in status of lines, get the new line status and call this method. Based on the mask this method determines whether this event should be sent to application or not.

Parameters:

newEvent - bit mask representing event on serial port control lines.

startDataLooper

public void startDataLooper(long handle,
                   ISerialComDataListener dataListener,
                   String portName)

Start the thread to loop over data queue.

Parameters:

handle - handle of the opened port for which data looper need to be started.

dataListener - listener to which data will be delivered.

portName - name of port represented by this handle.

stopDataLooper

public void stopDataLooper()

Set the flag to indicate that the thread is supposed to run to completion and exit. Interrupt the thread so that take() method can come out of blocked sleep state.

startEventLooper

public void startEventLooper(long handle,
                    ISerialComEventListener eventListener,
                    String portName)
                      throws com.serialpundit.core.SerialComException

Get initial status of control lines and start Java worker thread.

Parameters:

handle - handle of the opened port for which event looper need to be started.

eventListener - listener to which event will be delivered.

portName - name of port represented by this handle.

Throws:

com.serialpundit.core.SerialComException - if an error occurs.

stopEventLooper

public void stopEventLooper()
                     throws com.serialpundit.core.SerialComException

Set the flag to indicate that the thread is supposed to run to completion and exit. Interrupt the thread so that take() method can come out of blocked sleep state.

Throws:

com.serialpundit.core.SerialComException - if an error occurs.

pause

public void pause()

Data looper thread refrains from sending new data to the data listener.

resume

public void resume()

Looper starts sending new data again to the data listener.

setEventsMask

public void setEventsMask(int newMask)

In future we may shift modifying mask in the native code itself, so as to prevent JNI transitions. This filters what events should be sent to application. Note that, although we sent only those event for which user has set mask, however native code send all the events to java layer as of now.

Parameters:

newMask - new bit mask for events that will be delivered to application.

getEventsMask

public int getEventsMask()

Gives the event mask currently active.

Returns:

bit mask of events currently active.