org.yamcs.web.websocket

Class CommandQueueResource

java.lang.Object

org.yamcs.web.websocket.AbstractWebSocketResource

org.yamcs.web.websocket.CommandQueueResource

All Implemented Interfaces:

CommandQueueListener

public class CommandQueueResource
extends AbstractWebSocketResource
implements CommandQueueListener

Provides realtime command queue subscription via web.

Field Summary

Fields

Modifier and Type	Field and Description
static String	OP_subscribe
static String	OP_unsubscribe
static String	RESOURCE_NAME

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

client, processor, wsHandler

Constructor Summary

Constructors

Constructor and Description
CommandQueueResource(WebSocketProcessorClient client)

Method Summary

Modifier and Type	Method and Description
void	commandAdded(CommandQueue q, PreparedCommand pc)
void	commandRejected(CommandQueue q, PreparedCommand pc)
void	commandSent(CommandQueue q, PreparedCommand pc)
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	switchProcessor(Processor oldProcessor, Processor newProcessor)
void	updateQueue(CommandQueue q)

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

Methods inherited from interface org.yamcs.commanding.CommandQueueListener

commandQueueRegistered, commandQueueUnregistered

Field Detail

RESOURCE_NAME

public static final String RESOURCE_NAME

See Also:

Constant Field Values

OP_subscribe

public static final String OP_subscribe

See Also:

Constant Field Values

OP_unsubscribe

public static final String OP_unsubscribe

See Also:

Constant Field Values

Constructor Detail

CommandQueueResource

public CommandQueueResource(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

switchProcessor

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

Overrides:

switchProcessor in class AbstractWebSocketResource

Throws:

ProcessorException

updateQueue

public void updateQueue(CommandQueue q)

Specified by:

updateQueue in interface CommandQueueListener

commandAdded

public void commandAdded(CommandQueue q,
                         PreparedCommand pc)

Specified by:

commandAdded in interface CommandQueueListener

commandRejected

public void commandRejected(CommandQueue q,
                            PreparedCommand pc)

Specified by:

commandRejected in interface CommandQueueListener

commandSent

public void commandSent(CommandQueue q,
                        PreparedCommand pc)

Specified by:

commandSent in interface CommandQueueListener