org.yamcs.api

Class ProcessorControlClient

java.lang.Object

org.yamcs.api.ProcessorControlClient

All Implemented Interfaces:

EventListener, ConnectionListener, WebSocketClientCallback, WebSocketResponseHandler

public class ProcessorControlClient
extends Object
implements ConnectionListener, WebSocketClientCallback, WebSocketResponseHandler

controls processors in yamcs server via websocket

Author:

nm

Constructor Summary

Constructors

Constructor and Description
ProcessorControlClient(YamcsConnector yconnector)

Method Summary

Modifier and Type	Method and Description
void	connected(String url) Called after a successful connection to the yamcs server has been established.
void	connecting(String url) Called right before the initial connection to yamcs is being made.
void	connectionFailed(String url, YamcsException exception) Called when the initial connection to the yamcs server has failed, e.g.
CompletableFuture<Void>	connectToProcessor(String instance, String processorName, int[] clients)
CompletableFuture<byte[]>	createProcessor(String instance, String name, String type, Yamcs.ReplayRequest spec, boolean persistent, int[] clients)
void	destroyProcessor(String name)
void	disconnected() Called when the connection to the yamcs server is closed.
void	log(String message) Used to log messages.
void	onException(Web.WebSocketServerMessage.WebSocketExceptionData e) Called when there was an error executing a request
void	onMessage(Web.WebSocketServerMessage.WebSocketSubscriptionData data)
void	pauseArchiveReplay(String instance, String name)
void	receiveInitialConfig()
void	resumeArchiveReplay(String instance, String name)
void	seekArchiveReplay(String instance, String name, long newPosition)
void	setProcessorListener(ProcessorListener yamcsMonitor)

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

connected, connecting, connectionFailed

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

onCompletion

Constructor Detail

ProcessorControlClient

public ProcessorControlClient(YamcsConnector yconnector)

Method Detail

setProcessorListener

public void setProcessorListener(ProcessorListener yamcsMonitor)

destroyProcessor

public void destroyProcessor(String name)
                      throws YamcsApiException

Throws:

YamcsApiException

createProcessor

public CompletableFuture<byte[]> createProcessor(String instance,
                                                 String name,
                                                 String type,
                                                 Yamcs.ReplayRequest spec,
                                                 boolean persistent,
                                                 int[] clients)
                                          throws YamcsException,
                                                 YamcsApiException

Throws:

YamcsException

YamcsApiException

connectToProcessor

public CompletableFuture<Void> connectToProcessor(String instance,
                                                  String processorName,
                                                  int[] clients)
                                           throws YamcsException,
                                                  YamcsApiException

Throws:

YamcsException

YamcsApiException

pauseArchiveReplay

public void pauseArchiveReplay(String instance,
                               String name)
                        throws YamcsException,
                               YamcsApiException

Throws:

YamcsException

YamcsApiException

resumeArchiveReplay

public void resumeArchiveReplay(String instance,
                                String name)
                         throws YamcsApiException,
                                YamcsException

Throws:

YamcsApiException

YamcsException

seekArchiveReplay

public void seekArchiveReplay(String instance,
                              String name,
                              long newPosition)
                       throws YamcsApiException,
                              YamcsException

Throws:

YamcsApiException

YamcsException

connecting

public void connecting(String url)

Description copied from interface: ConnectionListener

Called right before the initial connection to yamcs is being made.

Specified by:

connecting in interface ConnectionListener

Parameters:

url - the url of the yamcs server

receiveInitialConfig

public void receiveInitialConfig()

connected

public void connected(String url)

Description copied from interface: ConnectionListener

Called after a successful connection to the yamcs server has been established.

Note: when using a re-connecting YamcsConnector, this method is also called after a successful re-connection attempt.

Specified by:

connected in interface ConnectionListener

Parameters:

url - the url of the yamcs server

onMessage

public void onMessage(Web.WebSocketServerMessage.WebSocketSubscriptionData data)

Specified by:

onMessage in interface WebSocketClientCallback

connectionFailed

public void connectionFailed(String url,
                             YamcsException exception)

Description copied from interface: ConnectionListener

Called when the initial connection to the yamcs server has failed, e.g. the maximum number of retry attempts has exceeded.

Specified by:

connectionFailed in interface ConnectionListener

Parameters:

url - the url of the yamcs server

exception - Optional cause of the connection failure, may be null.

disconnected

public void disconnected()

Description copied from interface: ConnectionListener

Called when the connection to the yamcs server is closed.

Specified by:

disconnected in interface ConnectionListener

Specified by:

disconnected in interface WebSocketClientCallback

log

public void log(String message)

Description copied from interface: ConnectionListener

Used to log messages.

Specified by:

log in interface ConnectionListener

Parameters:

message - the messages to be logged

onException

public void onException(Web.WebSocketServerMessage.WebSocketExceptionData e)

Description copied from interface: WebSocketResponseHandler

Called when there was an error executing a request

Specified by:

onException in interface WebSocketResponseHandler