Module org.yamcs.core

Package org.yamcs.tctm.ccsds

Class UdpTcFrameLink

java.lang.Object

com.google.common.util.concurrent.AbstractService

org.yamcs.tctm.AbstractLink

org.yamcs.tctm.ccsds.AbstractTcFrameLink

org.yamcs.tctm.ccsds.UdpTcFrameLink

All Implemented Interfaces:

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

public class UdpTcFrameLink
extends AbstractTcFrameLink
implements Runnable

Sends TC as TC frames (CCSDS 232.0-B-3) or TC frames embedded in CLTU (CCSDS 231.0-B-3).

This class implements rate limiting. args:

• frameMaxRate: maximum number of command frames to send per second.

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 inherited from class org.yamcs.tctm.ccsds.AbstractTcFrameLink

cltuGenerator, commandHistoryPublisher, frameCount, multiplexer

Fields inherited from class org.yamcs.tctm.AbstractLink

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

Constructor Summary

Constructors

Constructor	Description
UdpTcFrameLink()

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	doDisable()
protected void	doEnable()
protected void	doStart()
protected void	doStop()
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.
void	run()

Methods inherited from class org.yamcs.tctm.ccsds.AbstractTcFrameLink

ackBypassFrame, encodeCltu, failBypassFrame, getDefaultSpec, getSubLinks, sendCommand, setCommandHistoryPublisher

Methods inherited from class org.yamcs.tctm.AbstractLink

addAction, collectSystemParameters, dataIn, dataOut, disable, enable, getAction, getActions, getConfig, getCurrentTime, getDataInCount, 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, getDataInCount, 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

Constructor Details

UdpTcFrameLink

public UdpTcFrameLink()

Method Details

getSpec

public Spec getSpec()

Description copied from interface: Link

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

Specified by:

getSpec in interface Link

Returns:

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

init

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

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 AbstractTcFrameLink

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

run

public void run()

Specified by:

run in interface Runnable

doDisable

protected void doDisable()
                  throws Exception

Overrides:

doDisable in class AbstractLink

Throws:

Exception

doEnable

protected void doEnable()
                 throws Exception

Overrides:

doEnable in class AbstractLink

Throws:

Exception

doStart

protected void doStart()

Specified by:

doStart in class com.google.common.util.concurrent.AbstractService

doStop

protected void doStop()

Specified by:

doStop in class com.google.common.util.concurrent.AbstractService

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

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