org.yamcs.api

Class YamcsConnector

java.lang.Object

org.yamcs.api.YamcsConnector

All Implemented Interfaces:

WebSocketClientCallback

public class YamcsConnector
extends Object
implements WebSocketClientCallback

This is like a WebsocketClient but performs reconnection and implements some callbacks to announce the state. to be used by all the gui data receivers (event viewer, archive browser, etc)

Author:

nm

Field Summary

Fields

Modifier and Type	Field and Description
protected YamcsConnectionProperties	connectionParams
protected RestClient	restClient
protected WebSocketClient	wsClient

Constructor Summary

Constructors

Constructor and Description
YamcsConnector(boolean retry, String aplicationName)
YamcsConnector(String aplicationName)

Method Summary

Modifier and Type	Method and Description
void	addConnectionListener(ConnectionListener connectionListener)
Future<YamcsConnectionProperties>	connect(YamcsConnectionProperties cp)
void	connected() When the connection was successfully established
void	disconnect()
void	disconnected() When a previously successful connection was disconnected
YamcsConnectionProperties	getConnectionParams()
ExecutorService	getExecutor()
RestClient	getRestClient()
String	getUrl()
WebSocketClient	getWebSocketClient()
List<String>	getYamcsInstances()
boolean	isConnected()
boolean	isConnecting()
void	onMessage(Web.WebSocketServerMessage.WebSocketSubscriptionData data)
CompletableFuture<Web.WebSocketServerMessage.WebSocketReplyData>	performSubscription(WebSocketRequest wsr, WebSocketClientCallback client)
void	performSubscription(WebSocketRequest wsr, WebSocketClientCallback client, WebSocketResponseHandler wsrh) Sends the subscription via websocket and register the client to the subscriber lists Note that currently Yamcs does not send back the original requestId with the subscription data so it's not possible to send to clients only the data they subscribed to.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.yamcs.api.ws.WebSocketClientCallback

connecting, connectionFailed

Field Detail

wsClient

protected WebSocketClient wsClient

restClient

protected RestClient restClient

connectionParams

protected YamcsConnectionProperties connectionParams

Constructor Detail

YamcsConnector

public YamcsConnector(String aplicationName)

Parameters:

aplicationName - - application name that is passed on via web socket (as UserAgent) to be displayed in the YamcsMonitor

YamcsConnector

public YamcsConnector(boolean retry,
                      String aplicationName)

Method Detail

addConnectionListener

public void addConnectionListener(ConnectionListener connectionListener)

getYamcsInstances

public List<String> getYamcsInstances()

connect

public Future<YamcsConnectionProperties> connect(YamcsConnectionProperties cp)

disconnected

public void disconnected()

Description copied from interface: WebSocketClientCallback

When a previously successful connection was disconnected

Specified by:

disconnected in interface WebSocketClientCallback

disconnect

public void disconnect()

getUrl

public String getUrl()

isConnected

public boolean isConnected()

isConnecting

public boolean isConnecting()

getConnectionParams

public YamcsConnectionProperties getConnectionParams()

getExecutor

public ExecutorService getExecutor()

onMessage

public void onMessage(Web.WebSocketServerMessage.WebSocketSubscriptionData data)

Specified by:

onMessage in interface WebSocketClientCallback

connected

public void connected()

Description copied from interface: WebSocketClientCallback

When the connection was successfully established

Specified by:

connected in interface WebSocketClientCallback

getWebSocketClient

public WebSocketClient getWebSocketClient()

getRestClient

public RestClient getRestClient()

performSubscription

public void performSubscription(WebSocketRequest wsr,
                                WebSocketClientCallback client,
                                WebSocketResponseHandler wsrh)

Sends the subscription via websocket and register the client to the subscriber lists Note that currently Yamcs does not send back the original requestId with the subscription data so it's not possible to send to clients only the data they subscribed to. So the clients have to sort out the data they need and drop the data they don't need.

Parameters:

wsr -

client -

wsrh - - any error related to the request will be sent here

performSubscription

public CompletableFuture<Web.WebSocketServerMessage.WebSocketReplyData> performSubscription(WebSocketRequest wsr,
                                                                                            WebSocketClientCallback client)