org.yamcs.api.ws

Class WebSocketRequest

java.lang.Object

org.yamcs.api.ws.WebSocketRequest

public class WebSocketRequest
extends Object

Tags anything to be sent upstream on an established websocket. Can be extended do add additional structured data.

Constructor Summary

Constructors

Constructor and Description
WebSocketRequest(String resource, String operation)
WebSocketRequest(String resource, String operation, com.google.protobuf.Message requestData)

Method Summary

Modifier and Type	Method and Description
String	getOperation()
com.google.protobuf.Message	getRequestData()
String	getResource()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

WebSocketRequest

public WebSocketRequest(String resource,
                        String operation)

WebSocketRequest

public WebSocketRequest(String resource,
                        String operation,
                        com.google.protobuf.Message requestData)

Method Detail

getResource

public String getResource()

Returns:

the type of the resource.

getOperation

public String getOperation()

Returns:

the operation on the resource

getRequestData

public com.google.protobuf.Message getRequestData()

Returns:

the proto message that dictates how the request data (if any) will be serialized

toString

public String toString()

Overrides:

toString in class Object