org.yamcs.tctm

Class MulticastTmDataLink

java.lang.Object

com.google.common.util.concurrent.AbstractExecutionThreadService

org.yamcs.tctm.MulticastTmDataLink

All Implemented Interfaces:

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

Direct Known Subclasses:

MulticastTmProvider

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

Receives telemetry packets via multicast from TMR. The nice thing about multicast is that there is no connection required so the code can be fairly simple. 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 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
MulticastTmDataLink(String group, int port) Creates a simple multicast receiver listening to the given group and port
MulticastTmDataLink(String instance, String name, String spec) Creates a

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
String	getLinkStatus() Returns one of "OK" or "UNAVAIL".
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

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

addListener, awaitRunning, awaitRunning, awaitTerminated, awaitTerminated, executor, failureCause, isRunning, serviceName, shutDown, startAsync, startUp, 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

MulticastTmDataLink

public MulticastTmDataLink(String instance,
                           String name,
                           String spec)
                    throws ConfigurationException

Creates a

Parameters:

spec -

Throws:

ConfigurationException - if tmGroup or tmPort are not defined in the configuration files

MulticastTmDataLink

public MulticastTmDataLink(String group,
                           int port)
                    throws IOException

Creates a simple multicast receiver listening to the given group and port

Parameters:

group -

port -

Throws:

IOException - if there was an exception opening the port (happends when there is alredy another process bound to that port and the option REUSE_ADDR is not set on its socket)

Method Detail

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

Description copied from interface: Link

Returns one of "OK" or "UNAVAIL". It's sure what the difference between uplink status and forward link status is.

Specified by:

getLinkStatus in interface Link

Returns:

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