Package org.yamcs.tctm
Interface Link
-
- All Known Subinterfaces:
AggregatedDataLink
,ParameterDataLink
,TcDataLink
,TmPacketDataLink
- All Known Implementing Classes:
AbstractLink
,AbstractTcDataLink
,AbstractTcFrameLink
,AbstractThreadedTcDataLink
,AbstractTmDataLink
,AbstractTmFrameLink
,Cop1TcPacketHandler
,FilePollingTmDataLink
,TcPacketHandler
,TcpTcDataLink
,TcpTmDataLink
,UdpParameterDataLink
,UdpTcDataLink
,UdpTcFrameLink
,UdpTmDataLink
,UdpTmFrameLink
,VcTmPacketHandler
public interface Link
A source of data into yamcs; Currently TM, TC and Parameter
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
Link.Status
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description void
disable()
Disable any data I/O through this link.void
enable()
Reenable the data transit if disabled by the disable() method.YConfiguration
getConfig()
long
getDataInCount()
long
getDataOutCount()
default String
getDetailedStatus()
Link.Status
getLinkStatus()
Returns the current link status.String
getName()
Return the name of the linkdefault AggregatedDataLink
getParent()
If this link is a sublink of an aggregated link, get the parent link.default Spec
getSpec()
Returns the valid configuration of the input args of this link.default void
init(String yamcsInstance, String linkName, YConfiguration config)
Called at startup to initialize the link.boolean
isDisabled()
void
resetCounters()
default void
setParent(AggregatedDataLink parent)
Set the parent link if this is a sublink of an aggregated link.default void
setupSystemParameters(SystemParametersCollector sysParamCollector)
Called by the LinkManager before startup if theSystemParametersCollector
service is enabled, to setup necessary things for later parameter collection.
-
-
-
Method Detail
-
getLinkStatus
Link.Status getLinkStatus()
Returns the current link status.
-
getDetailedStatus
default String getDetailedStatus()
- Returns:
- more detailed status information
-
enable
void enable()
Reenable the data transit if disabled by the disable() method.
-
disable
void disable()
Disable any data I/O through this link. Any connection to a server is closed. Can be reenabled using the enable method. Note that this method can be called before starting the service if it's configured as such in the configuration file
-
isDisabled
boolean isDisabled()
-
getDataInCount
long getDataInCount()
-
getDataOutCount
long getDataOutCount()
-
resetCounters
void resetCounters()
-
getName
String getName()
Return the name of the link
-
getConfig
YConfiguration getConfig()
- Returns:
- the config (args) used when creating the link
-
getParent
default AggregatedDataLink getParent()
If this link is a sublink of an aggregated link, get the parent link.
-
setParent
default void setParent(AggregatedDataLink parent)
Set the parent link if this is a sublink of an aggregated link.
-
setupSystemParameters
default void setupSystemParameters(SystemParametersCollector sysParamCollector)
Called by the LinkManager before startup if theSystemParametersCollector
service is enabled, to setup necessary things for later parameter collection.The method is called only on the links that implement the
SystemParametersProducer
interface; they are also registered with theSystemParametersCollector
to be called regularly after the start.
-
init
default void init(String yamcsInstance, String linkName, YConfiguration config)
Called at startup to initialize the link.The config corresponds to the map that is under the link definition in yamcs.instance.yaml.
- Parameters:
yamcsInstance
-linkName
-config
- - the configuration - cannot be null (but can be empty)
-
getSpec
default Spec getSpec()
Returns the valid configuration of the input args of this link.- Returns:
- the argument specification, or null if the args should not be validated.
-
-