com.serialpundit.serial.internal

Class SerialComCompletionDispatcher

java.lang.Object

com.serialpundit.serial.internal.SerialComCompletionDispatcher

public final class SerialComCompletionDispatcher
extends Object

Represents Proactor in our IO design pattern.

An application may register data listener only, event listener only or both listeners. A single dedicated looper handles both the listeners. We first check if a looper exist for given handle or not. If it does not exist we create and start looper thread which loops over data or event as specified by application. If it exist, we start data or event looper thread as specified by application.

An application can have multiple handles for the same port (if there is no exclusive owner of port).

1. A handle can have only one looper for delivering data and line events.
2. A looper can have none or only one data looper at any instant of time.
3. A looper can have none or only one event looper at any instant of time.

Author:

Rishi Gupta

Constructor Summary

Constructors

Constructor and Description
SerialComCompletionDispatcher(SerialComPortJNIBridge mComPortJNIBridge, TreeMap<Long,SerialComPortHandleInfo> portHandleInfo) Allocates a new SerialComCompletionDispatcher object.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	destroyDataLooper(long handle, SerialComPortHandleInfo handleInfo, ISerialComDataListener dataListener) Check if we have handler corresponding to this listener and take actions accordingly.
boolean	destroyEventLooper(long handle, SerialComPortHandleInfo handleInfo, ISerialComEventListener eventListener) Check if we have handler corresponding to this listener and take actions accordingly.
boolean	pauseListeningEvents(ISerialComEventListener listener) Check if we have handler corresponding to this listener and take actions accordingly.
boolean	resumeListeningEvents(ISerialComEventListener listener) Check if we have handler corresponding to this listener and take actions accordingly.
boolean	setUpDataLooper(long handle, SerialComPortHandleInfo mHandleInfo, ISerialComDataListener dataListener) This method creates data looper thread and initialize subsystem for data event passing.
boolean	setUpEventLooper(long handle, SerialComPortHandleInfo mHandleInfo, ISerialComEventListener eventListener) This method creates event looper thread and initialize subsystem for line event passing.

Methods inherited from class java.lang.Object

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

Constructor Detail

SerialComCompletionDispatcher

public SerialComCompletionDispatcher(SerialComPortJNIBridge mComPortJNIBridge,
                             TreeMap<Long,SerialComPortHandleInfo> portHandleInfo)

Allocates a new SerialComCompletionDispatcher object.

Parameters:

mComPortJNIBridge - interface used to invoke appropriate native function

portHandleInfo - reference to portHandleInfo object to get/set information about handle/port

Method Detail

setUpDataLooper

public boolean setUpDataLooper(long handle,
                      SerialComPortHandleInfo mHandleInfo,
                      ISerialComDataListener dataListener)
                        throws com.serialpundit.core.SerialComException

This method creates data looper thread and initialize subsystem for data event passing.

Parameters:

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

mHandleInfo - Reference to SerialComPortHandleInfo object associated with given handle.

dataListener - listener for which looper has to be set up.

Returns:

true on success.

Throws:

com.serialpundit.core.SerialComException - if not able to complete requested operation.

destroyDataLooper

public boolean destroyDataLooper(long handle,
                        SerialComPortHandleInfo handleInfo,
                        ISerialComDataListener dataListener)
                          throws com.serialpundit.core.SerialComException

Check if we have handler corresponding to this listener and take actions accordingly.

Parameters:

handle - handle of the serial port for which this data listener was registered.

handleInfo - global information object about this handle.

dataListener - listener for which looper has to be removed.

Returns:

true on success.

Throws:

com.serialpundit.core.SerialComException - if not able to complete requested operation.

setUpEventLooper

public boolean setUpEventLooper(long handle,
                       SerialComPortHandleInfo mHandleInfo,
                       ISerialComEventListener eventListener)
                         throws com.serialpundit.core.SerialComException

This method creates event looper thread and initialize subsystem for line event passing.

Parameters:

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

mHandleInfo - Reference to SerialComPortHandleInfo object associated with given handle.

eventListener - listener for which looper has to be set up.

Returns:

true on success.

Throws:

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

destroyEventLooper

public boolean destroyEventLooper(long handle,
                         SerialComPortHandleInfo handleInfo,
                         ISerialComEventListener eventListener)
                           throws com.serialpundit.core.SerialComException

Check if we have handler corresponding to this listener and take actions accordingly.

Parameters:

handle - handle of the serial port for which this event listener was registered.

handleInfo - global information object about this handle.

eventListener - listener for which looper has to be removed.

Returns:

true on success.

Throws:

com.serialpundit.core.SerialComException - if not able to complete requested operation.

pauseListeningEvents

public boolean pauseListeningEvents(ISerialComEventListener listener)
                             throws com.serialpundit.core.SerialComException

Check if we have handler corresponding to this listener and take actions accordingly.

Parameters:

listener - listener for which event has to be paused.

Returns:

true on success.

Throws:

com.serialpundit.core.SerialComException - if not able to complete requested operation.

resumeListeningEvents

public boolean resumeListeningEvents(ISerialComEventListener listener)
                              throws com.serialpundit.core.SerialComException

Check if we have handler corresponding to this listener and take actions accordingly.

Parameters:

listener - for which events sending should be resumed.

Returns:

true on success.

Throws:

com.serialpundit.core.SerialComException - if not able to complete requested operation.