Module org.yamcs.core

Package org.yamcs.tctm

Interface TmPacketDataLink

All Superinterfaces:

Link

All Known Implementing Classes:

AbstractTcTmParamLink, AbstractTmDataLink, FilePollingTmDataLink, TcpTcTmDataLink, TcpTmDataLink, UdpTcTmDataLink, UdpTmDataLink, VcTmPacketHandler, YamcsTmArchiveLink, YamcsTmLink

public interface TmPacketDataLink
extends Link

Interface for components reading packets from external parties.

The tm link should push TmPacket objects to the passed TmSink. The TmSink is implemented usually by the LinkManager; it takes care of putting these packets on the configured stream.

Nested Class Summary

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

Link.Status

Method Summary

Modifier and Type	Method	Description
default String	getTmStreamName()	Added in Yamcs 5.11.12 to allow a link to specify a tm stream it wants to push data to.
default boolean	isTmPacketDataLinkImplemented()	This method has been introduced to allow classes that implement multiple links (e.g.
void	setTmSink(TmSink tmSink)	sets the tm sink that should get all the tm packets

Methods inherited from interface org.yamcs.tctm.Link

disable, enable, getConfig, getDataInCount, getDataOutCount, getDefaultSpec, getDetailedStatus, getExtraInfo, getLinkStatus, getName, getParent, getSpec, init, isDisabled, isEffectivelyDisabled, resetCounters, setParent, setupSystemParameters

Method Details

setTmSink

void setTmSink(TmSink tmSink)

sets the tm sink that should get all the tm packets

isTmPacketDataLinkImplemented

default boolean isTmPacketDataLinkImplemented()

This method has been introduced to allow classes that implement multiple links (e.g. TM and TC) to not effectively support one ore more of them (depending on configuration)

If this method returns false, the LinkManager skips the link configuration for TM purposes

getTmStreamName

default String getTmStreamName()

Added in Yamcs 5.11.12 to allow a link to specify a tm stream it wants to push data to.

It is used by the LinkManager.configureDataLink(Link, org.yamcs.YConfiguration).

If the method returns null, the link manager will use the value of the configuration "tmStream"