org.yamcs.web.websocket

Class ParameterResource

java.lang.Object

org.yamcs.web.websocket.AbstractWebSocketResource

org.yamcs.web.websocket.ParameterResource

All Implemented Interfaces:

ParameterWithIdConsumer

public class ParameterResource
extends AbstractWebSocketResource
implements ParameterWithIdConsumer

Provides realtime parameter subscription via web.

Author:

nm

Field Summary

Fields

Modifier and Type	Field and Description
static String	RESOURCE_NAME
static String	WSR_SUBSCRIBE
static String	WSR_SUBSCRIBE_ALL
static String	WSR_UNSUBSCRIBE
static String	WSR_UNSUBSCRIBE_ALL

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

client, processor, wsHandler

Constructor Summary

Constructors

Constructor and Description
ParameterResource(WebSocketProcessorClient client)

Method Summary

Modifier and Type	Method and Description
WebSocketReply	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	update(int subscrId, List<ParameterValueWithId> paramList)

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

getChannel

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

WSR_SUBSCRIBE

public static final String WSR_SUBSCRIBE

See Also:

Constant Field Values

WSR_UNSUBSCRIBE

public static final String WSR_UNSUBSCRIBE

See Also:

Constant Field Values

WSR_SUBSCRIBE_ALL

public static final String WSR_SUBSCRIBE_ALL

See Also:

Constant Field Values

WSR_UNSUBSCRIBE_ALL

public static final String WSR_UNSUBSCRIBE_ALL

See Also:

Constant Field Values

Constructor Detail

ParameterResource

public ParameterResource(WebSocketProcessorClient client)

Method Detail

processRequest

public WebSocketReply 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

update

public void update(int subscrId,
                   List<ParameterValueWithId> paramList)

Specified by:

update in interface ParameterWithIdConsumer

quit

public void quit()

called when the socket is closed. unsubscribe all parameters

Specified by:

quit in class AbstractWebSocketResource

switchProcessor

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

Overrides:

switchProcessor in class AbstractWebSocketResource

Throws:

ProcessorException