Package org.yamcs.tctm

Class TcpTcDataLink

java.lang.Object

com.google.common.util.concurrent.AbstractService

org.yamcs.tctm.AbstractLink

org.yamcs.tctm.AbstractTcDataLink

org.yamcs.tctm.AbstractThreadedTcDataLink

org.yamcs.tctm.TcpTcDataLink

All Implemented Interfaces:

com.google.common.util.concurrent.Service, Runnable, SystemParametersProducer, Link, LinkActionProvider, TcDataLink

public class TcpTcDataLink
extends AbstractThreadedTcDataLink

Sends raw command packets on TCP socket.

Nested Class Summary

Nested classes/interfaces inherited from interface org.yamcs.tctm.Link

Link.Status

Nested classes/interfaces inherited from interface com.google.common.util.concurrent.Service

com.google.common.util.concurrent.Service.Listener, com.google.common.util.concurrent.Service.State

Field Summary

Fields

Modifier and Type	Field	Description
protected String	host
protected int	port
protected Selector	selector
protected SocketChannel	socketChannel

Fields inherited from class org.yamcs.tctm.AbstractThreadedTcDataLink

commandQueue

Fields inherited from class org.yamcs.tctm.AbstractTcDataLink

cmdPostProcessor, commandHistoryPublisher, housekeepingInterval

Fields inherited from class org.yamcs.tctm.AbstractLink

config, dataInCount, dataOutCount, disabled, eventProducer, LINK_NAMESPACE, linkName, log, timeService, yamcsInstance

Constructor Summary

Constructors

Constructor	Description
TcpTcDataLink()

Method Summary

Modifier and Type	Method	Description
protected Link.Status	connectionStatus()	In case the link should be connected (i.e. is running and enabled) this method is called to return the actual connection status
protected void	disconnect()
protected void	doHousekeeping()	Called each AbstractTcDataLink.housekeepingInterval milliseconds, can be used to establish tcp connections or similar things
String	getDetailedStatus()	Returns a short detail status (one-line)
Spec	getSpec()	Returns the valid configuration of the input args of this link.
void	init(String yamcsInstance, String name, YConfiguration config)	Called at startup to initialize the link.
protected boolean	openSocket()	attempts to open the socket if not already open and returns true if its open at the end of the call
void	shutDown()	Called at shutdown (if the link is enabled) or when the link is disabled
protected void	startUp()	Called at start up (if the link is enabled) or when the link is enabled
void	uplinkCommand(PreparedCommand pc)	Called

Methods inherited from class org.yamcs.tctm.AbstractThreadedTcDataLink

doDisable, doEnable, doStart, doStop, getDefaultSpec, run, sendCommand

Methods inherited from class org.yamcs.tctm.AbstractTcDataLink

ackCommand, failedCommand, getDataInCount, initPostprocessor, postprocess, setCommandHistoryPublisher

Methods inherited from class org.yamcs.tctm.AbstractLink

addAction, collectSystemParameters, dataIn, dataOut, disable, enable, getAction, getActions, getConfig, getCurrentTime, getDataOutCount, getEventLoop, getLinkStatus, getName, getParent, getSystemParameters, getYamcsInstance, isDisabled, isRunningAndEnabled, resetCounters, setParent, setupSystemParameters

Methods inherited from class com.google.common.util.concurrent.AbstractService

addListener, awaitRunning, awaitRunning, awaitRunning, awaitTerminated, awaitTerminated, awaitTerminated, doCancelStart, failureCause, isRunning, notifyFailed, notifyStarted, notifyStopped, startAsync, state, stopAsync, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.yamcs.tctm.Link

disable, enable, getConfig, getDataOutCount, getExtraInfo, getLinkStatus, getName, getParent, isDisabled, isEffectivelyDisabled, resetCounters, setParent, setupSystemParameters

Methods inherited from interface org.yamcs.parameter.SystemParametersProducer

getFrequency

Methods inherited from interface org.yamcs.tctm.TcDataLink

isCommandingAvailable, isTcDataLinkImplemented

Field Details

socketChannel

protected SocketChannel socketChannel

host

protected String host

port

protected int port

selector

protected Selector selector

Constructor Details

TcpTcDataLink

public TcpTcDataLink()

Method Details

getSpec

public Spec getSpec()

Description copied from interface: Link

Returns the valid configuration of the input args of this link.

Returns:

the argument specification, or null if the args should not be validated.

init

public void init(String yamcsInstance,
 String name,
 YConfiguration config)
          throws ConfigurationException

Description copied from interface: Link

Called at startup to initialize the link.

The config corresponds to the map that is under the link definition in yamcs.instance.yaml.

Specified by:

init in interface Link

Overrides:

init in class AbstractThreadedTcDataLink

config - - the configuration - cannot be null (but can be empty)

Throws:

ConfigurationException

openSocket

protected boolean openSocket()

attempts to open the socket if not already open and returns true if its open at the end of the call

Returns:

disconnect

protected void disconnect()

getDetailedStatus

public String getDetailedStatus()

Description copied from interface: Link

Returns a short detail status (one-line)

Specified by:

getDetailedStatus in interface Link

Overrides:

getDetailedStatus in class AbstractLink

startUp

protected void startUp()

Description copied from class: AbstractThreadedTcDataLink

Called at start up (if the link is enabled) or when the link is enabled

Specified by:

startUp in class AbstractThreadedTcDataLink

shutDown

public void shutDown()
              throws Exception

Description copied from class: AbstractThreadedTcDataLink

Called at shutdown (if the link is enabled) or when the link is disabled

Specified by:

shutDown in class AbstractThreadedTcDataLink

Throws:

Exception

uplinkCommand

public void uplinkCommand(PreparedCommand pc)

Description copied from class: AbstractThreadedTcDataLink

Called

Specified by:

uplinkCommand in class AbstractThreadedTcDataLink

doHousekeeping

protected void doHousekeeping()

Description copied from class: AbstractThreadedTcDataLink

Called each AbstractTcDataLink.housekeepingInterval milliseconds, can be used to establish tcp connections or similar things

Overrides:

doHousekeeping in class AbstractThreadedTcDataLink

connectionStatus

protected Link.Status connectionStatus()

Description copied from class: AbstractLink

In case the link should be connected (i.e. is running and enabled) this method is called to return the actual connection status

Specified by:

connectionStatus in class AbstractLink