org.ka2ddo.yaac.io

Class AbstractGpsConnector

java.lang.Object

org.ka2ddo.ax25.Connector

org.ka2ddo.yaac.io.PortConnector

org.ka2ddo.yaac.io.AbstractGpsConnector

All Implemented Interfaces:

java.lang.Thread.UncaughtExceptionHandler, AprsMessageListener, ParsedAX25MessageListener

Direct Known Subclasses:

SerialGpsConnector

public abstract class AbstractGpsConnector
extends PortConnector
implements AprsMessageListener, ParsedAX25MessageListener, java.lang.Thread.UncaughtExceptionHandler

This class provides common functionality for PortConnectors that receive NMEA-0183 data from some kind of connection to a GPS receiver.

Author:

Andrew Pavlin, KA2DDO

Nested Class Summary

Nested classes/interfaces inherited from class org.ka2ddo.yaac.io.PortConnector

PortConnector.PortStatsType

Nested classes/interfaces inherited from class org.ka2ddo.ax25.Connector

Connector.ConnectorType, Connector.PortStats

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Thread	dispatchThread Pointer to consumer thread for rtQueue.
protected GPSDistributor	gpsDistributor Instance specific pointer to GPS parser.
protected java.lang.Runnable	QUEUE_READER Runnable to extract, parse, and process incoming NMEA-0183 sentences.
protected boolean	queuedButNotConsumed Flag indicating when traffic has been queued to the dispatch thread and not yet consumed.
protected FastBlockingQueue<java.lang.String>	rtQueue Queue for passing NMEA-0183 GPS sentences from interface-specific subclasses to the common parsing code in the AbstractGpsConnector superclass.

Fields inherited from class org.ka2ddo.yaac.io.PortConnector

currentCfg, portConfig

Fields inherited from class org.ka2ddo.ax25.Connector

CAP_ADSB, CAP_APRS, CAP_FAST_RF_9600, CAP_FULL_DUPLEX, CAP_GPS_DATA, CAP_HF, CAP_IGATE, CAP_KENWOOD_CMD, CAP_OPENTRAC, CAP_OTHER_TRANSPORT, CAP_RAW_AX25, CAP_RCV_PACKET_DATA, CAP_RF, CAP_SUBCLIENT, CAP_WAYPOINT_SENDER, CAP_WEATHER, CAP_XMT_PACKET_DATA, stats

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractGpsConnector() Initialize attributes of this abstract superclass.

Method Summary

Modifier and Type	Method and Description
void	aprsMessageReceived(Message msg) Delivers the next message received by YAAC that is an APRS message.
int	getCapabilities() Specify what capabilities a port of this type has.
void	parsedAX25MessageReceived(byte pid, AX25Message msg) Delivers the next message received by YAAC that is some sort of parsed AX.25 higher-level message.
protected void	startQueueReader() Start the thread that drains the queue
protected void	stopQueueReader() Cause the queue draining thread to shut down.
void	uncaughtException(java.lang.Thread t, java.lang.Throwable e) Method invoked when the given thread terminates due to the given uncaught exception.
abstract void	write(java.lang.String line) Transmit a line of text containing a waypoint sentence to the GPS device.

Methods inherited from class org.ka2ddo.yaac.io.PortConnector

addPortEventListener, configure, createPort, fillinConfigDefaultsForType, fireFailed, fireReceiving, fireTransmitting, getBitRate, getCollectedStatsTypes, getPortConfig, getPortConnectorClass, getPortConnectorInactivityTimer, getStats, portConnectorClasses, portTypeNames, registerPortConnectorType, removePortEventListener, setPortConfig

Methods inherited from class org.ka2ddo.ax25.Connector

addFrameListener, close, finalize, fireConsumeFrame, fireConsumeFrame, getCallsign, getStats, getType, hasCapability, isOpen, removeFrameListener

Methods inherited from class java.lang.Object

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

Field Detail

rtQueue

protected final FastBlockingQueue<java.lang.String> rtQueue

Queue for passing NMEA-0183 GPS sentences from interface-specific subclasses to the common parsing code in the AbstractGpsConnector superclass.

dispatchThread

protected transient java.lang.Thread dispatchThread

Pointer to consumer thread for rtQueue.

queuedButNotConsumed

protected transient boolean queuedButNotConsumed

Flag indicating when traffic has been queued to the dispatch thread and not yet consumed.

gpsDistributor

protected final GPSDistributor gpsDistributor

Instance specific pointer to GPS parser.

QUEUE_READER

protected final java.lang.Runnable QUEUE_READER

Runnable to extract, parse, and process incoming NMEA-0183 sentences.

Constructor Detail

AbstractGpsConnector

protected AbstractGpsConnector()

Initialize attributes of this abstract superclass.

Method Detail

startQueueReader

protected void startQueueReader()

Start the thread that drains the queue

stopQueueReader

protected void stopQueueReader()

Cause the queue draining thread to shut down.

getCapabilities

public int getCapabilities()

Specify what capabilities a port of this type has.

Overrides:

getCapabilities in class Connector

Returns:

bitmask of capability flags

See Also:

Connector.CAP_GPS_DATA, Connector.CAP_WAYPOINT_SENDER

aprsMessageReceived

public void aprsMessageReceived(Message msg)

Delivers the next message received by YAAC that is an APRS message. Used to forward APRS positions to GPS devices with screens to display as waypoints.

Specified by:

aprsMessageReceived in interface AprsMessageListener

Parameters:

msg - some subclass of Message containing the message contents; the message should have an AX25Frame connected to it

See Also:

AX25Frame, AX25Message.ax25Frame, AX25Message.getAx25Frame()

write

public abstract void write(java.lang.String line)

Transmit a line of text containing a waypoint sentence to the GPS device.

Parameters:

line - String text to transmit

parsedAX25MessageReceived

public void parsedAX25MessageReceived(byte pid,
                                      AX25Message msg)

Delivers the next message received by YAAC that is some sort of parsed AX.25 higher-level message.

Specified by:

parsedAX25MessageReceived in interface ParsedAX25MessageListener

Parameters:

pid - AX.25 protocol ID

msg - some subclass of AX25Message containing the message contents; the message should have an AX25Frame connected to it

See Also:

AX25Frame

uncaughtException

public final void uncaughtException(java.lang.Thread t,
                                    java.lang.Throwable e)

Method invoked when the given thread terminates due to the given uncaught exception.

Any exception thrown by this method will be ignored by the Java Virtual Machine.

Specified by:

uncaughtException in interface java.lang.Thread.UncaughtExceptionHandler

Parameters:

t - the thread

e - the exception