Package org.yamcs.http.websocket

Class CommandHistoryResource

java.lang.Object

org.yamcs.http.websocket.CommandHistoryResource

All Implemented Interfaces:

CommandHistoryConsumer, WebSocketResource

public class CommandHistoryResource
extends Object
implements WebSocketResource, CommandHistoryConsumer

Provides realtime command history subscription via web.

Constructor Summary

Constructors

Constructor	Description
CommandHistoryResource(ConnectedWebSocketClient client)

Method Summary

Modifier and Type	Method	Description
void	addedCommand(PreparedCommand pc)	Called when a new command matching the filters has been added to the history
String	getName()
void	selectProcessor(Processor processor)
void	socketClosed()	Called when the web socket is closed
WebSocketReply	subscribe(WebSocketDecodeContext ctx, WebSocketDecoder decoder)
void	unselectProcessor()
WebSocketReply	unsubscribe(WebSocketDecodeContext ctx, WebSocketDecoder decoder)
void	updatedCommand(org.yamcs.protobuf.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 java.lang.Object

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

Methods inherited from interface org.yamcs.cmdhistory.CommandHistoryConsumer

updatedCommand

Methods inherited from interface org.yamcs.http.websocket.WebSocketResource

processRequest, subscribe, subscribeAll, unsubscribeAll

Constructor Detail

CommandHistoryResource

public CommandHistoryResource(ConnectedWebSocketClient client)

Method Detail

getName

public String getName()

Specified by:

getName in interface WebSocketResource

subscribe

public WebSocketReply subscribe(WebSocketDecodeContext ctx,
                                WebSocketDecoder decoder)
                         throws WebSocketException

Specified by:

subscribe in interface WebSocketResource

Throws:

WebSocketException

unsubscribe

public WebSocketReply unsubscribe(WebSocketDecodeContext ctx,
                                  WebSocketDecoder decoder)
                           throws WebSocketException

Specified by:

unsubscribe in interface WebSocketResource

Throws:

WebSocketException

unselectProcessor

public void unselectProcessor()

Specified by:

unselectProcessor in interface WebSocketResource

selectProcessor

public void selectProcessor(Processor processor)
                     throws ProcessorException

Specified by:

selectProcessor in interface WebSocketResource

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(org.yamcs.protobuf.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

socketClosed

public void socketClosed()

Description copied from interface: WebSocketResource

Called when the web socket is closed

Specified by:

socketClosed in interface WebSocketResource