org.yamcs.web.websocket

Class AlarmResource

java.lang.Object

org.yamcs.web.websocket.AbstractWebSocketResource

org.yamcs.web.websocket.AlarmResource

All Implemented Interfaces:

AlarmListener

public class AlarmResource
extends AbstractWebSocketResource
implements AlarmListener

Provides realtime alarm subscription via web.

Field Summary

Fields

Modifier and Type	Field and Description
static String	RESOURCE_NAME

Fields inherited from class org.yamcs.web.websocket.AbstractWebSocketResource

client, processor, wsHandler

Constructor Summary

Constructors

Constructor and Description
AlarmResource(WebSocketProcessorClient client)

Method Summary

Modifier and Type	Method and Description
void	notifyAcknowledged(ActiveAlarm activeAlarm)
void	notifyCleared(ActiveAlarm activeAlarm)
void	notifyParameterValueUpdate(ActiveAlarm activeAlarm)
void	notifySeverityIncrease(ActiveAlarm activeAlarm)
void	notifyTriggered(ActiveAlarm activeAlarm)
Web.WebSocketServerMessage.WebSocketReplyData	processRequest(WebSocketDecodeContext ctx, WebSocketDecoder decoder) Process a request and return a reply.
void	quit() Called when the web socket is closed
void	switchYProcessor(YProcessor oldProcessor, YProcessor newProcessor)

Methods inherited from class org.yamcs.web.websocket.AbstractWebSocketResource

toAckReply

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE_NAME

public static final String RESOURCE_NAME

See Also:

Constant Field Values

Constructor Detail

AlarmResource

public AlarmResource(WebSocketProcessorClient client)

Method Detail

processRequest

public Web.WebSocketServerMessage.WebSocketReplyData processRequest(WebSocketDecodeContext ctx,
                                                                    WebSocketDecoder decoder)
                                                             throws WebSocketException

Description copied from class: AbstractWebSocketResource

Process a request and return a reply. The reply can be null if the implementor of the resource takes care itself of sending the reply - this has been added because the parameterClient wants to send some date data immediately after reply

Specified by:

processRequest in class AbstractWebSocketResource

Throws:

WebSocketException

quit

public void quit()

Description copied from class: AbstractWebSocketResource

Called when the web socket is closed

Specified by:

quit in class AbstractWebSocketResource

switchYProcessor

public void switchYProcessor(YProcessor oldProcessor,
                             YProcessor newProcessor)
                      throws ProcessorException

Overrides:

switchYProcessor in class AbstractWebSocketResource

Throws:

ProcessorException

notifyTriggered

public void notifyTriggered(ActiveAlarm activeAlarm)

Specified by:

notifyTriggered in interface AlarmListener

notifySeverityIncrease

public void notifySeverityIncrease(ActiveAlarm activeAlarm)

Specified by:

notifySeverityIncrease in interface AlarmListener

notifyParameterValueUpdate

public void notifyParameterValueUpdate(ActiveAlarm activeAlarm)

Specified by:

notifyParameterValueUpdate in interface AlarmListener

notifyAcknowledged

public void notifyAcknowledged(ActiveAlarm activeAlarm)

Specified by:

notifyAcknowledged in interface AlarmListener

notifyCleared

public void notifyCleared(ActiveAlarm activeAlarm)

Specified by:

notifyCleared in interface AlarmListener