org.yamcs.web.websocket

Class CommandHistoryResource

java.lang.Object

org.yamcs.web.websocket.AbstractWebSocketResource

org.yamcs.web.websocket.CommandHistoryResource

All Implemented Interfaces:

CommandHistoryConsumer

public class CommandHistoryResource
extends AbstractWebSocketResource
implements CommandHistoryConsumer

Provides realtime command history 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
CommandHistoryResource(WebSocketProcessorClient client)

Method Summary

Modifier and Type	Method and Description
void	addedCommand(PreparedCommand pc) Called when a new command matching the filters has been added to the history
Web.WebSocketServerMessage.WebSocketReplyData	processRequest(WebSocketDecodeContext ctx, WebSocketDecoder decoder) Process a request and return a reply.
void	quit() called when the socket is closed
void	switchProcessor(Processor oldProcessor, Processor newProcessor)
void	updatedCommand(Commanding.CommandId cmdId, long changeDate, String key, Value value) Called when the history of a command matching the filters has been updated

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

getChannel, 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

CommandHistoryResource

public CommandHistoryResource(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()

called when the socket is closed

Specified by:

quit in class AbstractWebSocketResource

switchProcessor

public void switchProcessor(Processor oldProcessor,
                            Processor newProcessor)
                     throws ProcessorException

Overrides:

switchProcessor in class AbstractWebSocketResource

Throws:

ProcessorException

addedCommand

public void addedCommand(PreparedCommand pc)

Description copied from interface: CommandHistoryConsumer

Called when a new command matching the filters has been added to the history

Specified by:

addedCommand in interface CommandHistoryConsumer

updatedCommand

public void updatedCommand(Commanding.CommandId cmdId,
                           long changeDate,
                           String key,
                           Value value)

Description copied from interface: CommandHistoryConsumer

Called when the history of a command matching the filters has been updated

Specified by:

updatedCommand in interface CommandHistoryConsumer