org.yamcs.web.websocket

Class AbstractWebSocketResource

java.lang.Object

org.yamcs.web.websocket.AbstractWebSocketResource

Direct Known Subclasses:

AlarmResource, CommandHistoryResource, CommandQueueResource, EventResource, LinkResource, ManagementResource, PacketResource, ParameterResource, StreamResource, TimeResource

public abstract class AbstractWebSocketResource
extends Object

A resource bundles a set of logically related operations. Instances of this class are created for every client session separately.

Field Summary

Fields

Modifier and Type	Field and Description
protected WebSocketProcessorClient	client
protected Processor	processor
protected WebSocketFrameHandler	wsHandler

Constructor Summary

Constructors

Constructor and Description
AbstractWebSocketResource(WebSocketProcessorClient client)

Method Summary

Modifier and Type	Method and Description
abstract Web.WebSocketServerMessage.WebSocketReplyData	processRequest(WebSocketDecodeContext ctx, WebSocketDecoder decoder) Process a request and return a reply.
abstract void	quit() Called when the web socket is closed
void	switchProcessor(Processor oldProcessor, Processor newProcessor)
protected static Web.WebSocketServerMessage.WebSocketReplyData	toAckReply(int requestId)

Methods inherited from class java.lang.Object

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

Field Detail

processor

protected Processor processor

client

protected WebSocketProcessorClient client

wsHandler

protected WebSocketFrameHandler wsHandler

Constructor Detail

AbstractWebSocketResource

public AbstractWebSocketResource(WebSocketProcessorClient client)

Method Detail

processRequest

public abstract Web.WebSocketServerMessage.WebSocketReplyData processRequest(WebSocketDecodeContext ctx,
                                                                             WebSocketDecoder decoder)
                                                                      throws WebSocketException

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

Throws:

WebSocketException

quit

public abstract void quit()

Called when the web socket is closed

toAckReply

protected static Web.WebSocketServerMessage.WebSocketReplyData toAckReply(int requestId)

switchProcessor

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

Throws:

ProcessorException