Package org.yamcs.http.websocket

Class ParameterResource

java.lang.Object

org.yamcs.http.websocket.ParameterResource

All Implemented Interfaces:

WebSocketResource, ParameterWithIdConsumer

public class ParameterResource
extends Object
implements WebSocketResource, ParameterWithIdConsumer

Provides realtime parameter subscription via web.

Constructor Summary

Constructors

Constructor	Description
ParameterResource(ConnectedWebSocketClient client)

Method Summary

Modifier and Type	Method	Description
String	getName()
void	selectProcessor(Processor processor)
void	socketClosed()	Called when the web socket is closed
WebSocketReply	subscribe(WebSocketDecodeContext ctx, WebSocketDecoder decoder)
WebSocketReply	subscribeAll(WebSocketDecodeContext ctx, WebSocketDecoder decoder)
void	unselectProcessor()
WebSocketReply	unsubscribe(WebSocketDecodeContext ctx, WebSocketDecoder decoder)
WebSocketReply	unsubscribeAll(WebSocketDecodeContext ctx, WebSocketDecoder decoder)
void	update(int subscriptionId, List<ParameterValueWithId> paramList)

Methods inherited from class java.lang.Object

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

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

processRequest, subscribe

Constructor Detail

ParameterResource

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

subscribeAll

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

Specified by:

subscribeAll in interface WebSocketResource

Throws:

WebSocketException

unsubscribeAll

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

Specified by:

unsubscribeAll in interface WebSocketResource

Throws:

WebSocketException

update

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

Specified by:

update in interface ParameterWithIdConsumer

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

socketClosed

public void socketClosed()

Description copied from interface: WebSocketResource

Called when the web socket is closed

Specified by:

socketClosed in interface WebSocketResource