org.yamcs.tctm

Class UdpParameterDataLink

java.lang.Object

com.google.common.util.concurrent.AbstractExecutionThreadService

org.yamcs.tctm.UdpParameterDataLink

All Implemented Interfaces:

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

public class UdpParameterDataLink
extends com.google.common.util.concurrent.AbstractExecutionThreadService
implements ParameterDataLink

Receives PP data via UDP. The UDP packets are protobuf encoded ParameterData. We don't use any checksum, assume it's done by UDP.

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
UdpParameterDataLink(String instance, String name, Map<String,Object> config) Creates a new UDP 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
String	getLinkStatus() Returns one of "OK" or "UNAVAIL".
Pvalue.ParameterData	getNextData() Called to retrieve the next packet.
boolean	isDisabled()
void	run()
void	setParameterSink(ParameterSink ppListener)
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

UdpParameterDataLink

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

Creates a new UDP data link

Parameters:

instance -

name -

config -

Throws:

ConfigurationException - if port is not defined in the config

Method Detail

startUp

public void startUp()
             throws IOException

Overrides:

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

Throws:

IOException

run

public void run()

Specified by:

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

getNextData

public Pvalue.ParameterData getNextData()

Called to retrieve the next packet. It blocks in readinng on the UDP 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

setParameterSink

public void setParameterSink(ParameterSink ppListener)

Specified by:

setParameterSink in interface ParameterDataLink