org.yamcs.tctm

Class UdpTmDataLink

java.lang.Object

com.google.common.util.concurrent.AbstractExecutionThreadService

org.yamcs.tctm.UdpTmDataLink

All Implemented Interfaces:

com.google.common.util.concurrent.Service, Link, TmPacketDataLink

public class UdpTmDataLink
extends com.google.common.util.concurrent.AbstractExecutionThreadService
implements TmPacketDataLink

Receives telemetry packets via UDP. One UDP datagram = one TM packet. Keeps simple statistics about the number of datagram received and the number of too short datagrams

Author:

nm

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

Constructor Summary

Constructors

Constructor and Description
UdpTmDataLink(String instance, String name, Map<String,Object> config) Creates a new UDP TM Data Link

Method Summary

Modifier and Type	Method and Description
void	disable() Sets the disabled to true such that getNextPacket ignores the received datagrams
void	enable() Sets the disabled to false such that getNextPacket does not ignore the received datagrams
long	getDataCount()
String	getDetailedStatus() returns statistics with the number of datagram received and the number of invalid datagrams
Link.Status	getLinkStatus() Returns the current link status.
PacketWithTime	getNextPacket() Called to retrieve the next packet.
boolean	isDisabled()
void	run()
void	setTmSink(TmSink tmSink) sets the tm processor that should get all the tm packets
void	startUp()

Methods inherited from class com.google.common.util.concurrent.AbstractExecutionThreadService

addListener, awaitRunning, awaitRunning, awaitTerminated, awaitTerminated, executor, failureCause, isRunning, serviceName, shutDown, startAsync, state, stopAsync, toString, triggerShutdown

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.common.util.concurrent.Service

addListener, awaitRunning, awaitRunning, awaitTerminated, awaitTerminated, failureCause, isRunning, startAsync, state, stopAsync

Constructor Detail

UdpTmDataLink

public UdpTmDataLink(String instance,
                     String name,
                     Map<String,Object> config)
              throws ConfigurationException

Creates a new UDP TM Data Link

Throws:

ConfigurationException - if port is not defined in the configuration

Method Detail

startUp

public void startUp()
             throws IOException

Overrides:

startUp in class com.google.common.util.concurrent.AbstractExecutionThreadService

Throws:

IOException

setTmSink

public void setTmSink(TmSink tmSink)

Description copied from interface: TmPacketDataLink

sets the tm processor that should get all the tm packets

Specified by:

setTmSink in interface TmPacketDataLink

run

public void run()

Specified by:

run in class com.google.common.util.concurrent.AbstractExecutionThreadService

getNextPacket

public PacketWithTime getNextPacket()

Called to retrieve the next packet. It blocks in readining on the multicast socket

Returns:

anything that looks as a valid packet, just the size is taken into account to decide if it's valid or not

getLinkStatus

public Link.Status getLinkStatus()

Description copied from interface: Link

Returns the current link status.

Specified by:

getLinkStatus in interface Link

getDetailedStatus

public String getDetailedStatus()

returns statistics with the number of datagram received and the number of invalid datagrams

Specified by:

getDetailedStatus in interface Link

Returns:

more detailed status information

disable

public void disable()

Sets the disabled to true such that getNextPacket ignores the received datagrams

Specified by:

disable in interface Link

enable

public void enable()

Sets the disabled to false such that getNextPacket does not ignore the received datagrams

Specified by:

enable in interface Link

isDisabled

public boolean isDisabled()

Specified by:

isDisabled in interface Link

getDataCount

public long getDataCount()

Specified by:

getDataCount in interface Link