org.yamcs.alarms

Class AlarmServer

java.lang.Object

com.google.common.util.concurrent.AbstractService

org.yamcs.alarms.AlarmServer

All Implemented Interfaces:

com.google.common.util.concurrent.Service

public class AlarmServer
extends com.google.common.util.concurrent.AbstractService

Maintains a list of active alarms.

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

Field Summary

Fields

Modifier and Type	Field and Description
static TupleDefinition	ALARM_TUPLE_DEFINITION

Constructor Summary

Constructors

Constructor and Description
AlarmServer(String yamcsInstance, String streamName) Creates an alarm server that pushes all alarms to a stream

Method Summary

Modifier and Type	Method and Description
ActiveAlarm	acknowledge(Parameter p, int id, String username, long ackTime, String message)
void	doStart()
void	doStop()
Map<Parameter,ActiveAlarm>	getActiveAlarms() Returns the current set of active alarms
protected static boolean	moreSevere(Pvalue.MonitoringResult mr1, Pvalue.MonitoringResult mr2)
Map<Parameter,ActiveAlarm>	subscribe(AlarmListener listener) Register for alarm notices
void	unsubscribe(AlarmListener listener)
void	update(ParameterValue pv, int minViolations)
void	update(ParameterValue pv, int minViolations, boolean autoAck)

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

addListener, awaitRunning, awaitRunning, awaitTerminated, awaitTerminated, failureCause, isRunning, notifyFailed, notifyStarted, notifyStopped, startAsync, state, stopAsync, toString

Methods inherited from class java.lang.Object

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

Field Detail

ALARM_TUPLE_DEFINITION

public static final TupleDefinition ALARM_TUPLE_DEFINITION

Constructor Detail

AlarmServer

public AlarmServer(String yamcsInstance,
                   String streamName)

Creates an alarm server that pushes all alarms to a stream

Parameters:

yamcsInstance -

streamName -

Method Detail

subscribe

public Map<Parameter,ActiveAlarm> subscribe(AlarmListener listener)

Register for alarm notices

Returns:

the current set of active alarms

unsubscribe

public void unsubscribe(AlarmListener listener)

getActiveAlarms

public Map<Parameter,ActiveAlarm> getActiveAlarms()

Returns the current set of active alarms

doStart

public void doStart()

Specified by:

doStart in class com.google.common.util.concurrent.AbstractService

doStop

public void doStop()

Specified by:

doStop in class com.google.common.util.concurrent.AbstractService

update

public void update(ParameterValue pv,
                   int minViolations)

update

public void update(ParameterValue pv,
                   int minViolations,
                   boolean autoAck)

acknowledge

public ActiveAlarm acknowledge(Parameter p,
                               int id,
                               String username,
                               long ackTime,
                               String message)
                        throws CouldNotAcknowledgeAlarmException

Throws:

CouldNotAcknowledgeAlarmException

moreSevere

protected static boolean moreSevere(Pvalue.MonitoringResult mr1,
                                    Pvalue.MonitoringResult mr2)