Module org.yamcs.sle

Package org.yamcs.sle

Class TmSleLink

java.lang.Object

com.google.common.util.concurrent.AbstractService

org.yamcs.tctm.AbstractLink

org.yamcs.tctm.ccsds.AbstractTmFrameLink

org.yamcs.sle.AbstractTmSleLink

org.yamcs.sle.TmSleLink

All Implemented Interfaces:

com.google.common.util.concurrent.Service, org.yamcs.jsle.user.FrameConsumer, SystemParametersProducer, SleLink, AggregatedDataLink, Link, LinkActionProvider, ParameterDataLink

public class TmSleLink
extends AbstractTmSleLink

Receives TM frames via SLE. The Virtual Channel configuration is identical with the configuration of UdpTmFrameLink.

The SLE specific settings are loaded from sle.yaml based on the sleProvider key specified in the link configuration. The description of the sle.yaml configuration parameters are as follows:

Configuration Parameters

initiatorId	identifier of the local application
responderPortId	Responder Port Identifier
versionNumber	the version number is sent in the bind invocation. We only support the version of the SLE valid in April-2019; however this field is not checked.
myUsername	username that is passed in outgoing SLE messages. A corresponding password has to be specified (in hexadecimal) in the security.yaml file.
peerUsername	username that is used to verify the incoming SLE messages. A corresponding password has to be specified (in hexadecimal) in the security.yaml file.
authLevel	one of NONE, BIND or ALL - it configures which incoming and outgoing PDUs contain authentication information.
service	One of RAF (return all frames) or RCF (return channel frames).
rcfTfVersion	Specifies the requested frame version number (0=TM, 1=AOS, 12=USLP). If this option is not used, the frame version number will be derived from the frameType. If specfied, no validation is performed but sent as configured to the SLE provider.
rcfSpacecraftId	Specifies the number sent as part of the RCF request to the SLE provider. If not specified the spacecraftId will be used.
rcfVcId	Specifies the virtual channel sent as part of the RCF request. If not specified, or if negative, the request will be sent for all VCs
deliveryMode	one of timely, or complete

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.sle.AbstractTmSleLink

parameterSink

Fields inherited from class org.yamcs.tctm.ccsds.AbstractTmFrameLink

errFrameCount, frameHandler, invalidFrameCount, rawFrameDecoder, subLinks, TM_FRAME_CONFIG_SECTION, validFrameCount

Fields inherited from class org.yamcs.tctm.AbstractLink

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

Constructor Summary

Constructors

Constructor	Description
TmSleLink()

Method Summary

Modifier and Type	Method	Description
protected void	doDisable()
protected void	doEnable()
protected void	doStart()
protected void	doStop()
Spec	getDefaultSpec()
void	init(String instance, String name, YConfiguration config)
void	onEndOfData()
protected void	sleStart()

Methods inherited from class org.yamcs.sle.AbstractTmSleLink

acceptFrame, collectSystemParameters, connectAndBind, connectionStatus, getDetailedStatus, getExtraInfo, getParameter, init, isParameterDataLinkImplemented, onExcessiveDataBacklog, onLossFrameSync, onProductionStatusChange, setParameterSink, setupSystemParameters

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

addDefaultOptions, getSubLinks, handleFrame, resetCounters

Methods inherited from class org.yamcs.tctm.AbstractLink

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

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, getLinkStatus, getName, getParent, getSpec, isDisabled, isEffectivelyDisabled, resetCounters, setParent

Methods inherited from interface org.yamcs.parameter.SystemParametersProducer

getFrequency

Constructor Details

TmSleLink

public TmSleLink()

Method Details

getDefaultSpec

public Spec getDefaultSpec()

Specified by:

getDefaultSpec in interface Link

Overrides:

getDefaultSpec in class AbstractTmSleLink

init

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

Specified by:

init in interface Link

Overrides:

init in class AbstractTmFrameLink

Throws:

ConfigurationException

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

sleStart

protected void sleStart()

doDisable

protected void doDisable()

Overrides:

doDisable in class AbstractLink

doEnable

protected void doEnable()
                 throws Exception

Overrides:

doEnable in class AbstractLink

Throws:

Exception

onEndOfData

public void onEndOfData()