Package org.yamcs.alarms

Class AlarmMirrorService

java.lang.Object

com.google.common.util.concurrent.AbstractService

org.yamcs.AbstractYamcsService

org.yamcs.alarms.AlarmMirrorService

All Implemented Interfaces:

com.google.common.util.concurrent.Service, YamcsService

public class AlarmMirrorService
extends AbstractYamcsService

This service is used in a replication setup to mirror the active alarms from a master instance. It works by monitoring the replicated alarms_realtime and event_alarms_realtime and maintaining a list of active alarms.

Only reading alarms is allowed (including websocket subscription), no editing (ack, clear, shelve, etc).

Both parameters and events are supported.

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 inherited from class org.yamcs.AbstractYamcsService

config, log, serviceName, yamcsInstance

Constructor Summary

Constructors

Constructor	Description
AlarmMirrorService()

Method Summary

Modifier and Type	Method	Description
protected void	doStart()
protected void	doStop()
AbstractAlarmServer<EventId,Db.Event>	getEventServer()
AbstractAlarmServer<Parameter,ParameterValue>	getParameterServer()
void	init(String yamcsInstance, String serviceName, YConfiguration config)	Initialize this service.

Methods inherited from class org.yamcs.AbstractYamcsService

findStream, getConfig, getYamcsInstance

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

addListener, awaitRunning, awaitRunning, awaitRunning, awaitTerminated, awaitTerminated, awaitTerminated, doCancelStart, 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

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

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

Methods inherited from interface org.yamcs.YamcsService

getSpec

Constructor Details

AlarmMirrorService

public AlarmMirrorService()

Method Details

init

public void init(String yamcsInstance,
 String serviceName,
 YConfiguration config)
          throws InitException

Description copied from interface: YamcsService

Initialize this service. This is called before the service is started. All operations should finish fast.

Specified by:

init in interface YamcsService

Overrides:

init in class AbstractYamcsService

Parameters:

yamcsInstance - The yamcs instance, or null if this is a global service.

serviceName - The service name.

config - The configured arguments for this service. If YamcsService.getSpec() is implemented then this contains the arguments after being validated (including any defaults).

Throws:

InitException - When something goes wrong during the execution of this method.

doStart

protected void doStart()

Specified by:

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

doStop

protected void doStop()

Specified by:

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

getParameterServer

public AbstractAlarmServer<Parameter,ParameterValue> getParameterServer()

getEventServer

public AbstractAlarmServer<EventId,Db.Event> getEventServer()