Module org.yamcs.core

Package org.yamcs.tctm

Class AbstractTcDataLink

java.lang.Object

com.google.common.util.concurrent.AbstractService

org.yamcs.tctm.AbstractLink

org.yamcs.tctm.AbstractTcDataLink

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractThreadedTcDataLink, Cop1TcPacketHandler, TcPacketHandler

public abstract class AbstractTcDataLink
extends AbstractLink
implements TcDataLink

Base implementation for a TC data link that initialises a post processor and implements basic methods.

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 CommandPostprocessor	cmdPostProcessor
protected CommandHistoryPublisher	commandHistoryPublisher
protected AtomicLong	dataCount
protected long	housekeepingInterval

Fields inherited from class org.yamcs.tctm.AbstractLink

config, disabled, eventProducer, linkName, log, timeService, yamcsInstance

Constructor Summary

Constructors

Constructor	Description
AbstractTcDataLink()

Method Summary

Modifier and Type	Method	Description
protected void	ackCommand(org.yamcs.protobuf.Commanding.CommandId commandId)	send an ack in the command history that the command has been sent out of the link
protected void	failedCommand(org.yamcs.protobuf.Commanding.CommandId commandId, String reason)	Send to command history the failed command
protected long	getCurrentTime()
long	getDataInCount()
long	getDataOutCount()
AggregatedDataLink	getParent()	If this link is a sublink of an aggregated link, get the parent link.
String	getYamcsInstance()
void	init(String yamcsInstance, String linkName, YConfiguration config)	Called at startup to initialize the link.
protected void	initPostprocessor(String instance, YConfiguration config)
protected byte[]	postprocess(PreparedCommand pc)	Postprocesses the command, unless postprocessing is disabled.
void	resetCounters()
void	setCommandHistoryPublisher(CommandHistoryPublisher commandHistoryListener)
void	setParent(AggregatedDataLink parent)	Set the parent link if this is a sublink of an aggregated link.

Methods inherited from class org.yamcs.tctm.AbstractLink

collectSystemParameters, connectionStatus, disable, doDisable, doEnable, enable, getConfig, getDetailedStatus, getEventLoop, getLinkStatus, getName, getSystemParameters, isDisabled, isRunningAndEnabled, setupSystemParameters

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

addListener, awaitRunning, awaitRunning, awaitRunning, awaitTerminated, awaitTerminated, awaitTerminated, doCancelStart, doStart, doStop, 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, getDetailedStatus, getLinkStatus, getName, getSpec, isDisabled, isEffectivelyDisabled, setupSystemParameters

Methods inherited from interface org.yamcs.parameter.SystemParametersProducer

getFrequency, getSystemParameters

Methods inherited from interface org.yamcs.tctm.TcDataLink

sendCommand, sendTc

Field Details

commandHistoryPublisher

protected CommandHistoryPublisher commandHistoryPublisher

dataCount

protected AtomicLong dataCount

cmdPostProcessor

protected CommandPostprocessor cmdPostProcessor

housekeepingInterval

protected long housekeepingInterval

Constructor Details

AbstractTcDataLink

public AbstractTcDataLink()

Method Details

init

public void init(String yamcsInstance,
 String linkName,
 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 AbstractLink

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

Throws:

ConfigurationException

getCurrentTime

protected long getCurrentTime()

Overrides:

getCurrentTime in class AbstractLink

initPostprocessor

protected void initPostprocessor(String instance,
 YConfiguration config)

setCommandHistoryPublisher

public void setCommandHistoryPublisher(CommandHistoryPublisher commandHistoryListener)

Specified by:

setCommandHistoryPublisher in interface TcDataLink

postprocess

protected byte[] postprocess(PreparedCommand pc)

Postprocesses the command, unless postprocessing is disabled.

Returns:

potentially modified binary, or null to indicate that the command should not be handled further.

getDataInCount

public long getDataInCount()

Specified by:

getDataInCount in interface Link

getDataOutCount

public long getDataOutCount()

Specified by:

getDataOutCount in interface Link

resetCounters

public void resetCounters()

Specified by:

resetCounters in interface Link

getParent

public AggregatedDataLink getParent()

Description copied from interface: Link

If this link is a sublink of an aggregated link, get the parent link.

Specified by:

getParent in interface Link

setParent

public void setParent(AggregatedDataLink parent)

Description copied from interface: Link

Set the parent link if this is a sublink of an aggregated link.

Specified by:

setParent in interface Link

failedCommand

protected void failedCommand(org.yamcs.protobuf.Commanding.CommandId commandId,
 String reason)

Send to command history the failed command

ackCommand

protected void ackCommand(org.yamcs.protobuf.Commanding.CommandId commandId)

send an ack in the command history that the command has been sent out of the link

Parameters:

commandId -

getYamcsInstance

public String getYamcsInstance()