org.ka2ddo.yaac.io
Class ExternalMessageSourceConnector

java.lang.Object
  extended by org.ka2ddo.ax25.Connector
      extended by org.ka2ddo.yaac.io.PortConnector
          extended by org.ka2ddo.yaac.io.ExternalMessageSourceConnector

public class ExternalMessageSourceConnector
extends PortConnector

This implements a TCP or UDP socket for receiving ASCII-text messages to transmit to the RF and APRS-IS networks for APRS. This is useful for forwarding messages from other applications (direction finders, weather stations, telemetry, etc.). Either YAAC or the other application can initiate the connection or listen for incoming connections. The message format is ASCII lines (terminated by CR or LF control character for TCP, the whole datagram body for UDP) in one of these formats as explicitly configured here:


Nested Class Summary
 
Nested classes/interfaces inherited from class org.ka2ddo.ax25.Connector
Connector.PortStats
 
Field Summary
static java.lang.String CONFIG_GUI
           
static java.lang.String TYPE_NAME
           
 
Fields inherited from class org.ka2ddo.yaac.io.PortConnector
currentCfg, portConfig
 
Fields inherited from class org.ka2ddo.ax25.Connector
CAP_FULL_DUPLEX, CAP_GPS_DATA, CAP_HF, CAP_IGATE, CAP_OPENTRAC, CAP_RCV_PACKET_DATA, CAP_RF, CAP_WAYPOINT_SENDER, CAP_WEATHER, CAP_XMT_PACKET_DATA, stats
 
Constructor Summary
ExternalMessageSourceConnector()
           
 
Method Summary
 void close()
          Shut down this port connection.
 void configure(PortConfig config)
          Update the configuration of the connector to match the updated setup.
 int getCapabilities()
          Specify what capabilities a port of this type has.
 boolean isOpen()
          Reports whether this PortConnector has an open connection to its port.
 java.lang.String toString()
          Returns a string representation of the object.
 
Methods inherited from class org.ka2ddo.yaac.io.PortConnector
addFrameListener, addPortEventListener, createPort, fireConsumeFrame, fireConsumeFrame, fireFailed, fireReceiving, fireTransmitting, getPortConnectorClass, portConnectorClasses, portTypeNames, registerPortConnectorType, removeFrameListener, removePortEventListener, setPortConfig
 
Methods inherited from class org.ka2ddo.ax25.Connector
finalize, getCallsign, getStats, hasCapability
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

TYPE_NAME

public static final java.lang.String TYPE_NAME
See Also:
Constant Field Values

CONFIG_GUI

public static final java.lang.String CONFIG_GUI
See Also:
Constant Field Values
Constructor Detail

ExternalMessageSourceConnector

public ExternalMessageSourceConnector()
Method Detail

configure

public void configure(PortConfig config)
               throws java.io.IOException,
                      java.lang.IllegalArgumentException
Update the configuration of the connector to match the updated setup.

Specified by:
configure in class PortConnector
Parameters:
config - PortConfig defining new port settings
Throws:
java.io.IOException - if interface changes could not be applied
java.lang.IllegalArgumentException - if type information is invalid for changing the settings of this PortConnector

isOpen

public boolean isOpen()
Reports whether this PortConnector has an open connection to its port.

Specified by:
isOpen in class Connector
Returns:
boolean true if PortConnector is open

close

public void close()
Shut down this port connection. Expected to be overridden by sub-classes.

Overrides:
close in class Connector

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_RCV_PACKET_DATA, Connector.CAP_XMT_PACKET_DATA, Connector.CAP_FULL_DUPLEX, Connector.CAP_GPS_DATA, Connector.CAP_IGATE, Connector.CAP_OPENTRAC, Connector.CAP_RF, Connector.CAP_WAYPOINT_SENDER, Connector.CAP_WEATHER

toString

public java.lang.String toString()
Returns a string representation of the object.

Overrides:
toString in class java.lang.Object
Returns:
a string representation of the object.