org.yamcs.web.websocket

Class StreamResource

java.lang.Object

org.yamcs.web.websocket.AbstractWebSocketResource

org.yamcs.web.websocket.StreamResource

public class StreamResource
extends AbstractWebSocketResource

Capable of producing and consuming yarch Stream data (Tuples) over web socket

Field Summary

Fields

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

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

client, processor, wsHandler

Constructor Summary

Constructors

Constructor and Description
StreamResource(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 web socket is closed

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

getChannel, switchProcessor

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

OP_subscribe

public static final String OP_subscribe

See Also:

Constant Field Values

OP_publish

public static final String OP_publish

See Also:

Constant Field Values

Constructor Detail

StreamResource

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

quit

public void quit()

Description copied from class: AbstractWebSocketResource

Called when the web socket is closed

Specified by:

quit in class AbstractWebSocketResource