Module org.yamcs.sle

Package org.yamcs.sle

Class OfflineTmSleLink

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.OfflineTmSleLink

All Implemented Interfaces:

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

public class OfflineTmSleLink
extends AbstractTmSleLink

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

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
serviceInstance	Used in the bind request to select the instance number of the remote service.This number together with the deliverymode specify the so called service name identifier (raf=onltX where X is the number)
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.

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
OfflineTmSleLink()

Method Summary

Modifier and Type	Method	Description
void	acceptFrame(org.yamcs.jsle.CcsdsTime ert, org.yamcs.jsle.AntennaId antennaId, int dataLinkContinuity, org.yamcs.jsle.Constants.FrameQuality frameQuality, byte[] privAnn, byte[] data)
void	addRequest(org.yamcs.jsle.CcsdsTime start, org.yamcs.jsle.CcsdsTime stop)
protected Link.Status	connectionStatus()	Verifies that the requested state is the same as the current state
protected void	doDisable()
protected void	doEnable()
protected void	doStart()
protected void	doStop()
long	getDataOutCount()
void	init(String instance, String name, YConfiguration config)
void	onEndOfData()

Methods inherited from class org.yamcs.sle.AbstractTmSleLink

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

Methods inherited from interface org.yamcs.parameter.SystemParametersProducer

getFrequency

Constructor Details

OfflineTmSleLink

public OfflineTmSleLink()

Method Details

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

acceptFrame

public void acceptFrame(org.yamcs.jsle.CcsdsTime ert,
 org.yamcs.jsle.AntennaId antennaId,
 int dataLinkContinuity,
 org.yamcs.jsle.Constants.FrameQuality frameQuality,
 byte[] privAnn,
 byte[] data)

Specified by:

acceptFrame in interface org.yamcs.jsle.user.FrameConsumer

Overrides:

acceptFrame in class AbstractTmSleLink

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()

addRequest

public void addRequest(org.yamcs.jsle.CcsdsTime start,
 org.yamcs.jsle.CcsdsTime stop)

connectionStatus

protected Link.Status connectionStatus()

Description copied from class: AbstractTmSleLink

Verifies that the requested state is the same as the current state

Overrides:

connectionStatus in class AbstractTmSleLink

Returns:

Status.OK or Status.UNAVAIL

getDataOutCount

public long getDataOutCount()

Specified by:

getDataOutCount in interface Link

Overrides:

getDataOutCount in class AbstractLink